tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-07-22 21:24:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

update cli-doc-tool and update the doc with this new version

Browse Source 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
This commit is contained in:
Guillaume Lours 2022-07-26 14:58:08 +02:00
parent ce1829a46a
commit 0e6adb2884
No known key found for this signature in database
27 changed files with 1712 additions and 1711 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/compose_convert.md
View File

@ -5,7 +5,7 @@ Converts the compose file to platform's canonical format
### Aliases
`convert`, `config`
`docker compose convert`, `docker compose config`
### Options

122
docs/reference/docker_compose.yaml
View File

@ -105,59 +105,59 @@ usage: docker compose
pname: docker
plink: docker.yaml
cname:
- docker compose build
- docker compose convert
- docker compose cp
- docker compose create
- docker compose down
- docker compose events
- docker compose exec
- docker compose images
- docker compose kill
- docker compose logs
- docker compose ls
- docker compose pause
- docker compose port
- docker compose ps
- docker compose pull
- docker compose push
- docker compose restart
- docker compose rm
- docker compose run
- docker compose start
- docker compose stop
- docker compose top
- docker compose unpause
- docker compose up
- docker compose version
- docker compose build
- docker compose convert
- docker compose cp
- docker compose create
- docker compose down
- docker compose events
- docker compose exec
- docker compose images
- docker compose kill
- docker compose logs
- docker compose ls
- docker compose pause
- docker compose port
- docker compose ps
- docker compose pull
- docker compose push
- docker compose restart
- docker compose rm
- docker compose run
- docker compose start
- docker compose stop
- docker compose top
- docker compose unpause
- docker compose up
- docker compose version
clink:
- docker_compose_build.yaml
- docker_compose_convert.yaml
- docker_compose_cp.yaml
- docker_compose_create.yaml
- docker_compose_down.yaml
- docker_compose_events.yaml
- docker_compose_exec.yaml
- docker_compose_images.yaml
- docker_compose_kill.yaml
- docker_compose_logs.yaml
- docker_compose_ls.yaml
- docker_compose_pause.yaml
- docker_compose_port.yaml
- docker_compose_ps.yaml
- docker_compose_pull.yaml
- docker_compose_push.yaml
- docker_compose_restart.yaml
- docker_compose_rm.yaml
- docker_compose_run.yaml
- docker_compose_start.yaml
- docker_compose_stop.yaml
- docker_compose_top.yaml
- docker_compose_unpause.yaml
- docker_compose_up.yaml
- docker_compose_version.yaml
- docker_compose_build.yaml
- docker_compose_convert.yaml
- docker_compose_cp.yaml
- docker_compose_create.yaml
- docker_compose_down.yaml
- docker_compose_events.yaml
- docker_compose_exec.yaml
- docker_compose_images.yaml
- docker_compose_kill.yaml
- docker_compose_logs.yaml
- docker_compose_ls.yaml
- docker_compose_pause.yaml
- docker_compose_port.yaml
- docker_compose_ps.yaml
- docker_compose_pull.yaml
- docker_compose_push.yaml
- docker_compose_restart.yaml
- docker_compose_rm.yaml
- docker_compose_run.yaml
- docker_compose_start.yaml
- docker_compose_stop.yaml
- docker_compose_top.yaml
- docker_compose_unpause.yaml
- docker_compose_up.yaml
- docker_compose_version.yaml
options:
- option: ansi
- option: ansi
value_type: string
default_value: auto
description: |
@ -168,7 +168,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: compatibility
- option: compatibility
value_type: bool
default_value: "false"
description: Run compose in backward compatibility mode
@ -178,7 +178,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: env-file
- option: env-file
value_type: string
description: Specify an alternate environment file.
deprecated: false
@ -187,7 +187,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: file
- option: file
shorthand: f
value_type: stringArray
default_value: '[]'
@ -198,7 +198,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-ansi
- option: no-ansi
value_type: bool
default_value: "false"
description: Do not print ANSI control characters (DEPRECATED)
@ -208,7 +208,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: profile
- option: profile
value_type: stringArray
default_value: '[]'
description: Specify a profile to enable
@ -218,7 +218,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: project-directory
- option: project-directory
value_type: string
description: |-
Specify an alternate working directory
@ -229,7 +229,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: project-name
- option: project-name
shorthand: p
value_type: string
description: Project name
@ -239,7 +239,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: verbose
- option: verbose
value_type: bool
default_value: "false"
description: Show more output
@ -249,7 +249,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: version
- option: version
shorthand: v
value_type: bool
default_value: "false"
@ -260,7 +260,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
- option: workdir
value_type: string
description: |-
DEPRECATED! USE --project-directory INSTEAD.

