docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8329 from docker/TheRijn-patch-1 

docker compose autocompletion content refresh
This commit is contained in:
Maria Bermudez 2019-02-20 09:55:30 -08:00 committed by GitHub
parent 115ededf56 51cac2184d
commit e0267b7de2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
compose/completion.md
View File

@ -13,19 +13,30 @@ for the bash and zsh shell.
Make sure bash completion is installed.
* On a current Linux OS (in a non-minimal installation), bash completion should be
#### Linux
1. On a current Linux OS (in a non-minimal installation), bash completion should be
available.
* On a Mac, install with `brew install bash-completion`.
Place the completion script in `/etc/bash_completion.d/`
(or `/usr/local/etc/bash_completion.d/` on a Mac):
2. Place the completion script in `/etc/bash_completion.d/`.
```shell
sudo curl -L https://raw.githubusercontent.com/docker/compose/{{site.compose_version}}/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose
```
On a Mac, add the following to your `~/.bash_profile`:
### Mac
##### Install via Homebrew
1. Install with `brew install bash-completion`.
2. After the installation, Brew displays the installation path. Make sure to place the completion script in the path.
For example, when running this command on Mac 10.13.2, place the completion script in `/usr/local/etc/bash_completion.d/`.
```shell
sudo curl -L https://raw.githubusercontent.com/docker/compose/{{site.compose_version}}/contrib/completion/bash/docker-compose -o /usr/local/etc/bash_completion.d/docker-compose
```
3. Add the following to your `~/.bash_profile`:
```shell
if [ -f $(brew --prefix)/etc/bash_completion ]; then
@ -33,13 +44,13 @@ if [ -f $(brew --prefix)/etc/bash_completion ]; then
fi
```
You can source your `~/.bash_profile` or launch a new terminal to utilize
4. You can source your `~/.bash_profile` or launch a new terminal to utilize
completion.
If you're using MacPorts instead of brew, use the following steps instead:
##### Install via MacPorts
Run `sudo port install bash-completion` to install bash completion.
Add the following lines to `~/.bash_profile`:
1. Run `sudo port install bash-completion` to install bash completion.
2. Add the following lines to `~/.bash_profile`:
```shell
if [ -f /opt/local/etc/profile.d/bash_completion.sh ]; then
@ -47,43 +58,44 @@ if [ -f /opt/local/etc/profile.d/bash_completion.sh ]; then
fi
```
You can source your `~/.bash_profile` or launch a new terminal to utilize
3. You can source your `~/.bash_profile` or launch a new terminal to utilize
completion.
### Zsh
#### With oh-my-zsh
Make sure you have [installed `oh-my-zsh`](https://ohmyz.sh/) on your computer.
Add `docker` to the plugins list in `~/.zshrc`:
#### With oh-my-zsh shell
Add `docker` and `docker-compose` to the plugins list in `~/.zshrc` to run autocompletion within the oh-my-zsh shell. In the following example, `...` represent other Zsh plugins you may have installed.
```shell
plugins=(
<existing-plugins> docker
plugins=(... docker docker-compose
)
```
#### Without oh-my-zsh
#### Without oh-my-zsh shell
Place the completion script in your `/path/to/zsh/completion` (typically `~/.zsh/completion/`):
1. Place the completion script in your `/path/to/zsh/completion` (typically `~/.zsh/completion/`):
```shell
$ mkdir -p ~/.zsh/completion
$ curl -L https://raw.githubusercontent.com/docker/compose/{{site.compose_version}}/contrib/completion/zsh/_docker-compose > ~/.zsh/completion/_docker-compose
```
Include the directory in your `$fpath` by adding in `~/.zshrc`:
2. Include the directory in your `$fpath` by adding in `~/.zshrc`:
```shell
fpath=(~/.zsh/completion $fpath)
```
Make sure `compinit` is loaded or do it by adding in `~/.zshrc`:
3. Make sure `compinit` is loaded or do it by adding in `~/.zshrc`:
```shell
autoload -Uz compinit && compinit -i
```
Then reload your shell:
4. Then reload your shell:
```shell
exec $SHELL -l