Skip to content

Commit 1d9657a

Browse files
laurazardlaurazard
authored
Merge pull request docker#10127 from docker/dependabot/go_modules/github.com/docker/cli-docs-tool-0.5.1
build(deps): bump github.com/docker/cli-docs-tool from 0.5.0 to 0.5.1
2 parents fd353ff + 8a3248d commit 1d9657a

24 files changed

+195
-196
lines changed

‎docs/reference/compose.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,47 @@ Docker Compose
55

66
### Subcommands
77

8-
| Name | Description |
9-
| --- | --- |
10-
| [`build`](compose_build.md) | Build or rebuild services |
11-
| [`convert`](compose_convert.md) | Converts the compose file to platform's canonical format |
12-
| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem |
13-
| [`create`](compose_create.md) | Creates containers for a service. |
14-
| [`down`](compose_down.md) | Stop and remove containers, networks |
15-
| [`events`](compose_events.md) | Receive real time events from containers. |
16-
| [`exec`](compose_exec.md) | Execute a command in a running container. |
17-
| [`images`](compose_images.md) | List images used by the created containers |
18-
| [`kill`](compose_kill.md) | Force stop service containers. |
19-
| [`logs`](compose_logs.md) | View output from containers |
20-
| [`ls`](compose_ls.md) | List running compose projects |
21-
| [`pause`](compose_pause.md) | Pause services |
22-
| [`port`](compose_port.md) | Print the public port for a port binding. |
23-
| [`ps`](compose_ps.md) | List containers |
24-
| [`pull`](compose_pull.md) | Pull service images |
25-
| [`push`](compose_push.md) | Push service images |
26-
| [`restart`](compose_restart.md) | Restart service containers |
27-
| [`rm`](compose_rm.md) | Removes stopped service containers |
28-
| [`run`](compose_run.md) | Run a one-off command on a service. |
29-
| [`start`](compose_start.md) | Start services |
30-
| [`stop`](compose_stop.md) | Stop services |
31-
| [`top`](compose_top.md) | Display the running processes |
32-
| [`unpause`](compose_unpause.md) | Unpause services |
33-
| [`up`](compose_up.md) | Create and start containers |
34-
| [`version`](compose_version.md) | Show the Docker Compose version information |
8+
| Name | Description |
9+
|:--------------------------------|:------------------------------------------------------------------------|
10+
| [`build`](compose_build.md) | Build or rebuild services |
11+
| [`convert`](compose_convert.md) | Converts the compose file to platform's canonical format |
12+
| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem |
13+
| [`create`](compose_create.md) | Creates containers for a service. |
14+
| [`down`](compose_down.md) | Stop and remove containers, networks |
15+
| [`events`](compose_events.md) | Receive real time events from containers. |
16+
| [`exec`](compose_exec.md) | Execute a command in a running container. |
17+
| [`images`](compose_images.md) | List images used by the created containers |
18+
| [`kill`](compose_kill.md) | Force stop service containers. |
19+
| [`logs`](compose_logs.md) | View output from containers |
20+
| [`ls`](compose_ls.md) | List running compose projects |
21+
| [`pause`](compose_pause.md) | Pause services |
22+
| [`port`](compose_port.md) | Print the public port for a port binding. |
23+
| [`ps`](compose_ps.md) | List containers |
24+
| [`pull`](compose_pull.md) | Pull service images |
25+
| [`push`](compose_push.md) | Push service images |
26+
| [`restart`](compose_restart.md) | Restart service containers |
27+
| [`rm`](compose_rm.md) | Removes stopped service containers |
28+
| [`run`](compose_run.md) | Run a one-off command on a service. |
29+
| [`start`](compose_start.md) | Start services |
30+
| [`stop`](compose_stop.md) | Stop services |
31+
| [`top`](compose_top.md) | Display the running processes |
32+
| [`unpause`](compose_unpause.md) | Unpause services |
33+
| [`up`](compose_up.md) | Create and start containers |
34+
| [`version`](compose_version.md) | Show the Docker Compose version information |
3535

