mirror of
https://github.com/docker/compose.git
synced 2025-05-09 09:00:11 +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>
55 lines
1.4 KiB
YAML
55 lines
1.4 KiB
YAML
command: docker compose ls
|
|
short: List running compose projects
|
|
long: List Compose projects running on platform.
|
|
usage: docker compose ls [OPTIONS]
|
|
pname: docker compose
|
|
plink: docker_compose.yaml
|
|
options:
|
|
- option: all
|
|
shorthand: a
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Show all stopped Compose projects
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: filter
|
|
value_type: filter
|
|
description: Filter output based on conditions provided.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: format
|
|
value_type: string
|
|
default_value: pretty
|
|
description: 'Format the output. Values: [pretty | json].'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: quiet
|
|
shorthand: q
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Only display IDs.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
deprecated: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|