diff options
| author | Luiz Guilherme Fonseca Rosa <luizguilhermefr@gmail.com> | 2018-10-08 10:20:10 -0300 | 
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-08 10:20:10 -0300 | 
| commit | ed401bc55af2e5b08d1ff903111a65838473ad9d (patch) | |
| tree | 621f7623dedf79dd9117a20e84c0997eac8217e3 /plugins/docker-compose | |
| parent | c2113d7cc67e2865a4692918198fba27e8360fe5 (diff) | |
| parent | 7b29684a3087c881f240ebb74bd387c69f0ffcc6 (diff) | |
| download | zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.gz zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.bz2 zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.zip | |
Merge branch 'master' into master
Diffstat (limited to 'plugins/docker-compose')
| -rw-r--r-- | plugins/docker-compose/README.md | 29 | 
1 files changed, 27 insertions, 2 deletions
| diff --git a/plugins/docker-compose/README.md b/plugins/docker-compose/README.md index d3fcb29fe..07a87bc81 100644 --- a/plugins/docker-compose/README.md +++ b/plugins/docker-compose/README.md @@ -1,4 +1,29 @@ -# Docker-compose plugin for oh my zsh +# Docker-compose -A copy of the completion script from the [docker-compose](https://github.com/docker/compose/blob/master/contrib/completion/zsh/_docker-compose) git repo. +This plugin provides completion for [docker-compose](https://docs.docker.com/compose/) as well as some +aliases for frequent docker-compose commands. +To use it, add docker-compose to the plugins array of your zshrc file: +``` +plugins=(... docker-compose) +``` + +## Aliases + +| Alias     | Command                  | Description                                                      | +|-----------|--------------------------|------------------------------------------------------------------| +| dco       | `docker-compose`         | Docker-compose main command                                      | +| dcb       | `docker-compose build`   | Build containers                                                 | +| dce       | `docker-compose exec`    | Execute command inside a container                               | +| dcps      | `docker-compose ps`      | List containers                                                  | +| dcrestart | `docker-compose restart` | Restart container                                                | +| dcrm      | `docker-compose rm`      | Remove container                                                 | +| dcr       | `docker-compose run`     | Run a command in container                                       | +| dcstop    | `docker-compose stop`    | Stop a container                                                 | +| dcup      | `docker-compose up`      | Build, (re)create, start, and attach to containers for a service | +| dcupd     | `docker-compose up -d`   | Same as `dcup`, but starts as daemon                             | +| dcdn      | `docker-compose down`    | Stop and remove containers                                       | +| dcl       | `docker-compose logs`    | Show logs of container                                           | +| dclf      | `docker-compose logs -f` | Show logs and follow output                                      | +| dcpull    | `docker-compose pull`    | Pull image of a service                                          | +| dcstart   | `docker-compose start`   | Start a container                                                | | 