3636

3737
### Options
3838

39-
| Name | Type | Default | Description |
40-
| --- | --- | --- | --- |
41-
| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") |
42-
| `--compatibility` | | | Run compose in backward compatibility mode |
43-
| `--env-file` | `string` | | Specify an alternate environment file. |
44-
| `-f`, `--file` | `stringArray` | | Compose configuration files |
45-
| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited |
46-
| `--profile` | `stringArray` | | Specify a profile to enable |
47-
| `--project-directory` | `string` | | Specify an alternate working directory
48-
(default: the path of the, first specified, Compose file) |
49-
| `-p`, `--project-name` | `string` | | Project name |
39+
| Name | Type | Default | Description |
40+
|:-----------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------|
41+
| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") |
42+
| `--compatibility` | | | Run compose in backward compatibility mode |
43+
| `--env-file` | `string` | | Specify an alternate environment file. |
44+
| `-f`, `--file` | `stringArray` | | Compose configuration files |
45+
| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited |
46+
| `--profile` | `stringArray` | | Specify a profile to enable |
47+
| `--project-directory` | `string` | | Specify an alternate working directory<br>(default: the path of the, first specified, Compose file) |
48+
| `-p`, `--project-name` | `string` | | Project name |
5049

5150

5251
<!---MARKER_GEN_END-->

‎docs/reference/compose_build.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Build or rebuild services
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `--build-arg` | `stringArray` | | Set build-time variables for services. |
11-
| `--no-cache` | | | Do not use cache when building the image |
12-
| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) |
13-
| `--pull` | | | Always attempt to pull a newer version of the image. |
14-
| `-q`, `--quiet` | | | Don't print anything to STDOUT |
15-
| `--ssh` | `string` | | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) |
8+
| Name | Type | Default | Description |
9+
|:----------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------|
10+
| `--build-arg` | `stringArray` | | Set build-time variables for services. |
11+
| `--no-cache` | | | Do not use cache when building the image |
12+
| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) |
13+
| `--pull` | | | Always attempt to pull a newer version of the image. |
14+
| `-q`, `--quiet` | | | Don't print anything to STDOUT |
15+
| `--ssh` | `string` | | Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) |
1616

1717

1818
<!---MARKER_GEN_END-->

‎docs/reference/compose_convert.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ Converts the compose file to platform's canonical format
99

1010
### Options
1111

12-
| Name | Type | Default | Description |
13-
| --- | --- | --- | --- |
14-
| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] |
15-
| `--hash` | `string` | | Print the service config hash, one per line. |
16-
| `--images` | | | Print the image names, one per line. |
17-
| `--no-consistency` | | | Don't check model consistency - warning: may produce invalid Compose output |
18-
| `--no-interpolate` | | | Don't interpolate environment variables. |
19-
| `--no-normalize` | | | Don't normalize compose model. |
20-
| `-o`, `--output` | `string` | | Save to file (default to stdout) |
21-
| `--profiles` | | | Print the profile names, one per line. |
22-
| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. |
23-
| `--resolve-image-digests` | | | Pin image tags to digests. |
24-
| `--services` | | | Print the service names, one per line. |
25-
| `--volumes` | | | Print the volume names, one per line. |
12+
| Name | Type | Default | Description |
13+
|:--------------------------|:---------|:--------|:----------------------------------------------------------------------------|
14+
| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] |
15+
| `--hash` | `string` | | Print the service config hash, one per line. |
16+
| `--images` | | | Print the image names, one per line. |
17+
| `--no-consistency` | | | Don't check model consistency - warning: may produce invalid Compose output |
18+
| `--no-interpolate` | | | Don't interpolate environment variables. |
19+
| `--no-normalize` | | | Don't normalize compose model. |
20+
| `-o`, `--output` | `string` | | Save to file (default to stdout) |
21+
| `--profiles` | | | Print the profile names, one per line. |
22+
| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. |
23+
| `--resolve-image-digests` | | | Pin image tags to digests. |
24+
| `--services` | | | Print the service names, one per line. |
25+
| `--volumes` | | | Print the volume names, one per line. |
2626

