Skip to content

Commit

Permalink
Improve Shell Completion documentation (#2366)
Browse files Browse the repository at this point in the history
  • Loading branch information
peterkraume committed Jul 8, 2020
1 parent 3814e4b commit b6ec8b2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/users/shell-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Shells like bash and zsh need help to do this though, they have to know what the

### tar Archive of Completion Scripts for Manual Deployment

Although most people will use techniques like homebrew for installation, a tar archive of the shell completion scripts is available in each release, called "ddev_shell_completion_scripts.<version>.tar.gz". If you need to manually install, you can download and untar the scripts, then copy them as needed to where they have to go. For example, `sudo cp ddev_bash_completion.sh /etc/bash_completion.d/ddev`.
Although most people will use techniques like homebrew for installation, a tar archive of the shell completion scripts is available in each release, called "ddev_shell_completion_scripts.\<version\>.tar.gz". If you need to manually install, you can download and untar the scripts, then copy them as needed to where they have to go. For example, `sudo cp ddev_bash_completion.sh /etc/bash_completion.d/ddev`.

Note that scripts for the fish shell and Windows Powershell are also provided, but no instructions are given here for deploying them.

Expand Down Expand Up @@ -53,7 +53,7 @@ So follow those instructions and your zsh should be set up.
If you installed zsh with homebrew, ddev's completions will be automatically installed when you `brew install ddev`.
Otherwise, Oh-My-Zsh may be set up very differently in different places, so as a power zsh user you'll need to put ddev_bash_completion.sh where it belongs. `echo $fpath` will show you the places that it's most likely to belong. An obvious choice is ~/.oh-my-zsh/completions if that exists, so you can `mkdir -p ~/.oh-my-zsh/completions && cp ddev_zsh_completions.sh ~/.oh-my-zsh/completions/_ddev` and then `autoload -Uz compinit && compinit`.
Otherwise, Oh-My-Zsh may be set up very differently in different places, so as a power zsh user you'll need to put ddev_bash_completion.sh (see tar archive download above) where it belongs. `echo $fpath` will show you the places that it's most likely to belong. An obvious choice is ~/.oh-my-zsh/completions if that exists, so you can `mkdir -p ~/.oh-my-zsh/completions && cp ddev_zsh_completion.sh ~/.oh-my-zsh/completions/_ddev` and then `autoload -Uz compinit && compinit`.
### Fish Completion
Expand Down

0 comments on commit b6ec8b2

Please sign in to comment.