22
docs/reference/docker_compose_build.yaml
View File

@ -14,7 +14,7 @@ usage: docker compose build [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: build-arg
- option: build-arg
value_type: stringArray
default_value: '[]'
description: Set build-time variables for services.
@ -24,7 +24,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: compress
- option: compress
value_type: bool
default_value: "true"
description: Compress the build context using gzip. DEPRECATED
@ -34,7 +34,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: force-rm
- option: force-rm
value_type: bool
default_value: "true"
description: Always remove intermediate containers. DEPRECATED
@ -44,7 +44,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: memory
- option: memory
shorthand: m
value_type: string
description: |
@ -55,7 +55,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-cache
- option: no-cache
value_type: bool
default_value: "false"
description: Do not use cache when building the image
@ -65,7 +65,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-rm
- option: no-rm
value_type: bool
default_value: "false"
description: |
@ -76,7 +76,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: parallel
- option: parallel
value_type: bool
default_value: "true"
description: Build images in parallel. DEPRECATED
@ -86,7 +86,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
- option: progress
value_type: string
default_value: auto
description: Set type of progress output (auto, tty, plain, quiet)
@ -96,7 +96,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
- option: pull
value_type: bool
default_value: "false"
description: Always attempt to pull a newer version of the image.
@ -106,7 +106,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
@ -117,7 +117,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: ssh
- option: ssh
value_type: string
description: |
Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent)

24
docs/reference/docker_compose_convert.yaml
View File