2727

2828
<!---MARKER_GEN_END-->

‎docs/reference/compose_cp.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Copy files/folders between a service container and the local filesystem
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
11-
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
12-
| `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . |
8+
| Name | Type | Default | Description |
9+
|:----------------------|:------|:--------|:----------------------------------------------------------------------|
10+
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
11+
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
12+
| `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . |
1313

1414

1515
<!---MARKER_GEN_END-->

‎docs/reference/compose_create.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Creates containers for a service.
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `--build` | | | Build images before starting containers. |
11-
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. |
12-
| `--no-build` | | | Don't build an image, even if it's missing. |
13-
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
14-
| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") |
8+
| Name | Type | Default | Description |
9+
|:-------------------|:---------|:----------|:--------------------------------------------------------------------------------------|
10+
| `--build` | | | Build images before starting containers. |
11+
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. |
12+
| `--no-build` | | | Don't build an image, even if it's missing. |
13+
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
14+
| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") |
1515

1616

1717
<!---MARKER_GEN_END-->

‎docs/reference/compose_down.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Stop and remove containers, networks
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
11-
| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") |
12-
| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds |
13-
| `-v`, `--volumes` | | | Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. |
8+
| Name | Type | Default | Description |
9+
|:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------|
10+
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
11+
| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") |
12+
| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds |
13+
| `-v`, `--volumes` | | | Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. |
1414

1515

1616
<!---MARKER_GEN_END-->

‎docs/reference/compose_events.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Receive real time events from containers.
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `--json` | | | Output events as a stream of json objects |
8+
| Name | Type | Default | Description |
9+
|:---------|:-----|:--------|:------------------------------------------|
10+
| `--json` | | | Output events as a stream of json objects |
1111

1212

1313
<!---MARKER_GEN_END-->

‎docs/reference/compose_exec.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Execute a command in a running container.
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `-d`, `--detach` | | | Detached mode: Run command in the background. |
11-
| `-e`, `--env` | `stringArray` | | Set environment variables |
12-
| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. |
13-
| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. |
14-
| `--privileged` | | | Give extended privileges to the process. |
15-
| `-u`, `--user` | `string` | | Run the command as this user. |
16-
| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. |
8+
| Name | Type | Default | Description |
9+
|:------------------|:--------------|:--------|:----------------------------------------------------------------------------------|
10+
| `-d`, `--detach` | | | Detached mode: Run command in the background. |
11+
| `-e`, `--env` | `stringArray` | | Set environment variables |
12+
| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. |
13+
| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. |
14+
| `--privileged` | | | Give extended privileges to the process. |
15+
| `-u`, `--user` | `string` | | Run the command as this user. |
16+
| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. |
1717

1818

1919
<!---MARKER_GEN_END-->

‎docs/reference/compose_images.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ List images used by the created containers
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `--format` | `string` | `table` | Format the output. Values: [table \| json]. |
11-
| `-q`, `--quiet` | | | Only display IDs |
8+
| Name | Type | Default | Description |
9+
|:----------------|:---------|:--------|:--------------------------------------------|
10+
| `--format` | `string` | `table` | Format the output. Values: [table \| json]. |
11+
| `-q`, `--quiet` | | | Only display IDs |
1212

1313

1414
<!---MARKER_GEN_END-->

‎docs/reference/compose_kill.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Force stop service containers.
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
| --- | --- | --- | --- |
10-
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
11-
| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. |
8+
| Name | Type | Default | Description |
9+
|:-------------------|:---------|:----------|:----------------------------------------------------------------|
10+
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
11+
| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. |
1212

1313

1414
<!---MARKER_GEN_END-->

0 commit comments

Comments
 (0)