mirror of
https://github.com/docker/compose.git
synced 2025-05-08 16:40:12 +02:00
9db79856be
This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
73 lines
1.9 KiB
YAML
73 lines
1.9 KiB
YAML
command: docker compose rm
|
|
short: Removes stopped service containers
|
|
long: |-
|
|
Removes stopped service containers.
|
|
|
|
By default, anonymous volumes attached to containers are not removed. You can override this with `-v`. To list all
|
|
volumes, use `docker volume ls`.
|
|
|
|
Any data which is not in a volume is lost.
|
|
|
|
Running the command with no options also removes one-off containers created by `docker compose run`:
|
|
|
|
```console
|
|
$ docker compose rm
|
|
Going to remove djangoquickstart_web_run_1
|
|
Are you sure? [yN] y
|
|
Removing djangoquickstart_web_run_1 ... done
|
|
```
|
|
usage: docker compose rm [OPTIONS] [SERVICE...]
|
|
pname: docker compose
|
|
plink: docker_compose.yaml
|
|
options:
|
|
- option: all
|
|
shorthand: a
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Deprecated - no effect
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: force
|
|
shorthand: f
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Don't ask to confirm removal
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: stop
|
|
shorthand: s
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Stop the containers, if required, before removing
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: volumes
|
|
shorthand: v
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Remove any anonymous volumes attached to containers
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
deprecated: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|