mirror of https://github.com/docker/docs.git
Update the usage of docker-compose cli commands
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
This commit is contained in:
parent
221d7a378f
commit
87dbb07f2c
|
@ -8,7 +8,7 @@ redirect_from:
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: config [options]
|
Usage: docker-compose config [options]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--resolve-image-digests Pin image tags to digests.
|
--resolve-image-digests Pin image tags to digests.
|
||||||
|
|
|
@ -10,7 +10,7 @@ instead.
|
||||||
{: .warning }
|
{: .warning }
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: create [options] [SERVICE...]
|
Usage: docker-compose create [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--force-recreate Recreate containers even if their configuration and
|
--force-recreate Recreate containers even if their configuration and
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: down [options]
|
Usage: docker-compose down [options]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--rmi type Remove images. Type must be one of:
|
--rmi type Remove images. Type must be one of:
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: events [options] [SERVICE...]
|
Usage: docker-compose events [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--json Output events as a stream of json objects
|
--json Output events as a stream of json objects
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: exec [options] [-e KEY=VAL...] SERVICE COMMAND [ARGS...]
|
Usage: docker-compose exec [options] [-e KEY=VAL...] SERVICE COMMAND [ARGS...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-d, --detach Detached mode: Run command in the background.
|
-d, --detach Detached mode: Run command in the background.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: help [COMMAND]
|
Usage: docker-compose help [COMMAND]
|
||||||
```
|
```
|
||||||
|
|
||||||
Displays help and usage instructions for a command.
|
Displays help and usage instructions for a command.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: images [options] [SERVICE...]
|
Usage: docker-compose images [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-q, --quiet Only display IDs
|
-q, --quiet Only display IDs
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: kill [options] [SERVICE...]
|
Usage: docker-compose kill [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-s SIGNAL SIGNAL to send to the container.
|
-s SIGNAL SIGNAL to send to the container.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: logs [options] [SERVICE...]
|
Usage: docker-compose logs [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--no-color Produce monochrome output.
|
--no-color Produce monochrome output.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: pause [SERVICE...]
|
Usage: docker-compose pause [SERVICE...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
|
Pauses running containers of a service. They can be unpaused with `docker-compose unpause`.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: port [options] SERVICE PRIVATE_PORT
|
Usage: docker-compose port [options] SERVICE PRIVATE_PORT
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--protocol=proto tcp or udp [default: tcp]
|
--protocol=proto tcp or udp [default: tcp]
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: ps [options] [SERVICE...]
|
Usage: docker-compose ps [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-q, --quiet Only display IDs
|
-q, --quiet Only display IDs
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: pull [options] [SERVICE...]
|
Usage: docker-compose pull [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--ignore-pull-failures Pull what it can and ignores images with pull failures.
|
--ignore-pull-failures Pull what it can and ignores images with pull failures.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: push [options] [SERVICE...]
|
Usage: docker-compose push [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--ignore-push-failures Push what it can and ignores images with push failures.
|
--ignore-push-failures Push what it can and ignores images with push failures.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: restart [options] [SERVICE...]
|
Usage: docker-compose restart [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
|
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: rm [options] [SERVICE...]
|
Usage: docker-compose rm [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-f, --force Don't ask to confirm removal
|
-f, --force Don't ask to confirm removal
|
||||||
|
|
|
@ -7,7 +7,7 @@ notoc: true
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage:
|
Usage:
|
||||||
run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l KEY=VALUE...]
|
docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l KEY=VALUE...]
|
||||||
SERVICE [COMMAND] [ARGS...]
|
SERVICE [COMMAND] [ARGS...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
|
@ -12,7 +12,7 @@ notoc: true
|
||||||
{: .warning }
|
{: .warning }
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: scale [options] [SERVICE=NUM...]
|
Usage: docker-compose scale [options] [SERVICE=NUM...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
|
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: start [SERVICE...]
|
Usage: docker-compose start [SERVICE...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Starts existing containers for a service.
|
Starts existing containers for a service.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: stop [options] [SERVICE...]
|
Usage: docker-compose stop [options] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
|
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: top [SERVICE...]
|
Usage: docker-compose top [SERVICE...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Displays the running processes.
|
Displays the running processes.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: unpause [SERVICE...]
|
Usage: docker-compose unpause [SERVICE...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Unpauses paused containers of a service.
|
Unpauses paused containers of a service.
|
||||||
|
|
|
@ -6,7 +6,7 @@ notoc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
```none
|
```none
|
||||||
Usage: up [options] [--scale SERVICE=NUM...] [SERVICE...]
|
Usage: docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-d, --detach Detached mode: Run containers in the background,
|
-d, --detach Detached mode: Run containers in the background,
|
||||||
|
|
Loading…
Reference in New Issue