@ -1,5 +1,5 @@
command: docker compose convert
aliases: config
aliases: docker compose convert, docker compose config
short: Converts the compose file to platform's canonical format
long: |-
`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
@ -11,7 +11,7 @@ usage: docker compose convert SERVICES
pname: docker compose
plink: docker_compose.yaml
options:
- option: format
- option: format
value_type: string
default_value: yaml
description: 'Format the output. Values: [yaml | json]'
@ -21,7 +21,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: hash
- option: hash
value_type: string
description: Print the service config hash, one per line.
deprecated: false
@ -30,7 +30,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: images
- option: images
value_type: bool
default_value: "false"
description: Print the image names, one per line.
@ -40,7 +40,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-interpolate
- option: no-interpolate
value_type: bool
default_value: "false"
description: Don't interpolate environment variables.
@ -50,7 +50,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-normalize
- option: no-normalize
value_type: bool
default_value: "false"
description: Don't normalize compose model.
@ -60,7 +60,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: output
- option: output
shorthand: o
value_type: string
description: Save to file (default to stdout)
@ -70,7 +70,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: profiles
- option: profiles
value_type: bool
default_value: "false"
description: Print the profile names, one per line.
@ -80,7 +80,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
@ -91,7 +91,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: resolve-image-digests
- option: resolve-image-digests
value_type: bool
default_value: "false"
description: Pin image tags to digests.
@ -101,7 +101,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: services
- option: services
value_type: bool
default_value: "false"
description: Print the service names, one per line.
@ -111,7 +111,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes
- option: volumes
value_type: bool
default_value: "false"
description: Print the volume names, one per line.

13
docs/reference/docker_compose_cp.yaml
View File

@ -1,12 +1,13 @@
command: docker compose cp
short: Copy files/folders between a service container and the local filesystem
long: Copy files/folders between a service container and the local filesystem
usage: "docker compose cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-\n\tdocker compose
cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH"
usage: |-
docker compose cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-
docker compose cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH
pname: docker compose
plink: docker_compose.yaml
options:
- option: all
- option: all
value_type: bool
default_value: "false"
description: Copy to all the containers of the service.
@ -16,7 +17,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: archive
- option: archive
shorthand: a
value_type: bool
default_value: "false"
@ -27,7 +28,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: follow-link
- option: follow-link
shorthand: L
value_type: bool
default_value: "false"
@ -38,7 +39,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: index
- option: index
value_type: int
default_value: "0"
description: |

8
docs/reference/docker_compose_create.yaml
View File

@ -5,7 +5,7 @@ usage: docker compose create [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: build
- option: build
value_type: bool
default_value: "false"
description: Build images before starting containers.
@ -15,7 +15,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: force-recreate
- option: force-recreate
value_type: bool
default_value: "false"
description: |
@ -26,7 +26,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-build
- option: no-build
value_type: bool
default_value: "false"
description: Don't build an image, even if it's missing.
@ -36,7 +36,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-recreate
- option: no-recreate
value_type: bool
default_value: "false"
description: |

8
docs/reference/docker_compose_down.yaml
View File

@ -18,7 +18,7 @@ usage: docker compose down
pname: docker compose
plink: docker_compose.yaml
options:
- option: remove-orphans
- option: remove-orphans
value_type: bool
default_value: "false"
description: Remove containers for services not defined in the Compose file.
@ -28,7 +28,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: rmi
- option: rmi
value_type: string
description: |
Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
@ -38,7 +38,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: timeout
- option: timeout
shorthand: t
value_type: int
default_value: "10"
@ -49,7 +49,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes
- option: volumes
shorthand: v
value_type: bool
default_value: "false"

2
docs/reference/docker_compose_events.yaml
View File

@ -24,7 +24,7 @@ usage: docker compose events [options] [--] [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: json
- option: json
value_type: bool
default_value: "false"
description: Output events as a stream of json objects

18
docs/reference/docker_compose_exec.yaml
View File

@ -9,7 +9,7 @@ usage: docker compose exec [options] [-e KEY=VAL...] [--] SERVICE COMMAND [ARGS.
pname: docker compose
plink: docker_compose.yaml
options:
- option: detach
- option: detach
shorthand: d
value_type: bool
default_value: "false"
@ -20,7 +20,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: env
- option: env
shorthand: e
value_type: stringArray
default_value: '[]'
@ -31,7 +31,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: index
- option: index
value_type: int
default_value: "1"
description: |
@ -42,7 +42,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
- option: interactive
shorthand: i
value_type: bool
default_value: "true"
@ -53,7 +53,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-TTY
- option: no-TTY
shorthand: T
value_type: bool
default_value: "true"
@ -65,7 +65,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: privileged
- option: privileged
value_type: bool
default_value: "false"
description: Give extended privileges to the process.
@ -75,7 +75,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
- option: tty
shorthand: t
value_type: bool
default_value: "true"
@ -86,7 +86,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: user
- option: user
shorthand: u
value_type: string
description: Run the command as this user.
@ -96,7 +96,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
- option: workdir
shorthand: w
value_type: string
description: Path to workdir directory for this command.

2
docs/reference/docker_compose_images.yaml
View File

@ -5,7 +5,7 @@ usage: docker compose images [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: quiet
- option: quiet
shorthand: q
value_type: bool
default_value: "false"

2
docs/reference/docker_compose_kill.yaml
View File

@ -10,7 +10,7 @@ usage: docker compose kill [options] [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: signal
- option: signal
shorthand: s
value_type: string
default_value: SIGKILL

14
docs/reference/docker_compose_logs.yaml
View File

@ -5,7 +5,7 @@ usage: docker compose logs [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: follow
- option: follow
shorthand: f
value_type: bool
default_value: "false"
@ -16,7 +16,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-color
- option: no-color
value_type: bool
default_value: "false"
description: Produce monochrome output.
@ -26,7 +26,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-log-prefix
- option: no-log-prefix
value_type: bool
default_value: "false"
description: Don't print prefix in logs.
@ -36,7 +36,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: since
- option: since
value_type: string
description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
@ -46,7 +46,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: tail
- option: tail
value_type: string
default_value: all
description: |
@ -57,7 +57,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: timestamps
- option: timestamps
shorthand: t
value_type: bool
default_value: "false"
@ -68,7 +68,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: until
- option: until
value_type: string
description: |
Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)

8
docs/reference/docker_compose_ls.yaml
View File

@ -5,7 +5,7 @@ usage: docker compose ls
pname: docker compose
plink: docker_compose.yaml
options:
- option: all
- option: all
shorthand: a
value_type: bool
default_value: "false"
@ -16,7 +16,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
- option: filter
value_type: filter
description: Filter output based on conditions provided.
deprecated: false
@ -25,7 +25,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: format
- option: format
value_type: string
default_value: pretty
description: 'Format the output. Values: [pretty | json].'
@ -35,7 +35,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
- option: quiet
shorthand: q
value_type: bool
default_value: "false"

4
docs/reference/docker_compose_port.yaml
View File

@ -5,7 +5,7 @@ usage: docker compose port [options] [--] SERVICE PRIVATE_PORT
pname: docker compose
plink: docker_compose.yaml
options:
- option: index
- option: index
value_type: int
default_value: "1"
description: index of the container if service has multiple replicas
@ -15,7 +15,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: protocol
- option: protocol
value_type: string
default_value: tcp
description: tcp or udp

12
docs/reference/docker_compose_ps.yaml
View File

@ -14,7 +14,7 @@ usage: docker compose ps [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: all
- option: all
shorthand: a
value_type: bool
default_value: "false"
@ -26,7 +26,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: filter
- option: filter
value_type: string
description: 'Filter services by a property (supported filters: status).'
details_url: '#filter'
@ -36,7 +36,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: format
- option: format
value_type: string
default_value: pretty
description: 'Format the output. Values: [pretty | json]'
@ -47,7 +47,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
@ -58,7 +58,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: services
- option: services
value_type: bool
default_value: "false"
description: Display services
@ -68,7 +68,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: status
- option: status
value_type: stringArray
default_value: '[]'
description: |

10
docs/reference/docker_compose_pull.yaml
View File

@ -7,7 +7,7 @@ usage: docker compose pull [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: ignore-pull-failures
- option: ignore-pull-failures
value_type: bool
default_value: "false"
description: Pull what it can and ignores images with pull failures
@ -17,7 +17,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: include-deps
- option: include-deps
value_type: bool
default_value: "false"
description: Also pull services declared as dependencies
@ -27,7 +27,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-parallel
- option: no-parallel
value_type: bool
default_value: "true"
description: DEPRECATED disable parallel pulling.
@ -37,7 +37,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: parallel
- option: parallel
value_type: bool
default_value: "true"
description: DEPRECATED pull multiple images in parallel.
@ -47,7 +47,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
- option: quiet
shorthand: q
value_type: bool
default_value: "false"

2
docs/reference/docker_compose_push.yaml
View File

@ -23,7 +23,7 @@ usage: docker compose push [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: ignore-push-failures
- option: ignore-push-failures
value_type: bool
default_value: "false"
description: Push what it can and ignores images with push failures

2
docs/reference/docker_compose_restart.yaml
View File

@ -15,7 +15,7 @@ usage: docker compose restart
pname: docker compose
plink: docker_compose.yaml
options:
- option: timeout
- option: timeout
shorthand: t
value_type: int
default_value: "10"

8
docs/reference/docker_compose_rm.yaml
View File

@ -20,7 +20,7 @@ usage: docker compose rm [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: all
- option: all
shorthand: a
value_type: bool
default_value: "false"
@ -31,7 +31,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: force
- option: force
shorthand: f
value_type: bool
default_value: "false"
@ -42,7 +42,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: stop
- option: stop
shorthand: s
value_type: bool
default_value: "false"
@ -53,7 +53,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: volumes
- option: volumes
shorthand: v
value_type: bool
default_value: "false"

37
docs/reference/docker_compose_run.yaml
View File

@ -54,12 +54,11 @@ long: |-
This runs a database upgrade script, and removes the container when finished running, even if a restart policy is
specified in the service configuration.
usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l
KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: detach
- option: detach
shorthand: d
value_type: bool
default_value: "false"
@ -70,7 +69,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: entrypoint
- option: entrypoint
value_type: string
description: Override the entrypoint of the image
deprecated: false
@ -79,7 +78,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: env
- option: env
shorthand: e
value_type: stringArray
default_value: '[]'
@ -90,7 +89,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
- option: interactive
shorthand: i
value_type: bool
default_value: "true"
@ -101,7 +100,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: label
- option: label
shorthand: l
value_type: stringArray
default_value: '[]'
@ -112,7 +111,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: name
- option: name
value_type: string
description: Assign a name to the container
deprecated: false
@ -121,7 +120,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-TTY
- option: no-TTY
shorthand: T
value_type: bool
default_value: "true"
@ -132,7 +131,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-deps
- option: no-deps
value_type: bool
default_value: "false"
description: Don't start linked services.
@ -142,7 +141,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: publish
- option: publish
shorthand: p
value_type: stringArray
default_value: '[]'
@ -153,7 +152,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet-pull
- option: quiet-pull
value_type: bool
default_value: "false"
description: Pull without printing progress information.
@ -163,7 +162,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: rm
- option: rm
value_type: bool
default_value: "false"
description: Automatically remove the container when it exits
@ -173,7 +172,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: service-ports
- option: service-ports
value_type: bool
default_value: "false"
description: |
@ -184,7 +183,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: tty
- option: tty
shorthand: t
value_type: bool
default_value: "true"
@ -195,7 +194,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: use-aliases
- option: use-aliases
value_type: bool
default_value: "false"
description: |
@ -206,7 +205,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: user
- option: user
shorthand: u
value_type: string
description: Run as specified username or uid
@ -216,7 +215,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: volume
- option: volume
shorthand: v
value_type: stringArray
default_value: '[]'
@ -227,7 +226,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: workdir
- option: workdir
shorthand: w
value_type: string
description: Working directory inside the container

2
docs/reference/docker_compose_stop.yaml
View File

@ -6,7 +6,7 @@ usage: docker compose stop [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: timeout
- option: timeout
shorthand: t
value_type: int
default_value: "10"

40
docs/reference/docker_compose_up.yaml
View File

@ -21,7 +21,7 @@ usage: docker compose up [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
- option: abort-on-container-exit
- option: abort-on-container-exit
value_type: bool
default_value: "false"
description: |
@ -32,7 +32,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: always-recreate-deps
- option: always-recreate-deps
value_type: bool
default_value: "false"
description: Recreate dependent containers. Incompatible with --no-recreate.
@ -42,7 +42,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: attach
- option: attach
value_type: stringArray
default_value: '[]'
description: Attach to service output.
@ -52,7 +52,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: attach-dependencies
- option: attach-dependencies
value_type: bool
default_value: "false"
description: Attach to dependent containers.
@ -62,7 +62,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: build
- option: build
value_type: bool
default_value: "false"
description: Build images before starting containers.
@ -72,7 +72,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: detach
- option: detach
shorthand: d
value_type: bool
default_value: "false"
@ -83,7 +83,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: exit-code-from
- option: exit-code-from
value_type: string
description: |
Return the exit code of the selected service container. Implies --abort-on-container-exit
@ -93,7 +93,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: force-recreate
- option: force-recreate
value_type: bool
default_value: "false"
description: |
@ -104,7 +104,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-build
- option: no-build
value_type: bool
default_value: "false"
description: Don't build an image, even if it's missing.
@ -114,7 +114,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-color
- option: no-color
value_type: bool
default_value: "false"
description: Produce monochrome output.
@ -124,7 +124,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-deps
- option: no-deps
value_type: bool
default_value: "false"
description: Don't start linked services.
@ -134,7 +134,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-log-prefix
- option: no-log-prefix
value_type: bool
default_value: "false"
description: Don't print prefix in logs.
@ -144,7 +144,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-recreate
- option: no-recreate
value_type: bool
default_value: "false"
description: |
@ -155,7 +155,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-start
- option: no-start
value_type: bool
default_value: "false"
description: Don't start the services after creating them.
@ -165,7 +165,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet-pull
- option: quiet-pull
value_type: bool
default_value: "false"
description: Pull without printing progress information.
@ -175,7 +175,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: remove-orphans
- option: remove-orphans
value_type: bool
default_value: "false"
description: Remove containers for services not defined in the Compose file.
@ -185,7 +185,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: renew-anon-volumes
- option: renew-anon-volumes
shorthand: V
value_type: bool
default_value: "false"
@ -197,7 +197,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: scale
- option: scale
value_type: stringArray
default_value: '[]'
description: |
@ -208,7 +208,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: timeout
- option: timeout
shorthand: t
value_type: int
default_value: "10"
@ -220,7 +220,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: wait
- option: wait
value_type: bool
default_value: "false"
description: Wait for services to be running|healthy. Implies detached mode.

4
docs/reference/docker_compose_version.yaml
View File

@ -5,7 +5,7 @@ usage: docker compose version
pname: docker compose
plink: docker_compose.yaml
options:
- option: format
- option: format
shorthand: f
value_type: string
description: 'Format the output. Values: [pretty | json]. (Default: pretty)'
@ -15,7 +15,7 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: short
- option: short
value_type: bool
default_value: "false"
description: Shows only Compose's version number.

2
go.mod
View File

@ -12,7 +12,7 @@ require (
github.com/distribution/distribution/v3 v3.0.0-20210316161203-a01c71e2477e
github.com/docker/buildx v0.8.2 // when updating, also update the replace rules accordingly
github.com/docker/cli v20.10.17+incompatible
github.com/docker/cli-docs-tool v0.4.0
github.com/docker/cli-docs-tool v0.5.0
github.com/docker/docker v20.10.17+incompatible
github.com/docker/go-connections v0.4.0
github.com/docker/go-units v0.4.0

3
go.sum
View File

@ -454,8 +454,9 @@ github.com/docker/buildx v0.8.2 h1:dsd3F0hhmUydFX/KFrvbK81JvlTA4T3Iy0lwDJt4PsU=
github.com/docker/buildx v0.8.2/go.mod h1:5sMOfNwOmO2jy/MxBL4ySk2LoLIG1tQFu2EU8wbKa34=
github.com/docker/cli v20.10.3-0.20220309205733-2b52f62e9627+incompatible h1:RWXvuBczWuSIMjI69AnkNklNNVX2gmS0X+15AttGDVk=
github.com/docker/cli v20.10.3-0.20220309205733-2b52f62e9627+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8=
github.com/docker/cli-docs-tool v0.4.0 h1:MdfKoErGEbFqIxQ8an9BsZ+YzKUGd58RBVkV+Q82GPo=
github.com/docker/cli-docs-tool v0.4.0/go.mod h1:rgW5KKdNpLMBIuH4WQ/1RNh38nH+/Ay5jgL4P0ZMPpY=
github.com/docker/cli-docs-tool v0.5.0 h1:EjGwI6EyB7YemHCC7R8mwXszJTbuq0T0pFuDC5bMhcE=
github.com/docker/cli-docs-tool v0.5.0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o=
github.com/docker/distribution v0.0.0-20190905152932-14b96e55d84c/go.mod h1:0+TTO4EOBfRPhZXAeF1Vu+W3hHZ8eLp8PgKVZlcvtFY=
github.com/docker/distribution v2.6.0-rc.1.0.20180327202408-83389a148052+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
github.com/docker/distribution v2.7.1-0.20190205005809-0d3efadf0154+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=