2019-10-19 15:28:43 +00:00
|
|
|
# Docker plugin
|
2013-08-07 15:59:53 +00:00
|
|
|
|
2019-10-19 15:28:43 +00:00
|
|
|
This plugin adds auto-completion for [docker](https://www.docker.com/).
|
2019-10-18 21:52:26 +00:00
|
|
|
|
|
|
|
|
To use it add `docker` to the plugins array in your zshrc file.
|
2020-03-11 18:57:46 +00:00
|
|
|
|
2019-10-18 21:52:26 +00:00
|
|
|
```zsh
|
|
|
|
|
plugins=(... docker)
|
|
|
|
|
```
|
|
|
|
|
|
2019-10-19 15:28:43 +00:00
|
|
|
A copy of the completion script from the docker/cli git repo:
|
|
|
|
|
https://github.com/docker/cli/blob/master/contrib/completion/zsh/_docker
|
2020-09-18 20:02:10 +00:00
|
|
|
|
|
|
|
|
## Settings
|
|
|
|
|
|
|
|
|
|
By default, the completion doesn't allow option-stacking, meaning if you try to
|
|
|
|
|
complete `docker run -it <TAB>` it won't work, because you're _stacking_ the
|
|
|
|
|
`-i` and `-t` options.
|
|
|
|
|
|
|
|
|
|
[You can enable it](https://github.com/docker/cli/commit/b10fb43048) by **adding
|
|
|
|
|
the lines below to your zshrc file**, but be aware of the side effects:
|
|
|
|
|
|
|
|
|
|
> This enables Zsh to understand commands like `docker run -it
|
|
|
|
|
> ubuntu`. However, by enabling this, this also makes Zsh complete
|
|
|
|
|
> `docker run -u<tab>` with `docker run -uapprox` which is not valid. The
|
|
|
|
|
> users have to put the space or the equal sign themselves before trying
|
|
|
|
|
> to complete.
|
|
|
|
|
>
|
|
|
|
|
> Therefore, this behavior is disabled by default. To enable it:
|
|
|
|
|
>
|
|
|
|
|
> ```
|
|
|
|
|
> zstyle ':completion:*:*:docker:*' option-stacking yes
|
|
|
|
|
> zstyle ':completion:*:*:docker-*:*' option-stacking yes
|
|
|
|
|
> ```
|
