From 0cd99a7435bd70f31fabf9785f4ed25781e41a75 Mon Sep 17 00:00:00 2001 From: Leszek Jasek <6629813+Alchemik@users.noreply.github.com> Date: Tue, 3 Sep 2024 01:42:56 +0200 Subject: [PATCH] Improve "Command-line Completion" section Replaced deprecated Spring CLI options with the current ones, improved section related to completion setup for zsh. See gh-42091 --- .../src/docs/asciidoc/getting-started/installing.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/installing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/installing.adoc index 4c5d3cac36e6..a489d5f5b8db 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/installing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/installing.adoc @@ -167,15 +167,15 @@ If you are on a Mac and use https://www.macports.org/[MacPorts], you can install [[getting-started.installing.cli.completion]] ==== Command-line Completion The Spring Boot CLI includes scripts that provide command completion for the https://en.wikipedia.org/wiki/Bash_%28Unix_shell%29[BASH] and https://en.wikipedia.org/wiki/Z_shell[zsh] shells. -You can `source` the script (also named `spring`) in any shell or put it in your personal or system-wide bash completion initialization. -On a Debian system, the system-wide scripts are in `/shell-completion/bash` and all scripts in that directory are executed when a new shell starts. +You can `source` the script named `spring` (`_spring` for zsh) or put it in your personal or system-wide bash completion initialization. +On a Debian system, the system-wide scripts are in `/shell-completion/` and all scripts in that directory are executed when a new shell starts. For example, to run the script manually if you have installed by using SDKMAN!, use the following commands: [source,shell,indent=0,subs="verbatim"] ---- $ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring $ spring - grab help jar run test version + encodepassword help init shell version ---- NOTE: If you install the Spring Boot CLI by using Homebrew or MacPorts, the command-line completion scripts are automatically registered with your shell.