From 52e7f0fb3ed1e594b80e87f3379f2275bc7c673f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 29 Dec 2022 09:06:01 +0000 Subject: [PATCH 1/2] build(deps): bump github.com/docker/cli-docs-tool from 0.5.0 to 0.5.1 Bumps [github.com/docker/cli-docs-tool](https://github.com/docker/cli-docs-tool) from 0.5.0 to 0.5.1. - [Release notes](https://github.com/docker/cli-docs-tool/releases) - [Commits](https://github.com/docker/cli-docs-tool/compare/v0.5.0...v0.5.1) --- updated-dependencies: - dependency-name: github.com/docker/cli-docs-tool dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 9b9ec7f0f4..c82c0564bb 100644 --- a/go.mod +++ b/go.mod @@ -11,7 +11,7 @@ require ( github.com/distribution/distribution/v3 v3.0.0-20221201083218-92d136e113cf github.com/docker/buildx v0.9.1 // when updating, also update the replace rules accordingly github.com/docker/cli v20.10.20+incompatible // replaced; see replace rule for actual version - github.com/docker/cli-docs-tool v0.5.0 + github.com/docker/cli-docs-tool v0.5.1 github.com/docker/docker v20.10.20+incompatible // replaced; see replace rule for actual version github.com/docker/go-connections v0.4.0 github.com/docker/go-units v0.5.0 diff --git a/go.sum b/go.sum index 5e2b4e75db..90eb73e189 100644 --- a/go.sum +++ b/go.sum @@ -161,8 +161,8 @@ github.com/docker/buildx v0.9.1 h1:VLyyJ1s4seWHmBY+oNc0J4+jHluRHLyv8KHOYYdSu3U= github.com/docker/buildx v0.9.1/go.mod h1:zHiKsXO4H8cgUQFaNCqitRroVta3Kj9TVzhMhe5GLlk= github.com/docker/cli v20.10.3-0.20221013132413-1d6c6e2367e2+incompatible h1:je9pK1shVhf561ujVYyn8ycOEfbgXFXryWxNqkYqsxg= github.com/docker/cli v20.10.3-0.20221013132413-1d6c6e2367e2+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -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/cli-docs-tool v0.5.1 h1:jIk/cCZurZERhALPVKhqlNxTQGxn2kcI+56gE57PQXg= +github.com/docker/cli-docs-tool v0.5.1/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/distribution v2.8.1+incompatible h1:Q50tZOPR6T/hjNsyc9g8/syEs6bk8XXApsHjKukMl68= github.com/docker/distribution v2.8.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= From 8a3248d0cdc145c677da2b3209c6654ce1470bbf Mon Sep 17 00:00:00 2001 From: Laura Brehm Date: Thu, 29 Dec 2022 13:32:16 +0000 Subject: [PATCH 2/2] Update documentation Signed-off-by: Laura Brehm --- docs/reference/compose.md | 75 +++++++++++++++---------------- docs/reference/compose_build.md | 16 +++---- docs/reference/compose_convert.md | 28 ++++++------ docs/reference/compose_cp.md | 10 ++--- docs/reference/compose_create.md | 14 +++--- docs/reference/compose_down.md | 12 ++--- docs/reference/compose_events.md | 6 +-- docs/reference/compose_exec.md | 18 ++++---- docs/reference/compose_images.md | 8 ++-- docs/reference/compose_kill.md | 8 ++-- docs/reference/compose_logs.md | 18 ++++---- docs/reference/compose_ls.md | 12 ++--- docs/reference/compose_port.md | 8 ++-- docs/reference/compose_ps.md | 16 +++---- docs/reference/compose_pull.md | 10 ++--- docs/reference/compose_push.md | 10 ++--- docs/reference/compose_restart.md | 6 +-- docs/reference/compose_rm.md | 10 ++--- docs/reference/compose_run.md | 38 ++++++++-------- docs/reference/compose_stop.md | 6 +-- docs/reference/compose_up.md | 48 ++++++++++---------- docs/reference/compose_version.md | 8 ++-- 22 files changed, 192 insertions(+), 193 deletions(-) diff --git a/docs/reference/compose.md b/docs/reference/compose.md index 27960628c9..f97cc2a91a 100644 --- a/docs/reference/compose.md +++ b/docs/reference/compose.md @@ -5,48 +5,47 @@ Docker Compose ### Subcommands -| Name | Description | -| --- | --- | -| [`build`](compose_build.md) | Build or rebuild services | -| [`convert`](compose_convert.md) | Converts the compose file to platform's canonical format | -| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | -| [`create`](compose_create.md) | Creates containers for a service. | -| [`down`](compose_down.md) | Stop and remove containers, networks | -| [`events`](compose_events.md) | Receive real time events from containers. | -| [`exec`](compose_exec.md) | Execute a command in a running container. | -| [`images`](compose_images.md) | List images used by the created containers | -| [`kill`](compose_kill.md) | Force stop service containers. | -| [`logs`](compose_logs.md) | View output from containers | -| [`ls`](compose_ls.md) | List running compose projects | -| [`pause`](compose_pause.md) | Pause services | -| [`port`](compose_port.md) | Print the public port for a port binding. | -| [`ps`](compose_ps.md) | List containers | -| [`pull`](compose_pull.md) | Pull service images | -| [`push`](compose_push.md) | Push service images | -| [`restart`](compose_restart.md) | Restart service containers | -| [`rm`](compose_rm.md) | Removes stopped service containers | -| [`run`](compose_run.md) | Run a one-off command on a service. | -| [`start`](compose_start.md) | Start services | -| [`stop`](compose_stop.md) | Stop services | -| [`top`](compose_top.md) | Display the running processes | -| [`unpause`](compose_unpause.md) | Unpause services | -| [`up`](compose_up.md) | Create and start containers | -| [`version`](compose_version.md) | Show the Docker Compose version information | +| Name | Description | +|:--------------------------------|:------------------------------------------------------------------------| +| [`build`](compose_build.md) | Build or rebuild services | +| [`convert`](compose_convert.md) | Converts the compose file to platform's canonical format | +| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | +| [`create`](compose_create.md) | Creates containers for a service. | +| [`down`](compose_down.md) | Stop and remove containers, networks | +| [`events`](compose_events.md) | Receive real time events from containers. | +| [`exec`](compose_exec.md) | Execute a command in a running container. | +| [`images`](compose_images.md) | List images used by the created containers | +| [`kill`](compose_kill.md) | Force stop service containers. | +| [`logs`](compose_logs.md) | View output from containers | +| [`ls`](compose_ls.md) | List running compose projects | +| [`pause`](compose_pause.md) | Pause services | +| [`port`](compose_port.md) | Print the public port for a port binding. | +| [`ps`](compose_ps.md) | List containers | +| [`pull`](compose_pull.md) | Pull service images | +| [`push`](compose_push.md) | Push service images | +| [`restart`](compose_restart.md) | Restart service containers | +| [`rm`](compose_rm.md) | Removes stopped service containers | +| [`run`](compose_run.md) | Run a one-off command on a service. | +| [`start`](compose_start.md) | Start services | +| [`stop`](compose_stop.md) | Stop services | +| [`top`](compose_top.md) | Display the running processes | +| [`unpause`](compose_unpause.md) | Unpause services | +| [`up`](compose_up.md) | Create and start containers | +| [`version`](compose_version.md) | Show the Docker Compose version information | ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") | -| `--compatibility` | | | Run compose in backward compatibility mode | -| `--env-file` | `string` | | Specify an alternate environment file. | -| `-f`, `--file` | `stringArray` | | Compose configuration files | -| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited | -| `--profile` | `stringArray` | | Specify a profile to enable | -| `--project-directory` | `string` | | Specify an alternate working directory -(default: the path of the, first specified, Compose file) | -| `-p`, `--project-name` | `string` | | Project name | +| Name | Type | Default | Description | +|:-----------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------| +| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") | +| `--compatibility` | | | Run compose in backward compatibility mode | +| `--env-file` | `string` | | Specify an alternate environment file. | +| `-f`, `--file` | `stringArray` | | Compose configuration files | +| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited | +| `--profile` | `stringArray` | | Specify a profile to enable | +| `--project-directory` | `string` | | Specify an alternate working directory
(default: the path of the, first specified, Compose file) | +| `-p`, `--project-name` | `string` | | Project name | diff --git a/docs/reference/compose_build.md b/docs/reference/compose_build.md index 292df454d2..4437a133eb 100644 --- a/docs/reference/compose_build.md +++ b/docs/reference/compose_build.md @@ -5,14 +5,14 @@ Build or rebuild services ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--build-arg` | `stringArray` | | Set build-time variables for services. | -| `--no-cache` | | | Do not use cache when building the image | -| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) | -| `--pull` | | | Always attempt to pull a newer version of the image. | -| `-q`, `--quiet` | | | Don't print anything to STDOUT | -| `--ssh` | `string` | | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) | +| Name | Type | Default | Description | +|:----------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------| +| `--build-arg` | `stringArray` | | Set build-time variables for services. | +| `--no-cache` | | | Do not use cache when building the image | +| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) | +| `--pull` | | | Always attempt to pull a newer version of the image. | +| `-q`, `--quiet` | | | Don't print anything to STDOUT | +| `--ssh` | `string` | | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) | diff --git a/docs/reference/compose_convert.md b/docs/reference/compose_convert.md index 9688647d90..3d3831721d 100644 --- a/docs/reference/compose_convert.md +++ b/docs/reference/compose_convert.md @@ -9,20 +9,20 @@ Converts the compose file to platform's canonical format ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | -| `--hash` | `string` | | Print the service config hash, one per line. | -| `--images` | | | Print the image names, one per line. | -| `--no-consistency` | | | Don't check model consistency - warning: may produce invalid Compose output | -| `--no-interpolate` | | | Don't interpolate environment variables. | -| `--no-normalize` | | | Don't normalize compose model. | -| `-o`, `--output` | `string` | | Save to file (default to stdout) | -| `--profiles` | | | Print the profile names, one per line. | -| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. | -| `--resolve-image-digests` | | | Pin image tags to digests. | -| `--services` | | | Print the service names, one per line. | -| `--volumes` | | | Print the volume names, one per line. | +| Name | Type | Default | Description | +|:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| +| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | +| `--hash` | `string` | | Print the service config hash, one per line. | +| `--images` | | | Print the image names, one per line. | +| `--no-consistency` | | | Don't check model consistency - warning: may produce invalid Compose output | +| `--no-interpolate` | | | Don't interpolate environment variables. | +| `--no-normalize` | | | Don't normalize compose model. | +| `-o`, `--output` | `string` | | Save to file (default to stdout) | +| `--profiles` | | | Print the profile names, one per line. | +| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. | +| `--resolve-image-digests` | | | Pin image tags to digests. | +| `--services` | | | Print the service names, one per line. | +| `--volumes` | | | Print the volume names, one per line. | diff --git a/docs/reference/compose_cp.md b/docs/reference/compose_cp.md index dd9a02e6b0..210a050bf6 100644 --- a/docs/reference/compose_cp.md +++ b/docs/reference/compose_cp.md @@ -5,11 +5,11 @@ Copy files/folders between a service container and the local filesystem ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | -| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | -| `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . | +| Name | Type | Default | Description | +|:----------------------|:------|:--------|:----------------------------------------------------------------------| +| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | +| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | +| `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . | diff --git a/docs/reference/compose_create.md b/docs/reference/compose_create.md index 843d4235b6..8b6e8d525e 100644 --- a/docs/reference/compose_create.md +++ b/docs/reference/compose_create.md @@ -5,13 +5,13 @@ Creates containers for a service. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--build` | | | Build images before starting containers. | -| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | -| `--no-build` | | | Don't build an image, even if it's missing. | -| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") | +| Name | Type | Default | Description | +|:-------------------|:---------|:----------|:--------------------------------------------------------------------------------------| +| `--build` | | | Build images before starting containers. | +| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | +| `--no-build` | | | Don't build an image, even if it's missing. | +| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | +| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") | diff --git a/docs/reference/compose_down.md b/docs/reference/compose_down.md index 2dd5f2f2c7..4cd2301117 100644 --- a/docs/reference/compose_down.md +++ b/docs/reference/compose_down.md @@ -5,12 +5,12 @@ Stop and remove containers, networks ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | -| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | -| `-v`, `--volumes` | | | Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. | +| Name | Type | Default | Description | +|:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------| +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | +| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | +| `-v`, `--volumes` | | | Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. | diff --git a/docs/reference/compose_events.md b/docs/reference/compose_events.md index 496d204e3b..d9ff7cd980 100644 --- a/docs/reference/compose_events.md +++ b/docs/reference/compose_events.md @@ -5,9 +5,9 @@ Receive real time events from containers. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--json` | | | Output events as a stream of json objects | +| Name | Type | Default | Description | +|:---------|:-----|:--------|:------------------------------------------| +| `--json` | | | Output events as a stream of json objects | diff --git a/docs/reference/compose_exec.md b/docs/reference/compose_exec.md index b9f5ae2d50..7eca980fa1 100644 --- a/docs/reference/compose_exec.md +++ b/docs/reference/compose_exec.md @@ -5,15 +5,15 @@ Execute a command in a running container. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-d`, `--detach` | | | Detached mode: Run command in the background. | -| `-e`, `--env` | `stringArray` | | Set environment variables | -| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. | -| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | -| `--privileged` | | | Give extended privileges to the process. | -| `-u`, `--user` | `string` | | Run the command as this user. | -| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | +| Name | Type | Default | Description | +|:------------------|:--------------|:--------|:----------------------------------------------------------------------------------| +| `-d`, `--detach` | | | Detached mode: Run command in the background. | +| `-e`, `--env` | `stringArray` | | Set environment variables | +| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. | +| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | +| `--privileged` | | | Give extended privileges to the process. | +| `-u`, `--user` | `string` | | Run the command as this user. | +| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | diff --git a/docs/reference/compose_images.md b/docs/reference/compose_images.md index 4b103bd7f5..59568dc5c3 100644 --- a/docs/reference/compose_images.md +++ b/docs/reference/compose_images.md @@ -5,10 +5,10 @@ List images used by the created containers ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | -| `-q`, `--quiet` | | | Only display IDs | +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:--------------------------------------------| +| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | +| `-q`, `--quiet` | | | Only display IDs | diff --git a/docs/reference/compose_kill.md b/docs/reference/compose_kill.md index 35c613507e..aebae7c19f 100644 --- a/docs/reference/compose_kill.md +++ b/docs/reference/compose_kill.md @@ -5,10 +5,10 @@ Force stop service containers. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. | +| Name | Type | Default | Description | +|:-------------------|:---------|:----------|:----------------------------------------------------------------| +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. | diff --git a/docs/reference/compose_logs.md b/docs/reference/compose_logs.md index 4f9690a7e2..feb9180479 100644 --- a/docs/reference/compose_logs.md +++ b/docs/reference/compose_logs.md @@ -5,15 +5,15 @@ View output from containers ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-f`, `--follow` | | | Follow log output. | -| `--no-color` | | | Produce monochrome output. | -| `--no-log-prefix` | | | Don't print prefix in logs. | -| `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | -| `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container. | -| `-t`, `--timestamps` | | | Show timestamps. | -| `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | +| Name | Type | Default | Description | +|:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------| +| `-f`, `--follow` | | | Follow log output. | +| `--no-color` | | | Produce monochrome output. | +| `--no-log-prefix` | | | Don't print prefix in logs. | +| `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | +| `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container. | +| `-t`, `--timestamps` | | | Show timestamps. | +| `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | diff --git a/docs/reference/compose_ls.md b/docs/reference/compose_ls.md index d99eaa0fc5..0cb9c076dd 100644 --- a/docs/reference/compose_ls.md +++ b/docs/reference/compose_ls.md @@ -5,12 +5,12 @@ List running compose projects ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-a`, `--all` | | | Show all stopped Compose projects | -| `--filter` | `filter` | | Filter output based on conditions provided. | -| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | -| `-q`, `--quiet` | | | Only display IDs. | +| Name | Type | Default | Description | +|:----------------|:---------|:--------|:--------------------------------------------| +| `-a`, `--all` | | | Show all stopped Compose projects | +| `--filter` | `filter` | | Filter output based on conditions provided. | +| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | +| `-q`, `--quiet` | | | Only display IDs. | diff --git a/docs/reference/compose_port.md b/docs/reference/compose_port.md index 8ab893f0d5..0eeeb0ddc4 100644 --- a/docs/reference/compose_port.md +++ b/docs/reference/compose_port.md @@ -5,10 +5,10 @@ Print the public port for a port binding. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--index` | `int` | `1` | index of the container if service has multiple replicas | -| `--protocol` | `string` | `tcp` | tcp or udp | +| Name | Type | Default | Description | +|:-------------|:---------|:--------|:--------------------------------------------------------| +| `--index` | `int` | `1` | index of the container if service has multiple replicas | +| `--protocol` | `string` | `tcp` | tcp or udp | diff --git a/docs/reference/compose_ps.md b/docs/reference/compose_ps.md index 5a4ff5626b..4d9612fe52 100644 --- a/docs/reference/compose_ps.md +++ b/docs/reference/compose_ps.md @@ -5,14 +5,14 @@ List containers ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-a`, `--all` | | | Show all stopped containers (including those created by the run command) | -| [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status). | -| [`--format`](#format) | `string` | `table` | Format the output. Values: [table \| json] | -| `-q`, `--quiet` | | | Only display IDs | -| `--services` | | | Display services | -| [`--status`](#status) | `stringArray` | | Filter services by status. Values: [paused \| restarting \| removing \| running \| dead \| created \| exited] | +| Name | Type | Default | Description | +|:----------------------|:--------------|:--------|:--------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | | | Show all stopped containers (including those created by the run command) | +| [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status). | +| [`--format`](#format) | `string` | `table` | Format the output. Values: [table \| json] | +| `-q`, `--quiet` | | | Only display IDs | +| `--services` | | | Display services | +| [`--status`](#status) | `stringArray` | | Filter services by status. Values: [paused \| restarting \| removing \| running \| dead \| created \| exited] | diff --git a/docs/reference/compose_pull.md b/docs/reference/compose_pull.md index edc3a155f8..cd5f08e71c 100644 --- a/docs/reference/compose_pull.md +++ b/docs/reference/compose_pull.md @@ -5,11 +5,11 @@ Pull service images ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures | -| `--include-deps` | | | Also pull services declared as dependencies | -| `-q`, `--quiet` | | | Pull without printing progress information | +| Name | Type | Default | Description | +|:-------------------------|:-----|:--------|:-------------------------------------------------------| +| `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures | +| `--include-deps` | | | Also pull services declared as dependencies | +| `-q`, `--quiet` | | | Pull without printing progress information | diff --git a/docs/reference/compose_push.md b/docs/reference/compose_push.md index e5df84338f..6c88968130 100644 --- a/docs/reference/compose_push.md +++ b/docs/reference/compose_push.md @@ -5,11 +5,11 @@ Push service images ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--ignore-push-failures` | | | Push what it can and ignores images with push failures | -| `--include-deps` | | | Also push images of services declared as dependencies | -| `-q`, `--quiet` | | | Push without printing progress information | +| Name | Type | Default | Description | +|:-------------------------|:-----|:--------|:-------------------------------------------------------| +| `--ignore-push-failures` | | | Push what it can and ignores images with push failures | +| `--include-deps` | | | Also push images of services declared as dependencies | +| `-q`, `--quiet` | | | Push without printing progress information | diff --git a/docs/reference/compose_restart.md b/docs/reference/compose_restart.md index cc152b5620..b561b5447f 100644 --- a/docs/reference/compose_restart.md +++ b/docs/reference/compose_restart.md @@ -5,9 +5,9 @@ Restart service containers ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | +| Name | Type | Default | Description | +|:------------------|:------|:--------|:--------------------------------------| +| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | diff --git a/docs/reference/compose_rm.md b/docs/reference/compose_rm.md index 017c7f1229..c0ad6c8880 100644 --- a/docs/reference/compose_rm.md +++ b/docs/reference/compose_rm.md @@ -10,11 +10,11 @@ Any data which is not in a volume will be lost. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-f`, `--force` | | | Don't ask to confirm removal | -| `-s`, `--stop` | | | Stop the containers, if required, before removing | -| `-v`, `--volumes` | | | Remove any anonymous volumes attached to containers | +| Name | Type | Default | Description | +|:------------------|:-----|:--------|:----------------------------------------------------| +| `-f`, `--force` | | | Don't ask to confirm removal | +| `-s`, `--stop` | | | Stop the containers, if required, before removing | +| `-v`, `--volumes` | | | Remove any anonymous volumes attached to containers | diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md index af8f135d54..a870a90677 100644 --- a/docs/reference/compose_run.md +++ b/docs/reference/compose_run.md @@ -5,25 +5,25 @@ Run a one-off command on a service. ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--build` | | | Build image before starting container. | -| `-d`, `--detach` | | | Run container in background and print container ID | -| `--entrypoint` | `string` | | Override the entrypoint of the image | -| `-e`, `--env` | `stringArray` | | Set environment variables | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached. | -| `-l`, `--label` | `stringArray` | | Add or override a label | -| `--name` | `string` | | Assign a name to the container | -| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). | -| `--no-deps` | | | Don't start linked services. | -| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. | -| `--quiet-pull` | | | Pull without printing progress information. | -| `--rm` | | | Automatically remove the container when it exits | -| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host. | -| `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | -| `-u`, `--user` | `string` | | Run as specified username or uid | -| `-v`, `--volume` | `stringArray` | | Bind mount a volume. | -| `-w`, `--workdir` | `string` | | Working directory inside the container | +| Name | Type | Default | Description | +|:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------| +| `--build` | | | Build image before starting container. | +| `-d`, `--detach` | | | Run container in background and print container ID | +| `--entrypoint` | `string` | | Override the entrypoint of the image | +| `-e`, `--env` | `stringArray` | | Set environment variables | +| `-i`, `--interactive` | | | Keep STDIN open even if not attached. | +| `-l`, `--label` | `stringArray` | | Add or override a label | +| `--name` | `string` | | Assign a name to the container | +| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). | +| `--no-deps` | | | Don't start linked services. | +| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. | +| `--quiet-pull` | | | Pull without printing progress information. | +| `--rm` | | | Automatically remove the container when it exits | +| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host. | +| `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | +| `-u`, `--user` | `string` | | Run as specified username or uid | +| `-v`, `--volume` | `stringArray` | | Bind mount a volume. | +| `-w`, `--workdir` | `string` | | Working directory inside the container | diff --git a/docs/reference/compose_stop.md b/docs/reference/compose_stop.md index 9d8ead8236..04275449d8 100644 --- a/docs/reference/compose_stop.md +++ b/docs/reference/compose_stop.md @@ -5,9 +5,9 @@ Stop services ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | +| Name | Type | Default | Description | +|:------------------|:------|:--------|:--------------------------------------| +| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | diff --git a/docs/reference/compose_up.md b/docs/reference/compose_up.md index 3328183b34..ba8f82a793 100644 --- a/docs/reference/compose_up.md +++ b/docs/reference/compose_up.md @@ -5,30 +5,30 @@ Create and start containers ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | -| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | -| `--attach` | `stringArray` | | Attach to service output. | -| `--attach-dependencies` | | | Attach to dependent containers. | -| `--build` | | | Build images before starting containers. | -| `-d`, `--detach` | | | Detached mode: Run containers in the background | -| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | -| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | -| `--no-build` | | | Don't build an image, even if it's missing. | -| `--no-color` | | | Produce monochrome output. | -| `--no-deps` | | | Don't start linked services. | -| `--no-log-prefix` | | | Don't print prefix in logs. | -| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | -| `--no-start` | | | Don't start the services after creating them. | -| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") | -| `--quiet-pull` | | | Pull without printing progress information. | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | -| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers. | -| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | -| `-t`, `--timeout` | `int` | `10` | Use this timeout in seconds for container shutdown when attached or when containers are already running. | -| `--timestamps` | | | Show timestamps. | -| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | +| Name | Type | Default | Description | +|:-----------------------------|:--------------|:----------|:---------------------------------------------------------------------------------------------------------| +| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | +| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | +| `--attach` | `stringArray` | | Attach to service output. | +| `--attach-dependencies` | | | Attach to dependent containers. | +| `--build` | | | Build images before starting containers. | +| `-d`, `--detach` | | | Detached mode: Run containers in the background | +| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit | +| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | +| `--no-build` | | | Don't build an image, even if it's missing. | +| `--no-color` | | | Produce monochrome output. | +| `--no-deps` | | | Don't start linked services. | +| `--no-log-prefix` | | | Don't print prefix in logs. | +| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | +| `--no-start` | | | Don't start the services after creating them. | +| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") | +| `--quiet-pull` | | | Pull without printing progress information. | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | +| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers. | +| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | +| `-t`, `--timeout` | `int` | `10` | Use this timeout in seconds for container shutdown when attached or when containers are already running. | +| `--timestamps` | | | Show timestamps. | +| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | diff --git a/docs/reference/compose_version.md b/docs/reference/compose_version.md index 94b2d36dcd..9706b3850e 100644 --- a/docs/reference/compose_version.md +++ b/docs/reference/compose_version.md @@ -5,10 +5,10 @@ Show the Docker Compose version information ### Options -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) | -| `--short` | | | Shows only Compose's version number. | +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:---------------------------------------------------------------| +| `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) | +| `--short` | | | Shows only Compose's version number. |