mirror of https://github.com/docker/docs.git
Update Compose reference API to v2.10.2
Signed-off-by: GitHub <noreply@github.com>
This commit is contained in:
parent
232d94dc71
commit
f032278139
|
@ -40,7 +40,7 @@ exclude:
|
||||||
latest_engine_api_version: "1.41"
|
latest_engine_api_version: "1.41"
|
||||||
docker_ce_version: "20.10"
|
docker_ce_version: "20.10"
|
||||||
compose_v1_version: "1.29.2"
|
compose_v1_version: "1.29.2"
|
||||||
compose_version: "v2.7.0"
|
compose_version: "v2.10.2"
|
||||||
compose_file_v3: "3.9"
|
compose_file_v3: "3.9"
|
||||||
compose_file_v2: "2.4"
|
compose_file_v2: "2.4"
|
||||||
machine_version: "0.16.0"
|
machine_version: "0.16.0"
|
||||||
|
|
|
@ -105,59 +105,59 @@ usage: docker compose
|
||||||
pname: docker
|
pname: docker
|
||||||
plink: docker.yaml
|
plink: docker.yaml
|
||||||
cname:
|
cname:
|
||||||
- docker compose build
|
- docker compose build
|
||||||
- docker compose convert
|
- docker compose convert
|
||||||
- docker compose cp
|
- docker compose cp
|
||||||
- docker compose create
|
- docker compose create
|
||||||
- docker compose down
|
- docker compose down
|
||||||
- docker compose events
|
- docker compose events
|
||||||
- docker compose exec
|
- docker compose exec
|
||||||
- docker compose images
|
- docker compose images
|
||||||
- docker compose kill
|
- docker compose kill
|
||||||
- docker compose logs
|
- docker compose logs
|
||||||
- docker compose ls
|
- docker compose ls
|
||||||
- docker compose pause
|
- docker compose pause
|
||||||
- docker compose port
|
- docker compose port
|
||||||
- docker compose ps
|
- docker compose ps
|
||||||
- docker compose pull
|
- docker compose pull
|
||||||
- docker compose push
|
- docker compose push
|
||||||
- docker compose restart
|
- docker compose restart
|
||||||
- docker compose rm
|
- docker compose rm
|
||||||
- docker compose run
|
- docker compose run
|
||||||
- docker compose start
|
- docker compose start
|
||||||
- docker compose stop
|
- docker compose stop
|
||||||
- docker compose top
|
- docker compose top
|
||||||
- docker compose unpause
|
- docker compose unpause
|
||||||
- docker compose up
|
- docker compose up
|
||||||
- docker compose version
|
- docker compose version
|
||||||
clink:
|
clink:
|
||||||
- docker_compose_build.yaml
|
- docker_compose_build.yaml
|
||||||
- docker_compose_convert.yaml
|
- docker_compose_convert.yaml
|
||||||
- docker_compose_cp.yaml
|
- docker_compose_cp.yaml
|
||||||
- docker_compose_create.yaml
|
- docker_compose_create.yaml
|
||||||
- docker_compose_down.yaml
|
- docker_compose_down.yaml
|
||||||
- docker_compose_events.yaml
|
- docker_compose_events.yaml
|
||||||
- docker_compose_exec.yaml
|
- docker_compose_exec.yaml
|
||||||
- docker_compose_images.yaml
|
- docker_compose_images.yaml
|
||||||
- docker_compose_kill.yaml
|
- docker_compose_kill.yaml
|
||||||
- docker_compose_logs.yaml
|
- docker_compose_logs.yaml
|
||||||
- docker_compose_ls.yaml
|
- docker_compose_ls.yaml
|
||||||
- docker_compose_pause.yaml
|
- docker_compose_pause.yaml
|
||||||
- docker_compose_port.yaml
|
- docker_compose_port.yaml
|
||||||
- docker_compose_ps.yaml
|
- docker_compose_ps.yaml
|
||||||
- docker_compose_pull.yaml
|
- docker_compose_pull.yaml
|
||||||
- docker_compose_push.yaml
|
- docker_compose_push.yaml
|
||||||
- docker_compose_restart.yaml
|
- docker_compose_restart.yaml
|
||||||
- docker_compose_rm.yaml
|
- docker_compose_rm.yaml
|
||||||
- docker_compose_run.yaml
|
- docker_compose_run.yaml
|
||||||
- docker_compose_start.yaml
|
- docker_compose_start.yaml
|
||||||
- docker_compose_stop.yaml
|
- docker_compose_stop.yaml
|
||||||
- docker_compose_top.yaml
|
- docker_compose_top.yaml
|
||||||
- docker_compose_unpause.yaml
|
- docker_compose_unpause.yaml
|
||||||
- docker_compose_up.yaml
|
- docker_compose_up.yaml
|
||||||
- docker_compose_version.yaml
|
- docker_compose_version.yaml
|
||||||
options:
|
options:
|
||||||
- option: ansi
|
- option: ansi
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: auto
|
default_value: auto
|
||||||
description: |
|
description: |
|
||||||
|
@ -168,7 +168,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: compatibility
|
- option: compatibility
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Run compose in backward compatibility mode
|
description: Run compose in backward compatibility mode
|
||||||
|
@ -178,7 +178,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: env-file
|
- option: env-file
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Specify an alternate environment file.
|
description: Specify an alternate environment file.
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
@ -187,7 +187,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: file
|
- option: file
|
||||||
shorthand: f
|
shorthand: f
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
|
@ -198,7 +198,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-ansi
|
- option: no-ansi
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Do not print ANSI control characters (DEPRECATED)
|
description: Do not print ANSI control characters (DEPRECATED)
|
||||||
|
@ -208,7 +208,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: profile
|
- option: profile
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
description: Specify a profile to enable
|
description: Specify a profile to enable
|
||||||
|
@ -218,7 +218,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: project-directory
|
- option: project-directory
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |-
|
description: |-
|
||||||
Specify an alternate working directory
|
Specify an alternate working directory
|
||||||
|
@ -229,7 +229,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: project-name
|
- option: project-name
|
||||||
shorthand: p
|
shorthand: p
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Project name
|
description: Project name
|
||||||
|
@ -239,7 +239,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: verbose
|
- option: verbose
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Show more output
|
description: Show more output
|
||||||
|
@ -249,7 +249,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: version
|
- option: version
|
||||||
shorthand: v
|
shorthand: v
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -260,7 +260,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: workdir
|
- option: workdir
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |-
|
description: |-
|
||||||
DEPRECATED! USE --project-directory INSTEAD.
|
DEPRECATED! USE --project-directory INSTEAD.
|
||||||
|
|
|
@ -10,11 +10,11 @@ long: |-
|
||||||
|
|
||||||
If you change a service's `Dockerfile` or the contents of its build directory,
|
If you change a service's `Dockerfile` or the contents of its build directory,
|
||||||
run `docker compose build` to rebuild it.
|
run `docker compose build` to rebuild it.
|
||||||
usage: docker compose build [SERVICE...]
|
usage: docker compose build [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: build-arg
|
- option: build-arg
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
description: Set build-time variables for services.
|
description: Set build-time variables for services.
|
||||||
|
@ -24,7 +24,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: compress
|
- option: compress
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
description: Compress the build context using gzip. DEPRECATED
|
description: Compress the build context using gzip. DEPRECATED
|
||||||
|
@ -34,7 +34,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: force-rm
|
- option: force-rm
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
description: Always remove intermediate containers. DEPRECATED
|
description: Always remove intermediate containers. DEPRECATED
|
||||||
|
@ -44,7 +44,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: memory
|
- option: memory
|
||||||
shorthand: m
|
shorthand: m
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |
|
description: |
|
||||||
|
@ -55,7 +55,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-cache
|
- option: no-cache
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Do not use cache when building the image
|
description: Do not use cache when building the image
|
||||||
|
@ -65,7 +65,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-rm
|
- option: no-rm
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -76,7 +76,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: parallel
|
- option: parallel
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
description: Build images in parallel. DEPRECATED
|
description: Build images in parallel. DEPRECATED
|
||||||
|
@ -86,7 +86,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: progress
|
- option: progress
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: auto
|
default_value: auto
|
||||||
description: Set type of progress output (auto, tty, plain, quiet)
|
description: Set type of progress output (auto, tty, plain, quiet)
|
||||||
|
@ -96,7 +96,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: pull
|
- option: pull
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Always attempt to pull a newer version of the image.
|
description: Always attempt to pull a newer version of the image.
|
||||||
|
@ -106,7 +106,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet
|
- option: quiet
|
||||||
shorthand: q
|
shorthand: q
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -117,7 +117,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: ssh
|
- option: ssh
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |
|
description: |
|
||||||
Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent)
|
Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent)
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
command: docker compose convert
|
command: docker compose convert
|
||||||
aliases: config
|
aliases: docker compose convert, docker compose config
|
||||||
short: Converts the compose file to platform's canonical format
|
short: Converts the compose file to platform's canonical format
|
||||||
long: |-
|
long: |-
|
||||||
`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
|
`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,
|
||||||
|
@ -7,11 +7,11 @@ long: |-
|
||||||
fully defined Compose model.
|
fully defined Compose model.
|
||||||
|
|
||||||
To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
|
To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
|
||||||
usage: docker compose convert SERVICES
|
usage: docker compose convert [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: format
|
- option: format
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: yaml
|
default_value: yaml
|
||||||
description: 'Format the output. Values: [yaml | json]'
|
description: 'Format the output. Values: [yaml | json]'
|
||||||
|
@ -21,7 +21,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: hash
|
- option: hash
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Print the service config hash, one per line.
|
description: Print the service config hash, one per line.
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
@ -30,7 +30,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: images
|
- option: images
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Print the image names, one per line.
|
description: Print the image names, one per line.
|
||||||
|
@ -40,7 +40,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-interpolate
|
- option: no-interpolate
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't interpolate environment variables.
|
description: Don't interpolate environment variables.
|
||||||
|
@ -50,7 +50,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-normalize
|
- option: no-normalize
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't normalize compose model.
|
description: Don't normalize compose model.
|
||||||
|
@ -60,7 +60,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: output
|
- option: output
|
||||||
shorthand: o
|
shorthand: o
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Save to file (default to stdout)
|
description: Save to file (default to stdout)
|
||||||
|
@ -70,7 +70,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: profiles
|
- option: profiles
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Print the profile names, one per line.
|
description: Print the profile names, one per line.
|
||||||
|
@ -80,7 +80,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet
|
- option: quiet
|
||||||
shorthand: q
|
shorthand: q
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -91,7 +91,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: resolve-image-digests
|
- option: resolve-image-digests
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Pin image tags to digests.
|
description: Pin image tags to digests.
|
||||||
|
@ -101,7 +101,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: services
|
- option: services
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Print the service names, one per line.
|
description: Print the service names, one per line.
|
||||||
|
@ -111,7 +111,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: volumes
|
- option: volumes
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Print the volume names, one per line.
|
description: Print the volume names, one per line.
|
||||||
|
|
|
@ -1,12 +1,13 @@
|
||||||
command: docker compose cp
|
command: docker compose cp
|
||||||
short: Copy files/folders between a service container and the local filesystem
|
short: Copy files/folders between a service container and the local filesystem
|
||||||
long: 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
|
usage: |-
|
||||||
cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH"
|
docker compose cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-
|
||||||
|
docker compose cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: all
|
- option: all
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Copy to all the containers of the service.
|
description: Copy to all the containers of the service.
|
||||||
|
@ -16,7 +17,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: archive
|
- option: archive
|
||||||
shorthand: a
|
shorthand: a
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -27,7 +28,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: follow-link
|
- option: follow-link
|
||||||
shorthand: L
|
shorthand: L
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -38,7 +39,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: index
|
- option: index
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "0"
|
default_value: "0"
|
||||||
description: |
|
description: |
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
command: docker compose create
|
command: docker compose create
|
||||||
short: Creates containers for a service.
|
short: Creates containers for a service.
|
||||||
long: Creates containers for a service.
|
long: Creates containers for a service.
|
||||||
usage: docker compose create [SERVICE...]
|
usage: docker compose create [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: build
|
- option: build
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Build images before starting containers.
|
description: Build images before starting containers.
|
||||||
|
@ -15,7 +15,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: force-recreate
|
- option: force-recreate
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -26,7 +26,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-build
|
- option: no-build
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't build an image, even if it's missing.
|
description: Don't build an image, even if it's missing.
|
||||||
|
@ -36,7 +36,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-recreate
|
- option: no-recreate
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -47,6 +47,16 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
|
- option: pull
|
||||||
|
value_type: string
|
||||||
|
default_value: missing
|
||||||
|
description: Pull image before running ("always"|"missing"|"never")
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
deprecated: false
|
deprecated: false
|
||||||
experimental: false
|
experimental: false
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
|
|
|
@ -14,11 +14,11 @@ long: |-
|
||||||
Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically
|
Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically
|
||||||
mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
|
mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
|
||||||
named volumes.
|
named volumes.
|
||||||
usage: docker compose down
|
usage: docker compose down [OPTIONS]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: remove-orphans
|
- option: remove-orphans
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Remove containers for services not defined in the Compose file.
|
description: Remove containers for services not defined in the Compose file.
|
||||||
|
@ -28,7 +28,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: rmi
|
- option: rmi
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |
|
description: |
|
||||||
Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
|
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
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: timeout
|
- option: timeout
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "10"
|
default_value: "10"
|
||||||
|
@ -49,7 +49,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: volumes
|
- option: volumes
|
||||||
shorthand: v
|
shorthand: v
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
|
|
@ -20,11 +20,11 @@ long: |-
|
||||||
```
|
```
|
||||||
|
|
||||||
The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
|
The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
|
||||||
usage: docker compose events [options] [--] [SERVICE...]
|
usage: docker compose events [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: json
|
- option: json
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Output events as a stream of json objects
|
description: Output events as a stream of json objects
|
||||||
|
|
|
@ -5,11 +5,11 @@ long: |-
|
||||||
|
|
||||||
With this subcommand you can run arbitrary commands in your services. Commands are by default allocating a TTY, so
|
With this subcommand you can run arbitrary commands in your services. Commands are by default allocating a TTY, so
|
||||||
you can use a command such as `docker compose exec web sh` to get an interactive prompt.
|
you can use a command such as `docker compose exec web sh` to get an interactive prompt.
|
||||||
usage: docker compose exec [options] [-e KEY=VAL...] [--] SERVICE COMMAND [ARGS...]
|
usage: docker compose exec [OPTIONS] SERVICE COMMAND [ARGS...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: detach
|
- option: detach
|
||||||
shorthand: d
|
shorthand: d
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -20,7 +20,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: env
|
- option: env
|
||||||
shorthand: e
|
shorthand: e
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
|
@ -31,7 +31,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: index
|
- option: index
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "1"
|
default_value: "1"
|
||||||
description: |
|
description: |
|
||||||
|
@ -42,7 +42,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: interactive
|
- option: interactive
|
||||||
shorthand: i
|
shorthand: i
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
|
@ -53,7 +53,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-TTY
|
- option: no-TTY
|
||||||
shorthand: T
|
shorthand: T
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
|
@ -65,7 +65,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: privileged
|
- option: privileged
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Give extended privileges to the process.
|
description: Give extended privileges to the process.
|
||||||
|
@ -75,7 +75,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: tty
|
- option: tty
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
|
@ -86,7 +86,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: user
|
- option: user
|
||||||
shorthand: u
|
shorthand: u
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Run the command as this user.
|
description: Run the command as this user.
|
||||||
|
@ -96,7 +96,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: workdir
|
- option: workdir
|
||||||
shorthand: w
|
shorthand: w
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Path to workdir directory for this command.
|
description: Path to workdir directory for this command.
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
command: docker compose images
|
command: docker compose images
|
||||||
short: List images used by the created containers
|
short: List images used by the created containers
|
||||||
long: List images used by the created containers
|
long: List images used by the created containers
|
||||||
usage: docker compose images [SERVICE...]
|
usage: docker compose images [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: quiet
|
- option: quiet
|
||||||
shorthand: q
|
shorthand: q
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
|
|
@ -6,11 +6,21 @@ long: |-
|
||||||
```console
|
```console
|
||||||
$ docker-compose kill -s SIGINT
|
$ docker-compose kill -s SIGINT
|
||||||
```
|
```
|
||||||
usage: docker compose kill [options] [SERVICE...]
|
usage: docker compose kill [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: signal
|
- option: remove-orphans
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Remove containers for services not defined in the Compose file.
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: signal
|
||||||
shorthand: s
|
shorthand: s
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: SIGKILL
|
default_value: SIGKILL
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
command: docker compose logs
|
command: docker compose logs
|
||||||
short: View output from containers
|
short: View output from containers
|
||||||
long: Displays log output from services.
|
long: Displays log output from services.
|
||||||
usage: docker compose logs [SERVICE...]
|
usage: docker compose logs [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: follow
|
- option: follow
|
||||||
shorthand: f
|
shorthand: f
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -16,7 +16,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-color
|
- option: no-color
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Produce monochrome output.
|
description: Produce monochrome output.
|
||||||
|
@ -26,7 +26,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-log-prefix
|
- option: no-log-prefix
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't print prefix in logs.
|
description: Don't print prefix in logs.
|
||||||
|
@ -36,7 +36,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: since
|
- option: since
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |
|
description: |
|
||||||
Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
|
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
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: tail
|
- option: tail
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: all
|
default_value: all
|
||||||
description: |
|
description: |
|
||||||
|
@ -57,7 +57,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: timestamps
|
- option: timestamps
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -68,7 +68,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: until
|
- option: until
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |
|
description: |
|
||||||
Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
|
Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
command: docker compose ls
|
command: docker compose ls
|
||||||
short: List running compose projects
|
short: List running compose projects
|
||||||
long: List Compose projects running on platform.
|
long: List Compose projects running on platform.
|
||||||
usage: docker compose ls
|
usage: docker compose ls [OPTIONS]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: all
|
- option: all
|
||||||
shorthand: a
|
shorthand: a
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -16,7 +16,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: filter
|
- option: filter
|
||||||
value_type: filter
|
value_type: filter
|
||||||
description: Filter output based on conditions provided.
|
description: Filter output based on conditions provided.
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
@ -25,7 +25,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: format
|
- option: format
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: pretty
|
default_value: pretty
|
||||||
description: 'Format the output. Values: [pretty | json].'
|
description: 'Format the output. Values: [pretty | json].'
|
||||||
|
@ -35,7 +35,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet
|
- option: quiet
|
||||||
shorthand: q
|
shorthand: q
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
command: docker compose port
|
command: docker compose port
|
||||||
short: Print the public port for a port binding.
|
short: Print the public port for a port binding.
|
||||||
long: Prints the public port for a port binding.
|
long: Prints the public port for a port binding.
|
||||||
usage: docker compose port [options] [--] SERVICE PRIVATE_PORT
|
usage: docker compose port [OPTIONS] SERVICE PRIVATE_PORT
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: index
|
- option: index
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "1"
|
default_value: "1"
|
||||||
description: index of the container if service has multiple replicas
|
description: index of the container if service has multiple replicas
|
||||||
|
@ -15,7 +15,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: protocol
|
- option: protocol
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: tcp
|
default_value: tcp
|
||||||
description: tcp or udp
|
description: tcp or udp
|
||||||
|
|
|
@ -10,11 +10,11 @@ long: |-
|
||||||
example-bar-1 "/docker-entrypoint.…" bar exited (0)
|
example-bar-1 "/docker-entrypoint.…" bar exited (0)
|
||||||
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp
|
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp
|
||||||
```
|
```
|
||||||
usage: docker compose ps [SERVICE...]
|
usage: docker compose ps [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: all
|
- option: all
|
||||||
shorthand: a
|
shorthand: a
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -26,7 +26,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: filter
|
- option: filter
|
||||||
value_type: string
|
value_type: string
|
||||||
description: 'Filter services by a property (supported filters: status).'
|
description: 'Filter services by a property (supported filters: status).'
|
||||||
details_url: '#filter'
|
details_url: '#filter'
|
||||||
|
@ -36,7 +36,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: format
|
- option: format
|
||||||
value_type: string
|
value_type: string
|
||||||
default_value: pretty
|
default_value: pretty
|
||||||
description: 'Format the output. Values: [pretty | json]'
|
description: 'Format the output. Values: [pretty | json]'
|
||||||
|
@ -47,7 +47,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet
|
- option: quiet
|
||||||
shorthand: q
|
shorthand: q
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -58,7 +58,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: services
|
- option: services
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Display services
|
description: Display services
|
||||||
|
@ -68,7 +68,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: status
|
- option: status
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
description: |
|
description: |
|
||||||
|
|
|
@ -3,11 +3,11 @@ short: Pull service images
|
||||||
long: |-
|
long: |-
|
||||||
Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on
|
Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on
|
||||||
those images.
|
those images.
|
||||||
usage: docker compose pull [SERVICE...]
|
usage: docker compose pull [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: ignore-pull-failures
|
- option: ignore-pull-failures
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Pull what it can and ignores images with pull failures
|
description: Pull what it can and ignores images with pull failures
|
||||||
|
@ -17,7 +17,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: include-deps
|
- option: include-deps
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Also pull services declared as dependencies
|
description: Also pull services declared as dependencies
|
||||||
|
@ -27,7 +27,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-parallel
|
- option: no-parallel
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
description: DEPRECATED disable parallel pulling.
|
description: DEPRECATED disable parallel pulling.
|
||||||
|
@ -37,7 +37,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: parallel
|
- option: parallel
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
description: DEPRECATED pull multiple images in parallel.
|
description: DEPRECATED pull multiple images in parallel.
|
||||||
|
@ -47,7 +47,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet
|
- option: quiet
|
||||||
shorthand: q
|
shorthand: q
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
|
|
@ -19,11 +19,11 @@ long: |-
|
||||||
build: .
|
build: .
|
||||||
image: your-dockerid/yourimage ## goes to your repository on Docker Hub
|
image: your-dockerid/yourimage ## goes to your repository on Docker Hub
|
||||||
```
|
```
|
||||||
usage: docker compose push [SERVICE...]
|
usage: docker compose push [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: ignore-push-failures
|
- option: ignore-push-failures
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Push what it can and ignores images with push failures
|
description: Push what it can and ignores images with push failures
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
command: docker compose restart
|
command: docker compose restart
|
||||||
short: Restart containers
|
short: Restart service containers
|
||||||
long: |-
|
long: |-
|
||||||
Restarts all stopped and running services.
|
Restarts all stopped and running services, or the specified services only.
|
||||||
|
|
||||||
If you make changes to your `compose.yml` configuration, these changes are not reflected
|
If you make changes to your `compose.yml` configuration, these changes are not reflected
|
||||||
after running this command. For example, changes to environment variables (which are added
|
after running this command. For example, changes to environment variables (which are added
|
||||||
|
@ -11,11 +11,11 @@ long: |-
|
||||||
If you are looking to configure a service's restart policy, please refer to
|
If you are looking to configure a service's restart policy, please refer to
|
||||||
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart)
|
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart)
|
||||||
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).
|
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).
|
||||||
usage: docker compose restart
|
usage: docker compose restart [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: timeout
|
- option: timeout
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "10"
|
default_value: "10"
|
||||||
|
|
|
@ -16,11 +16,11 @@ long: |-
|
||||||
Are you sure? [yN] y
|
Are you sure? [yN] y
|
||||||
Removing djangoquickstart_web_run_1 ... done
|
Removing djangoquickstart_web_run_1 ... done
|
||||||
```
|
```
|
||||||
usage: docker compose rm [SERVICE...]
|
usage: docker compose rm [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: all
|
- option: all
|
||||||
shorthand: a
|
shorthand: a
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -31,7 +31,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: force
|
- option: force
|
||||||
shorthand: f
|
shorthand: f
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -42,7 +42,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: stop
|
- option: stop
|
||||||
shorthand: s
|
shorthand: s
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -53,7 +53,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: volumes
|
- option: volumes
|
||||||
shorthand: v
|
shorthand: v
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
|
|
@ -54,12 +54,11 @@ long: |-
|
||||||
|
|
||||||
This runs a database upgrade script, and removes the container when finished running, even if a restart policy is
|
This runs a database upgrade script, and removes the container when finished running, even if a restart policy is
|
||||||
specified in the service configuration.
|
specified in the service configuration.
|
||||||
usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l
|
usage: docker compose run [OPTIONS] SERVICE [COMMAND] [ARGS...]
|
||||||
KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
|
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: detach
|
- option: detach
|
||||||
shorthand: d
|
shorthand: d
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -70,7 +69,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: entrypoint
|
- option: entrypoint
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Override the entrypoint of the image
|
description: Override the entrypoint of the image
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
@ -79,7 +78,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: env
|
- option: env
|
||||||
shorthand: e
|
shorthand: e
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
|
@ -90,7 +89,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: interactive
|
- option: interactive
|
||||||
shorthand: i
|
shorthand: i
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
|
@ -101,7 +100,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: label
|
- option: label
|
||||||
shorthand: l
|
shorthand: l
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
|
@ -112,7 +111,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: name
|
- option: name
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Assign a name to the container
|
description: Assign a name to the container
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
@ -121,7 +120,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-TTY
|
- option: no-TTY
|
||||||
shorthand: T
|
shorthand: T
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
|
@ -132,7 +131,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-deps
|
- option: no-deps
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't start linked services.
|
description: Don't start linked services.
|
||||||
|
@ -142,7 +141,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: publish
|
- option: publish
|
||||||
shorthand: p
|
shorthand: p
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
|
@ -153,7 +152,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet-pull
|
- option: quiet-pull
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Pull without printing progress information.
|
description: Pull without printing progress information.
|
||||||
|
@ -163,7 +162,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: rm
|
- option: rm
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Automatically remove the container when it exits
|
description: Automatically remove the container when it exits
|
||||||
|
@ -173,7 +172,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: service-ports
|
- option: service-ports
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -184,7 +183,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: tty
|
- option: tty
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
|
@ -195,7 +194,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: use-aliases
|
- option: use-aliases
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -206,7 +205,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: user
|
- option: user
|
||||||
shorthand: u
|
shorthand: u
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Run as specified username or uid
|
description: Run as specified username or uid
|
||||||
|
@ -216,7 +215,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: volume
|
- option: volume
|
||||||
shorthand: v
|
shorthand: v
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
|
@ -227,7 +226,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: workdir
|
- option: workdir
|
||||||
shorthand: w
|
shorthand: w
|
||||||
value_type: string
|
value_type: string
|
||||||
description: Working directory inside the container
|
description: Working directory inside the container
|
||||||
|
|
|
@ -2,11 +2,11 @@ command: docker compose stop
|
||||||
short: Stop services
|
short: Stop services
|
||||||
long: |
|
long: |
|
||||||
Stops running containers without removing them. They can be started again with `docker compose start`.
|
Stops running containers without removing them. They can be started again with `docker compose start`.
|
||||||
usage: docker compose stop [SERVICE...]
|
usage: docker compose stop [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: timeout
|
- option: timeout
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "10"
|
default_value: "10"
|
||||||
|
|
|
@ -17,11 +17,11 @@ long: |-
|
||||||
|
|
||||||
If the process encounters an error, the exit code for this command is `1`.
|
If the process encounters an error, the exit code for this command is `1`.
|
||||||
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
|
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
|
||||||
usage: docker compose up [SERVICE...]
|
usage: docker compose up [OPTIONS] [SERVICE...]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: abort-on-container-exit
|
- option: abort-on-container-exit
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -32,7 +32,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: always-recreate-deps
|
- option: always-recreate-deps
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Recreate dependent containers. Incompatible with --no-recreate.
|
description: Recreate dependent containers. Incompatible with --no-recreate.
|
||||||
|
@ -42,7 +42,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: attach
|
- option: attach
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
description: Attach to service output.
|
description: Attach to service output.
|
||||||
|
@ -52,7 +52,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: attach-dependencies
|
- option: attach-dependencies
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Attach to dependent containers.
|
description: Attach to dependent containers.
|
||||||
|
@ -62,7 +62,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: build
|
- option: build
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Build images before starting containers.
|
description: Build images before starting containers.
|
||||||
|
@ -72,7 +72,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: detach
|
- option: detach
|
||||||
shorthand: d
|
shorthand: d
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -83,7 +83,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: exit-code-from
|
- option: exit-code-from
|
||||||
value_type: string
|
value_type: string
|
||||||
description: |
|
description: |
|
||||||
Return the exit code of the selected service container. Implies --abort-on-container-exit
|
Return the exit code of the selected service container. Implies --abort-on-container-exit
|
||||||
|
@ -93,7 +93,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: force-recreate
|
- option: force-recreate
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -104,7 +104,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-build
|
- option: no-build
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't build an image, even if it's missing.
|
description: Don't build an image, even if it's missing.
|
||||||
|
@ -114,7 +114,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-color
|
- option: no-color
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Produce monochrome output.
|
description: Produce monochrome output.
|
||||||
|
@ -124,7 +124,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-deps
|
- option: no-deps
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't start linked services.
|
description: Don't start linked services.
|
||||||
|
@ -134,7 +134,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-log-prefix
|
- option: no-log-prefix
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't print prefix in logs.
|
description: Don't print prefix in logs.
|
||||||
|
@ -144,7 +144,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-recreate
|
- option: no-recreate
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: |
|
description: |
|
||||||
|
@ -155,7 +155,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: no-start
|
- option: no-start
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Don't start the services after creating them.
|
description: Don't start the services after creating them.
|
||||||
|
@ -165,7 +165,17 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: quiet-pull
|
- option: pull
|
||||||
|
value_type: string
|
||||||
|
default_value: missing
|
||||||
|
description: Pull image before running ("always"|"missing"|"never")
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: quiet-pull
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Pull without printing progress information.
|
description: Pull without printing progress information.
|
||||||
|
@ -175,7 +185,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: remove-orphans
|
- option: remove-orphans
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Remove containers for services not defined in the Compose file.
|
description: Remove containers for services not defined in the Compose file.
|
||||||
|
@ -185,7 +195,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: renew-anon-volumes
|
- option: renew-anon-volumes
|
||||||
shorthand: V
|
shorthand: V
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
|
@ -197,7 +207,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: scale
|
- option: scale
|
||||||
value_type: stringArray
|
value_type: stringArray
|
||||||
default_value: '[]'
|
default_value: '[]'
|
||||||
description: |
|
description: |
|
||||||
|
@ -208,7 +218,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: timeout
|
- option: timeout
|
||||||
shorthand: t
|
shorthand: t
|
||||||
value_type: int
|
value_type: int
|
||||||
default_value: "10"
|
default_value: "10"
|
||||||
|
@ -220,7 +230,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: wait
|
- option: wait
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Wait for services to be running|healthy. Implies detached mode.
|
description: Wait for services to be running|healthy. Implies detached mode.
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
command: docker compose version
|
command: docker compose version
|
||||||
short: Show the Docker Compose version information
|
short: Show the Docker Compose version information
|
||||||
long: Show the Docker Compose version information
|
long: Show the Docker Compose version information
|
||||||
usage: docker compose version
|
usage: docker compose version [OPTIONS]
|
||||||
pname: docker compose
|
pname: docker compose
|
||||||
plink: docker_compose.yaml
|
plink: docker_compose.yaml
|
||||||
options:
|
options:
|
||||||
- option: format
|
- option: format
|
||||||
shorthand: f
|
shorthand: f
|
||||||
value_type: string
|
value_type: string
|
||||||
description: 'Format the output. Values: [pretty | json]. (Default: pretty)'
|
description: 'Format the output. Values: [pretty | json]. (Default: pretty)'
|
||||||
|
@ -15,7 +15,7 @@ options:
|
||||||
experimentalcli: false
|
experimentalcli: false
|
||||||
kubernetes: false
|
kubernetes: false
|
||||||
swarm: false
|
swarm: false
|
||||||
- option: short
|
- option: short
|
||||||
value_type: bool
|
value_type: bool
|
||||||
default_value: "false"
|
default_value: "false"
|
||||||
description: Shows only Compose's version number.
|
description: Shows only Compose's version number.
|
||||||
|
|
Loading…
Reference in New Issue