summaryrefslogtreecommitdiff
path: root/plugins/docker-compose/README.md
blob: bbcff2e0c370a407cd7f83978bc3135042dd40ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Docker-compose

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:

```zsh
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                 |
| dcupb     | `docker-compose up --build`    | Same as `dcup`, but build images before starting containers                      |
| dcupd     | `docker-compose up -d`         | Same as `dcup`, but starts as daemon                                             |
| dcupdb    | `docker-compose up -d --build` | Same as `dcup`, but build images before starting containers and 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                                                                |
| dck       | `docker-compose kill`          | Kills containers                                                                 |