From dc22572e3ebee23b2a1435141217ff55b492f1ca Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 3 Jul 2024 08:29:57 +0200 Subject: [PATCH] chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/reference/commandline/attach.md | 2 +- docs/reference/commandline/build.md | 12 +++++----- docs/reference/commandline/builder_build.md | 12 +++++----- docs/reference/commandline/builder_prune.md | 4 ++-- .../commandline/checkpoint_create.md | 2 +- docs/reference/commandline/config_inspect.md | 2 +- docs/reference/commandline/config_ls.md | 2 +- .../reference/commandline/container_attach.md | 2 +- docs/reference/commandline/container_cp.md | 10 ++++---- .../reference/commandline/container_create.md | 22 ++++++++--------- docs/reference/commandline/container_exec.md | 8 +++---- .../commandline/container_inspect.md | 2 +- docs/reference/commandline/container_logs.md | 6 ++--- docs/reference/commandline/container_ls.md | 10 ++++---- docs/reference/commandline/container_prune.md | 2 +- docs/reference/commandline/container_rm.md | 10 ++++---- docs/reference/commandline/container_run.md | 24 +++++++++---------- docs/reference/commandline/container_start.md | 4 ++-- docs/reference/commandline/container_stats.md | 6 ++--- docs/reference/commandline/context_ls.md | 2 +- docs/reference/commandline/context_rm.md | 6 ++--- docs/reference/commandline/cp.md | 10 ++++---- docs/reference/commandline/create.md | 22 ++++++++--------- docs/reference/commandline/docker.md | 6 ++--- docs/reference/commandline/exec.md | 8 +++---- docs/reference/commandline/history.md | 4 ++-- docs/reference/commandline/image_build.md | 12 +++++----- docs/reference/commandline/image_history.md | 4 ++-- docs/reference/commandline/image_load.md | 2 +- docs/reference/commandline/image_ls.md | 8 +++---- docs/reference/commandline/image_prune.md | 4 ++-- docs/reference/commandline/image_pull.md | 4 ++-- docs/reference/commandline/image_push.md | 4 ++-- docs/reference/commandline/image_rm.md | 8 +++---- docs/reference/commandline/images.md | 8 +++---- docs/reference/commandline/inspect.md | 2 +- docs/reference/commandline/load.md | 2 +- docs/reference/commandline/login.md | 2 +- docs/reference/commandline/logs.md | 6 ++--- docs/reference/commandline/manifest_create.md | 8 +++---- .../reference/commandline/manifest_inspect.md | 8 +++---- docs/reference/commandline/manifest_push.md | 8 +++---- docs/reference/commandline/network_create.md | 10 ++++---- .../commandline/network_disconnect.md | 6 ++--- docs/reference/commandline/network_inspect.md | 2 +- docs/reference/commandline/network_ls.md | 4 ++-- docs/reference/commandline/network_prune.md | 2 +- docs/reference/commandline/network_rm.md | 6 ++--- docs/reference/commandline/node_inspect.md | 2 +- docs/reference/commandline/node_ls.md | 2 +- docs/reference/commandline/node_ps.md | 6 ++--- docs/reference/commandline/node_rm.md | 6 ++--- docs/reference/commandline/plugin_create.md | 6 ++--- docs/reference/commandline/plugin_disable.md | 6 ++--- docs/reference/commandline/plugin_install.md | 4 ++-- docs/reference/commandline/plugin_ls.md | 4 ++-- docs/reference/commandline/plugin_rm.md | 6 ++--- docs/reference/commandline/plugin_upgrade.md | 4 ++-- docs/reference/commandline/ps.md | 10 ++++---- docs/reference/commandline/pull.md | 4 ++-- docs/reference/commandline/push.md | 4 ++-- docs/reference/commandline/rm.md | 10 ++++---- docs/reference/commandline/rmi.md | 8 +++---- docs/reference/commandline/run.md | 24 +++++++++---------- docs/reference/commandline/search.md | 2 +- docs/reference/commandline/secret_inspect.md | 2 +- docs/reference/commandline/secret_ls.md | 2 +- docs/reference/commandline/service_create.md | 16 ++++++------- docs/reference/commandline/service_inspect.md | 2 +- docs/reference/commandline/service_logs.md | 14 +++++------ docs/reference/commandline/service_ls.md | 2 +- docs/reference/commandline/service_ps.md | 6 ++--- .../reference/commandline/service_rollback.md | 8 +++---- docs/reference/commandline/service_scale.md | 6 ++--- docs/reference/commandline/service_update.md | 20 ++++++++-------- docs/reference/commandline/stack_config.md | 2 +- docs/reference/commandline/stack_deploy.md | 6 ++--- docs/reference/commandline/stack_ps.md | 6 ++--- docs/reference/commandline/stack_services.md | 2 +- docs/reference/commandline/start.md | 4 ++-- docs/reference/commandline/stats.md | 6 ++--- docs/reference/commandline/swarm_ca.md | 6 ++--- docs/reference/commandline/swarm_init.md | 4 ++-- .../reference/commandline/swarm_join-token.md | 8 +++---- docs/reference/commandline/swarm_leave.md | 6 ++--- .../reference/commandline/swarm_unlock-key.md | 8 +++---- docs/reference/commandline/swarm_update.md | 2 +- docs/reference/commandline/system_df.md | 2 +- docs/reference/commandline/system_prune.md | 6 ++--- docs/reference/commandline/trust_inspect.md | 6 ++--- docs/reference/commandline/trust_revoke.md | 6 ++--- docs/reference/commandline/trust_sign.md | 6 ++--- .../commandline/trust_signer_remove.md | 6 ++--- docs/reference/commandline/volume_ls.md | 4 ++-- docs/reference/commandline/volume_prune.md | 4 ++-- docs/reference/commandline/volume_rm.md | 6 ++--- 96 files changed, 306 insertions(+), 306 deletions(-) diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md index 3a89574075b9..09ceeeaca785 100644 --- a/docs/reference/commandline/attach.md +++ b/docs/reference/commandline/attach.md @@ -12,7 +12,7 @@ Attach local standard input, output, and error streams to a running container | Name | Type | Default | Description | |:----------------|:---------|:--------|:----------------------------------------------------| | `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `--no-stdin` | | | Do not attach STDIN | +| `--no-stdin` | `bool` | | Do not attach STDIN | | `--sig-proxy` | `bool` | `true` | Proxy all received signals to the process | diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index e2f4765a4408..dca5ee76ab84 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -15,7 +15,7 @@ Build an image from a Dockerfile | [`--build-arg`](https://docs.docker.com/reference/cli/docker/buildx/build/#build-arg) | `list` | | Set build-time variables | | `--cache-from` | `stringSlice` | | Images to consider as cache sources | | [`--cgroup-parent`](https://docs.docker.com/reference/cli/docker/buildx/build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--compress` | | | Compress the build context using gzip | +| `--compress` | `bool` | | Compress the build context using gzip | | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | | `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | @@ -23,21 +23,21 @@ Build an image from a Dockerfile | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | | `--disable-content-trust` | `bool` | `true` | Skip image verification | | [`-f`](https://docs.docker.com/reference/cli/docker/buildx/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/buildx/build/#file) | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) | -| `--force-rm` | | | Always remove intermediate containers | +| `--force-rm` | `bool` | | Always remove intermediate containers | | `--iidfile` | `string` | | Write the image ID to the file | | `--isolation` | `string` | | Container isolation technology | | `--label` | `list` | | Set metadata for an image | | `-m`, `--memory` | `bytes` | `0` | Memory limit | | `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | | [`--network`](https://docs.docker.com/reference/cli/docker/buildx/build/#network) | `string` | `default` | Set the networking mode for the RUN instructions during build | -| `--no-cache` | | | Do not use cache when building the image | +| `--no-cache` | `bool` | | Do not use cache when building the image | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--pull` | | | Always attempt to pull a newer version of the image | -| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | +| `--pull` | `bool` | | Always attempt to pull a newer version of the image | +| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | | `--rm` | `bool` | `true` | Remove intermediate containers after a successful build | | `--security-opt` | `stringSlice` | | Security options | | `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | -| `--squash` | | | Squash newly built layers into a single new layer | +| `--squash` | `bool` | | Squash newly built layers into a single new layer | | [`-t`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag) | `list` | | Name and optionally a tag in the `name:tag` format | | [`--target`](https://docs.docker.com/reference/cli/docker/buildx/build/#target) | `string` | | Set the target build stage to build. | | `--ulimit` | `ulimit` | | Ulimit options | diff --git a/docs/reference/commandline/builder_build.md b/docs/reference/commandline/builder_build.md index 53da887d9c84..ad9c09532159 100644 --- a/docs/reference/commandline/builder_build.md +++ b/docs/reference/commandline/builder_build.md @@ -15,7 +15,7 @@ Build an image from a Dockerfile | [`--build-arg`](https://docs.docker.com/reference/cli/docker/buildx/build/#build-arg) | `list` | | Set build-time variables | | `--cache-from` | `stringSlice` | | Images to consider as cache sources | | [`--cgroup-parent`](https://docs.docker.com/reference/cli/docker/buildx/build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--compress` | | | Compress the build context using gzip | +| `--compress` | `bool` | | Compress the build context using gzip | | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | | `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | @@ -23,21 +23,21 @@ Build an image from a Dockerfile | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | | `--disable-content-trust` | `bool` | `true` | Skip image verification | | [`-f`](https://docs.docker.com/reference/cli/docker/buildx/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/buildx/build/#file) | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) | -| `--force-rm` | | | Always remove intermediate containers | +| `--force-rm` | `bool` | | Always remove intermediate containers | | `--iidfile` | `string` | | Write the image ID to the file | | `--isolation` | `string` | | Container isolation technology | | `--label` | `list` | | Set metadata for an image | | `-m`, `--memory` | `bytes` | `0` | Memory limit | | `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | | [`--network`](https://docs.docker.com/reference/cli/docker/buildx/build/#network) | `string` | `default` | Set the networking mode for the RUN instructions during build | -| `--no-cache` | | | Do not use cache when building the image | +| `--no-cache` | `bool` | | Do not use cache when building the image | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--pull` | | | Always attempt to pull a newer version of the image | -| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | +| `--pull` | `bool` | | Always attempt to pull a newer version of the image | +| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | | `--rm` | `bool` | `true` | Remove intermediate containers after a successful build | | `--security-opt` | `stringSlice` | | Security options | | `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | -| `--squash` | | | Squash newly built layers into a single new layer | +| `--squash` | `bool` | | Squash newly built layers into a single new layer | | [`-t`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag) | `list` | | Name and optionally a tag in the `name:tag` format | | [`--target`](https://docs.docker.com/reference/cli/docker/buildx/build/#target) | `string` | | Set the target build stage to build. | | `--ulimit` | `ulimit` | | Ulimit options | diff --git a/docs/reference/commandline/builder_prune.md b/docs/reference/commandline/builder_prune.md index a90d58d39a08..8dbbfbd8d220 100644 --- a/docs/reference/commandline/builder_prune.md +++ b/docs/reference/commandline/builder_prune.md @@ -7,9 +7,9 @@ Remove build cache | Name | Type | Default | Description | |:-----------------|:---------|:--------|:------------------------------------------------------| -| `-a`, `--all` | | | Remove all unused build cache, not just dangling ones | +| `-a`, `--all` | `bool` | | Remove all unused build cache, not just dangling ones | | `--filter` | `filter` | | Provide filter values (e.g. `until=24h`) | -| `-f`, `--force` | | | Do not prompt for confirmation | +| `-f`, `--force` | `bool` | | Do not prompt for confirmation | | `--keep-storage` | `bytes` | `0` | Amount of disk space to keep for cache | diff --git a/docs/reference/commandline/checkpoint_create.md b/docs/reference/commandline/checkpoint_create.md index f59e259527f5..650d5973e270 100644 --- a/docs/reference/commandline/checkpoint_create.md +++ b/docs/reference/commandline/checkpoint_create.md @@ -8,7 +8,7 @@ Create a checkpoint from a running container | Name | Type | Default | Description | |:-------------------|:---------|:--------|:---------------------------------------------| | `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | -| `--leave-running` | | | Leave the container running after checkpoint | +| `--leave-running` | `bool` | | Leave the container running after checkpoint | diff --git a/docs/reference/commandline/config_inspect.md b/docs/reference/commandline/config_inspect.md index 5758d3dbec16..9d2a14db490f 100644 --- a/docs/reference/commandline/config_inspect.md +++ b/docs/reference/commandline/config_inspect.md @@ -8,7 +8,7 @@ Display detailed information on one or more configs | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--pretty` | | | Print the information in a human friendly format | +| `--pretty` | `bool` | | Print the information in a human friendly format | diff --git a/docs/reference/commandline/config_ls.md b/docs/reference/commandline/config_ls.md index be9ddb74116a..2911063f64e4 100644 --- a/docs/reference/commandline/config_ls.md +++ b/docs/reference/commandline/config_ls.md @@ -13,7 +13,7 @@ List configs |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only display IDs | +| `-q`, `--quiet` | `bool` | | Only display IDs | diff --git a/docs/reference/commandline/container_attach.md b/docs/reference/commandline/container_attach.md index 58118880967d..5f1b1e99aaf1 100644 --- a/docs/reference/commandline/container_attach.md +++ b/docs/reference/commandline/container_attach.md @@ -12,7 +12,7 @@ Attach local standard input, output, and error streams to a running container | Name | Type | Default | Description | |:--------------------------------|:---------|:--------|:----------------------------------------------------| | [`--detach-keys`](#detach-keys) | `string` | | Override the key sequence for detaching a container | -| `--no-stdin` | | | Do not attach STDIN | +| `--no-stdin` | `bool` | | Do not attach STDIN | | `--sig-proxy` | `bool` | `true` | Proxy all received signals to the process | diff --git a/docs/reference/commandline/container_cp.md b/docs/reference/commandline/container_cp.md index 3aebacabdbf3..9a6166625988 100644 --- a/docs/reference/commandline/container_cp.md +++ b/docs/reference/commandline/container_cp.md @@ -14,11 +14,11 @@ container source to stdout. ### Options -| Name | Type | Default | Description | -|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------| -| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | -| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | -| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached | +| Name | Type | Default | Description | +|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------| +| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) | +| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH | +| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached | diff --git a/docs/reference/commandline/container_create.md b/docs/reference/commandline/container_create.md index dc76075ad389..a2394eab28c2 100644 --- a/docs/reference/commandline/container_create.md +++ b/docs/reference/commandline/container_create.md @@ -54,10 +54,10 @@ Create a new container | `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | | `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | | `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | -| `--help` | | | Print usage | +| `--help` | `bool` | | Print usage | | `-h`, `--hostname` | `string` | | Container host name | -| `--init` | | | Run an init inside the container that forwards signals and reaps processes | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `--init` | `bool` | | Run an init inside the container that forwards signals and reaps processes | +| `-i`, `--interactive` | `bool` | | Keep STDIN open even if not attached | | `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | | `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | | `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | @@ -80,20 +80,20 @@ Create a new container | `--name` | `string` | | Assign a name to the container | | `--network` | `network` | | Connect a container to a network | | `--network-alias` | `list` | | Add network-scoped alias for the container | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--oom-kill-disable` | | | Disable OOM Killer | +| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK | +| `--oom-kill-disable` | `bool` | | Disable OOM Killer | | `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | | `--pid` | `string` | | PID namespace to use | | `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--privileged` | | | Give extended privileges to this container | +| `--privileged` | `bool` | | Give extended privileges to this container | | `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | -| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | +| `-P`, `--publish-all` | `bool` | | Publish all exposed ports to random ports | | `--pull` | `string` | `missing` | Pull image before creating (`always`, `\|missing`, `never`) | -| `-q`, `--quiet` | | | Suppress the pull output | -| `--read-only` | | | Mount the container's root filesystem as read only | +| `-q`, `--quiet` | `bool` | | Suppress the pull output | +| `--read-only` | `bool` | | Mount the container's root filesystem as read only | | `--restart` | `string` | `no` | Restart policy to apply when a container exits | -| `--rm` | | | Automatically remove the container and its associated anonymous volumes when it exits | +| `--rm` | `bool` | | Automatically remove the container and its associated anonymous volumes when it exits | | `--runtime` | `string` | | Runtime to use for this container | | `--security-opt` | `list` | | Security Options | | `--shm-size` | `bytes` | `0` | Size of /dev/shm | @@ -102,7 +102,7 @@ Create a new container | `--storage-opt` | `list` | | Storage driver options for the container | | `--sysctl` | `map` | `map[]` | Sysctl options | | `--tmpfs` | `list` | | Mount a tmpfs directory | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `--ulimit` | `ulimit` | | Ulimit options | | `-u`, `--user` | `string` | | Username or UID (format: [:]) | | `--userns` | `string` | | User namespace to use | diff --git a/docs/reference/commandline/container_exec.md b/docs/reference/commandline/container_exec.md index 896c05ae6c40..7aeea01b6edf 100644 --- a/docs/reference/commandline/container_exec.md +++ b/docs/reference/commandline/container_exec.md @@ -11,13 +11,13 @@ Execute a command in a running container | Name | Type | Default | Description | |:------------------------------------------|:---------|:--------|:-------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: run command in the background | +| `-d`, `--detach` | `bool` | | Detached mode: run command in the background | | `--detach-keys` | `string` | | Override the key sequence for detaching a container | | [`-e`](#env), [`--env`](#env) | `list` | | Set environment variables | | `--env-file` | `list` | | Read in a file of environment variables | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | -| [`--privileged`](#privileged) | | | Give extended privileges to the command | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-i`, `--interactive` | `bool` | | Keep STDIN open even if not attached | +| [`--privileged`](#privileged) | `bool` | | Give extended privileges to the command | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `-u`, `--user` | `string` | | Username or UID (format: `[:]`) | | [`-w`](#workdir), [`--workdir`](#workdir) | `string` | | Working directory inside the container | diff --git a/docs/reference/commandline/container_inspect.md b/docs/reference/commandline/container_inspect.md index 8ebd2157aede..0ca805ded4a6 100644 --- a/docs/reference/commandline/container_inspect.md +++ b/docs/reference/commandline/container_inspect.md @@ -8,7 +8,7 @@ Display detailed information on one or more containers | Name | Type | Default | Description | |:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `-f`, `--format` | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-s`, `--size` | | | Display total file sizes | +| `-s`, `--size` | `bool` | | Display total file sizes | diff --git a/docs/reference/commandline/container_logs.md b/docs/reference/commandline/container_logs.md index 9b4d29cdd170..ff8b92de50c2 100644 --- a/docs/reference/commandline/container_logs.md +++ b/docs/reference/commandline/container_logs.md @@ -11,11 +11,11 @@ Fetch the logs of a container | Name | Type | Default | Description | |:---------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------| -| `--details` | | | Show extra details provided to logs | -| `-f`, `--follow` | | | Follow log output | +| `--details` | `bool` | | Show extra details provided to logs | +| `-f`, `--follow` | `bool` | | Follow log output | | `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | | `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs | -| `-t`, `--timestamps` | | | Show timestamps | +| `-t`, `--timestamps` | `bool` | | Show timestamps | | [`--until`](#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/commandline/container_ls.md b/docs/reference/commandline/container_ls.md index 062fdcb4cd1b..38ee110bc0f5 100644 --- a/docs/reference/commandline/container_ls.md +++ b/docs/reference/commandline/container_ls.md @@ -11,14 +11,14 @@ List containers | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`-a`](#all), [`--all`](#all) | | | Show all containers (default shows just running) | +| [`-a`](#all), [`--all`](#all) | `bool` | | Show all containers (default shows just running) | | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | `-n`, `--last` | `int` | `-1` | Show n last created containers (includes all states) | -| `-l`, `--latest` | | | Show the latest created container (includes all states) | -| [`--no-trunc`](#no-trunc) | | | Don't truncate output | -| `-q`, `--quiet` | | | Only display container IDs | -| [`-s`](#size), [`--size`](#size) | | | Display total file sizes | +| `-l`, `--latest` | `bool` | | Show the latest created container (includes all states) | +| [`--no-trunc`](#no-trunc) | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only display container IDs | +| [`-s`](#size), [`--size`](#size) | `bool` | | Display total file sizes | diff --git a/docs/reference/commandline/container_prune.md b/docs/reference/commandline/container_prune.md index 8450625ddcee..08606e97b7b4 100644 --- a/docs/reference/commandline/container_prune.md +++ b/docs/reference/commandline/container_prune.md @@ -8,7 +8,7 @@ Remove all stopped containers | Name | Type | Default | Description | |:----------------------|:---------|:--------|:-------------------------------------------------| | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=`) | -| `-f`, `--force` | | | Do not prompt for confirmation | +| `-f`, `--force` | `bool` | | Do not prompt for confirmation | diff --git a/docs/reference/commandline/container_rm.md b/docs/reference/commandline/container_rm.md index cbb8b81c4558..ee370f71e43b 100644 --- a/docs/reference/commandline/container_rm.md +++ b/docs/reference/commandline/container_rm.md @@ -9,11 +9,11 @@ Remove one or more containers ### Options -| Name | Type | Default | Description | -|:------------------------------------------|:-----|:--------|:--------------------------------------------------------| -| [`-f`](#force), [`--force`](#force) | | | Force the removal of a running container (uses SIGKILL) | -| [`-l`](#link), [`--link`](#link) | | | Remove the specified link | -| [`-v`](#volumes), [`--volumes`](#volumes) | | | Remove anonymous volumes associated with the container | +| Name | Type | Default | Description | +|:------------------------------------------|:-------|:--------|:--------------------------------------------------------| +| [`-f`](#force), [`--force`](#force) | `bool` | | Force the removal of a running container (uses SIGKILL) | +| [`-l`](#link), [`--link`](#link) | `bool` | | Remove the specified link | +| [`-v`](#volumes), [`--volumes`](#volumes) | `bool` | | Remove anonymous volumes associated with the container | diff --git a/docs/reference/commandline/container_run.md b/docs/reference/commandline/container_run.md index 27b4eb42e4df..9d426a3bf1e0 100644 --- a/docs/reference/commandline/container_run.md +++ b/docs/reference/commandline/container_run.md @@ -31,7 +31,7 @@ Create and run a new container from an image | `--cpus` | `decimal` | | Number of CPUs | | `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | -| [`-d`](#detach), [`--detach`](#detach) | | | Run container in background and print container ID | +| [`-d`](#detach), [`--detach`](#detach) | `bool` | | Run container in background and print container ID | | [`--detach-keys`](#detach-keys) | `string` | | Override the key sequence for detaching a container | | [`--device`](#device) | `list` | | Add a host device to the container | | [`--device-cgroup-rule`](#device-cgroup-rule) | `list` | | Add a rule to the cgroup allowed devices list | @@ -56,10 +56,10 @@ Create and run a new container from an image | `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | | `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | | `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | -| `--help` | | | Print usage | +| `--help` | `bool` | | Print usage | | `-h`, `--hostname` | `string` | | Container host name | -| [`--init`](#init) | | | Run an init inside the container that forwards signals and reaps processes | -| [`-i`](#interactive), [`--interactive`](#interactive) | | | Keep STDIN open even if not attached | +| [`--init`](#init) | `bool` | | Run an init inside the container that forwards signals and reaps processes | +| [`-i`](#interactive), [`--interactive`](#interactive) | `bool` | | Keep STDIN open even if not attached | | `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | | `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | | `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | @@ -82,20 +82,20 @@ Create and run a new container from an image | [`--name`](#name) | `string` | | Assign a name to the container | | [`--network`](#network) | `network` | | Connect a container to a network | | `--network-alias` | `list` | | Add network-scoped alias for the container | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--oom-kill-disable` | | | Disable OOM Killer | +| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK | +| `--oom-kill-disable` | `bool` | | Disable OOM Killer | | `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | | [`--pid`](#pid) | `string` | | PID namespace to use | | `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| [`--privileged`](#privileged) | | | Give extended privileges to this container | +| [`--privileged`](#privileged) | `bool` | | Give extended privileges to this container | | [`-p`](#publish), [`--publish`](#publish) | `list` | | Publish a container's port(s) to the host | -| [`-P`](#publish-all), [`--publish-all`](#publish-all) | | | Publish all exposed ports to random ports | +| [`-P`](#publish-all), [`--publish-all`](#publish-all) | `bool` | | Publish all exposed ports to random ports | | [`--pull`](#pull) | `string` | `missing` | Pull image before running (`always`, `missing`, `never`) | -| `-q`, `--quiet` | | | Suppress the pull output | -| [`--read-only`](#read-only) | | | Mount the container's root filesystem as read only | +| `-q`, `--quiet` | `bool` | | Suppress the pull output | +| [`--read-only`](#read-only) | `bool` | | Mount the container's root filesystem as read only | | [`--restart`](#restart) | `string` | `no` | Restart policy to apply when a container exits | -| [`--rm`](#rm) | | | Automatically remove the container and its associated anonymous volumes when it exits | +| [`--rm`](#rm) | `bool` | | Automatically remove the container and its associated anonymous volumes when it exits | | `--runtime` | `string` | | Runtime to use for this container | | [`--security-opt`](#security-opt) | `list` | | Security Options | | `--shm-size` | `bytes` | `0` | Size of /dev/shm | @@ -105,7 +105,7 @@ Create and run a new container from an image | [`--storage-opt`](#storage-opt) | `list` | | Storage driver options for the container | | [`--sysctl`](#sysctl) | `map` | `map[]` | Sysctl options | | [`--tmpfs`](#tmpfs) | `list` | | Mount a tmpfs directory | -| [`-t`](#tty), [`--tty`](#tty) | | | Allocate a pseudo-TTY | +| [`-t`](#tty), [`--tty`](#tty) | `bool` | | Allocate a pseudo-TTY | | [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | | `-u`, `--user` | `string` | | Username or UID (format: [:]) | | [`--userns`](#userns) | `string` | | User namespace to use | diff --git a/docs/reference/commandline/container_start.md b/docs/reference/commandline/container_start.md index 866a24921aee..256fc9c8a830 100644 --- a/docs/reference/commandline/container_start.md +++ b/docs/reference/commandline/container_start.md @@ -11,11 +11,11 @@ Start one or more stopped containers | Name | Type | Default | Description | |:----------------------|:---------|:--------|:----------------------------------------------------| -| `-a`, `--attach` | | | Attach STDOUT/STDERR and forward signals | +| `-a`, `--attach` | `bool` | | Attach STDOUT/STDERR and forward signals | | `--checkpoint` | `string` | | Restore from this checkpoint | | `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | | `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `-i`, `--interactive` | | | Attach container's STDIN | +| `-i`, `--interactive` | `bool` | | Attach container's STDIN | diff --git a/docs/reference/commandline/container_stats.md b/docs/reference/commandline/container_stats.md index f59ea7838a77..4f50560240ec 100644 --- a/docs/reference/commandline/container_stats.md +++ b/docs/reference/commandline/container_stats.md @@ -11,10 +11,10 @@ Display a live stream of container(s) resource usage statistics | Name | Type | Default | Description | |:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all containers (default shows just running) | +| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-stream` | | | Disable streaming stats and only pull the first result | -| `--no-trunc` | | | Do not truncate output | +| `--no-stream` | `bool` | | Disable streaming stats and only pull the first result | +| `--no-trunc` | `bool` | | Do not truncate output | diff --git a/docs/reference/commandline/context_ls.md b/docs/reference/commandline/context_ls.md index e7d9b0ea1532..2f062f4a2456 100644 --- a/docs/reference/commandline/context_ls.md +++ b/docs/reference/commandline/context_ls.md @@ -12,7 +12,7 @@ List contexts | Name | Type | Default | Description | |:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only show context names | +| `-q`, `--quiet` | `bool` | | Only show context names | diff --git a/docs/reference/commandline/context_rm.md b/docs/reference/commandline/context_rm.md index 933941580a6f..05ed2f1f3859 100644 --- a/docs/reference/commandline/context_rm.md +++ b/docs/reference/commandline/context_rm.md @@ -9,9 +9,9 @@ Remove one or more contexts ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:--------------------------------------| -| `-f`, `--force` | | | Force the removal of a context in use | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:--------------------------------------| +| `-f`, `--force` | `bool` | | Force the removal of a context in use | diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md index 41c9529f9f0a..ded96d696643 100644 --- a/docs/reference/commandline/cp.md +++ b/docs/reference/commandline/cp.md @@ -14,11 +14,11 @@ container source to stdout. ### Options -| Name | Type | Default | Description | -|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------| -| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | -| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | -| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached | +| Name | Type | Default | Description | +|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------| +| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) | +| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH | +| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached | diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index f0964921c5e8..59488a5404af 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -54,10 +54,10 @@ Create a new container | `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | | `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | | `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | -| `--help` | | | Print usage | +| `--help` | `bool` | | Print usage | | `-h`, `--hostname` | `string` | | Container host name | -| `--init` | | | Run an init inside the container that forwards signals and reaps processes | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `--init` | `bool` | | Run an init inside the container that forwards signals and reaps processes | +| `-i`, `--interactive` | `bool` | | Keep STDIN open even if not attached | | `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | | `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | | `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | @@ -80,20 +80,20 @@ Create a new container | `--name` | `string` | | Assign a name to the container | | `--network` | `network` | | Connect a container to a network | | `--network-alias` | `list` | | Add network-scoped alias for the container | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--oom-kill-disable` | | | Disable OOM Killer | +| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK | +| `--oom-kill-disable` | `bool` | | Disable OOM Killer | | `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | | `--pid` | `string` | | PID namespace to use | | `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--privileged` | | | Give extended privileges to this container | +| `--privileged` | `bool` | | Give extended privileges to this container | | `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | -| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | +| `-P`, `--publish-all` | `bool` | | Publish all exposed ports to random ports | | `--pull` | `string` | `missing` | Pull image before creating (`always`, `\|missing`, `never`) | -| `-q`, `--quiet` | | | Suppress the pull output | -| `--read-only` | | | Mount the container's root filesystem as read only | +| `-q`, `--quiet` | `bool` | | Suppress the pull output | +| `--read-only` | `bool` | | Mount the container's root filesystem as read only | | `--restart` | `string` | `no` | Restart policy to apply when a container exits | -| `--rm` | | | Automatically remove the container and its associated anonymous volumes when it exits | +| `--rm` | `bool` | | Automatically remove the container and its associated anonymous volumes when it exits | | `--runtime` | `string` | | Runtime to use for this container | | `--security-opt` | `list` | | Security Options | | `--shm-size` | `bytes` | `0` | Size of /dev/shm | @@ -102,7 +102,7 @@ Create a new container | `--storage-opt` | `list` | | Storage driver options for the container | | `--sysctl` | `map` | `map[]` | Sysctl options | | `--tmpfs` | `list` | | Mount a tmpfs directory | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `--ulimit` | `ulimit` | | Ulimit options | | `-u`, `--user` | `string` | | Username or UID (format: [:]) | | `--userns` | `string` | | User namespace to use | diff --git a/docs/reference/commandline/docker.md b/docs/reference/commandline/docker.md index 3bfdffb1804d..bfca795855ae 100644 --- a/docs/reference/commandline/docker.md +++ b/docs/reference/commandline/docker.md @@ -72,14 +72,14 @@ The base command for the Docker CLI. |:---------------------------------|:---------|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------| | `--config` | `string` | `/root/.docker` | Location of client config files | | `-c`, `--context` | `string` | | Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with `docker context use`) | -| `-D`, `--debug` | | | Enable debug mode | +| `-D`, `--debug` | `bool` | | Enable debug mode | | [`-H`](#host), [`--host`](#host) | `list` | | Daemon socket to connect to | | `-l`, `--log-level` | `string` | `info` | Set the logging level (`debug`, `info`, `warn`, `error`, `fatal`) | -| `--tls` | | | Use TLS; implied by --tlsverify | +| `--tls` | `bool` | | Use TLS; implied by --tlsverify | | `--tlscacert` | `string` | `/root/.docker/ca.pem` | Trust certs signed only by this CA | | `--tlscert` | `string` | `/root/.docker/cert.pem` | Path to TLS certificate file | | `--tlskey` | `string` | `/root/.docker/key.pem` | Path to TLS key file | -| `--tlsverify` | | | Use TLS and verify the remote | +| `--tlsverify` | `bool` | | Use TLS and verify the remote | diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index 67bf20a1376f..b2be3e495825 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -11,13 +11,13 @@ Execute a command in a running container | Name | Type | Default | Description | |:----------------------|:---------|:--------|:-------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: run command in the background | +| `-d`, `--detach` | `bool` | | Detached mode: run command in the background | | `--detach-keys` | `string` | | Override the key sequence for detaching a container | | `-e`, `--env` | `list` | | Set environment variables | | `--env-file` | `list` | | Read in a file of environment variables | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | -| `--privileged` | | | Give extended privileges to the command | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-i`, `--interactive` | `bool` | | Keep STDIN open even if not attached | +| `--privileged` | `bool` | | Give extended privileges to the command | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `-u`, `--user` | `string` | | Username or UID (format: `[:]`) | | `-w`, `--workdir` | `string` | | Working directory inside the container | diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index 15a02e9092b5..7705c70bcac8 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -13,8 +13,8 @@ Show the history of an image |:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | `-H`, `--human` | `bool` | `true` | Print sizes and dates in human readable format | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only show image IDs | +| `--no-trunc` | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only show image IDs | diff --git a/docs/reference/commandline/image_build.md b/docs/reference/commandline/image_build.md index a971d12967c7..49690b714d29 100644 --- a/docs/reference/commandline/image_build.md +++ b/docs/reference/commandline/image_build.md @@ -15,7 +15,7 @@ Build an image from a Dockerfile | [`--build-arg`](https://docs.docker.com/reference/cli/docker/buildx/build/#build-arg) | `list` | | Set build-time variables | | `--cache-from` | `stringSlice` | | Images to consider as cache sources | | [`--cgroup-parent`](https://docs.docker.com/reference/cli/docker/buildx/build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--compress` | | | Compress the build context using gzip | +| `--compress` | `bool` | | Compress the build context using gzip | | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | | `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) | @@ -23,21 +23,21 @@ Build an image from a Dockerfile | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | | `--disable-content-trust` | `bool` | `true` | Skip image verification | | [`-f`](https://docs.docker.com/reference/cli/docker/buildx/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/buildx/build/#file) | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) | -| `--force-rm` | | | Always remove intermediate containers | +| `--force-rm` | `bool` | | Always remove intermediate containers | | `--iidfile` | `string` | | Write the image ID to the file | | [`--isolation`](#isolation) | `string` | | Container isolation technology | | `--label` | `list` | | Set metadata for an image | | `-m`, `--memory` | `bytes` | `0` | Memory limit | | `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | | [`--network`](https://docs.docker.com/reference/cli/docker/buildx/build/#network) | `string` | `default` | Set the networking mode for the RUN instructions during build | -| `--no-cache` | | | Do not use cache when building the image | +| `--no-cache` | `bool` | | Do not use cache when building the image | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--pull` | | | Always attempt to pull a newer version of the image | -| `-q`, `--quiet` | | | Suppress the build output and print image ID on success | +| `--pull` | `bool` | | Always attempt to pull a newer version of the image | +| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | | `--rm` | `bool` | `true` | Remove intermediate containers after a successful build | | [`--security-opt`](#security-opt) | `stringSlice` | | Security options | | `--shm-size` | `bytes` | `0` | Size of `/dev/shm` | -| [`--squash`](#squash) | | | Squash newly built layers into a single new layer | +| [`--squash`](#squash) | `bool` | | Squash newly built layers into a single new layer | | [`-t`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag) | `list` | | Name and optionally a tag in the `name:tag` format | | [`--target`](https://docs.docker.com/reference/cli/docker/buildx/build/#target) | `string` | | Set the target build stage to build. | | `--ulimit` | `ulimit` | | Ulimit options | diff --git a/docs/reference/commandline/image_history.md b/docs/reference/commandline/image_history.md index 5b8ad00600e1..7ed258a9f5be 100644 --- a/docs/reference/commandline/image_history.md +++ b/docs/reference/commandline/image_history.md @@ -13,8 +13,8 @@ Show the history of an image |:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | `-H`, `--human` | `bool` | `true` | Print sizes and dates in human readable format | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only show image IDs | +| `--no-trunc` | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only show image IDs | diff --git a/docs/reference/commandline/image_load.md b/docs/reference/commandline/image_load.md index 098af0a24335..8b675a3bb1ab 100644 --- a/docs/reference/commandline/image_load.md +++ b/docs/reference/commandline/image_load.md @@ -12,7 +12,7 @@ Load an image from a tar archive or STDIN | Name | Type | Default | Description | |:------------------------------------|:---------|:--------|:---------------------------------------------| | [`-i`](#input), [`--input`](#input) | `string` | | Read from tar archive file, instead of STDIN | -| `-q`, `--quiet` | | | Suppress the load output | +| `-q`, `--quiet` | `bool` | | Suppress the load output | diff --git a/docs/reference/commandline/image_ls.md b/docs/reference/commandline/image_ls.md index 1467c37c6eca..3365c29c6b45 100644 --- a/docs/reference/commandline/image_ls.md +++ b/docs/reference/commandline/image_ls.md @@ -11,12 +11,12 @@ List images | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all images (default hides intermediate images) | -| [`--digests`](#digests) | | | Show digests | +| `-a`, `--all` | `bool` | | Show all images (default hides intermediate images) | +| [`--digests`](#digests) | `bool` | | Show digests | | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| [`--no-trunc`](#no-trunc) | | | Don't truncate output | -| `-q`, `--quiet` | | | Only show image IDs | +| [`--no-trunc`](#no-trunc) | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only show image IDs | diff --git a/docs/reference/commandline/image_prune.md b/docs/reference/commandline/image_prune.md index 23235dbc18b2..9edd2af0ff4b 100644 --- a/docs/reference/commandline/image_prune.md +++ b/docs/reference/commandline/image_prune.md @@ -7,9 +7,9 @@ Remove unused images | Name | Type | Default | Description | |:----------------------|:---------|:--------|:-------------------------------------------------| -| `-a`, `--all` | | | Remove all unused images, not just dangling ones | +| `-a`, `--all` | `bool` | | Remove all unused images, not just dangling ones | | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=`) | -| `-f`, `--force` | | | Do not prompt for confirmation | +| `-f`, `--force` | `bool` | | Do not prompt for confirmation | diff --git a/docs/reference/commandline/image_pull.md b/docs/reference/commandline/image_pull.md index 8333dd3e8196..5cc19fa384b1 100644 --- a/docs/reference/commandline/image_pull.md +++ b/docs/reference/commandline/image_pull.md @@ -11,10 +11,10 @@ Download an image from a registry | Name | Type | Default | Description | |:---------------------------------------------|:---------|:--------|:-------------------------------------------------| -| [`-a`](#all-tags), [`--all-tags`](#all-tags) | | | Download all tagged images in the repository | +| [`-a`](#all-tags), [`--all-tags`](#all-tags) | `bool` | | Download all tagged images in the repository | | `--disable-content-trust` | `bool` | `true` | Skip image verification | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `-q`, `--quiet` | | | Suppress verbose output | +| `-q`, `--quiet` | `bool` | | Suppress verbose output | diff --git a/docs/reference/commandline/image_push.md b/docs/reference/commandline/image_push.md index 592d2c3bc71e..d58282a1accc 100644 --- a/docs/reference/commandline/image_push.md +++ b/docs/reference/commandline/image_push.md @@ -11,10 +11,10 @@ Upload an image to a registry | Name | Type | Default | Description | |:---------------------------------------------|:---------|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------| -| [`-a`](#all-tags), [`--all-tags`](#all-tags) | | | Push all tags of an image to the repository | +| [`-a`](#all-tags), [`--all-tags`](#all-tags) | `bool` | | Push all tags of an image to the repository | | `--disable-content-trust` | `bool` | `true` | Skip image signing | | `--platform` | `string` | | Push a platform-specific manifest as a single-platform image to the registry.
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64) | -| `-q`, `--quiet` | | | Suppress verbose output | +| `-q`, `--quiet` | `bool` | | Suppress verbose output | diff --git a/docs/reference/commandline/image_rm.md b/docs/reference/commandline/image_rm.md index f3b303da0b69..81ff55c6b0c4 100644 --- a/docs/reference/commandline/image_rm.md +++ b/docs/reference/commandline/image_rm.md @@ -9,10 +9,10 @@ Remove one or more images ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------------------| -| `-f`, `--force` | | | Force removal of the image | -| `--no-prune` | | | Do not delete untagged parents | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:-------------------------------| +| `-f`, `--force` | `bool` | | Force removal of the image | +| `--no-prune` | `bool` | | Do not delete untagged parents | diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/images.md index 1fa9f6a319c5..1f7b3b5a4da0 100644 --- a/docs/reference/commandline/images.md +++ b/docs/reference/commandline/images.md @@ -11,12 +11,12 @@ List images | Name | Type | Default | Description | |:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all images (default hides intermediate images) | -| `--digests` | | | Show digests | +| `-a`, `--all` | `bool` | | Show all images (default hides intermediate images) | +| `--digests` | `bool` | | Show digests | | `-f`, `--filter` | `filter` | | Filter output based on conditions provided | | `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only show image IDs | +| `--no-trunc` | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only show image IDs | diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index 04a9f6d3b71b..174c440e6c5f 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -8,7 +8,7 @@ Return low-level information on Docker objects | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| [`-s`](#size), [`--size`](#size) | | | Display total file sizes if the type is container | +| [`-s`](#size), [`--size`](#size) | `bool` | | Display total file sizes if the type is container | | [`--type`](#type) | `string` | | Return JSON for specified type | diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md index 778d263077dd..c961f06020df 100644 --- a/docs/reference/commandline/load.md +++ b/docs/reference/commandline/load.md @@ -12,7 +12,7 @@ Load an image from a tar archive or STDIN | Name | Type | Default | Description | |:----------------|:---------|:--------|:---------------------------------------------| | `-i`, `--input` | `string` | | Read from tar archive file, instead of STDIN | -| `-q`, `--quiet` | | | Suppress the load output | +| `-q`, `--quiet` | `bool` | | Suppress the load output | diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index 6e41586a19f4..f61043a1dd82 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -9,7 +9,7 @@ If no server is specified, the default is defined by the daemon. | Name | Type | Default | Description | |:--------------------------------------|:---------|:--------|:-----------------------------| | `-p`, `--password` | `string` | | Password | -| [`--password-stdin`](#password-stdin) | | | Take the password from stdin | +| [`--password-stdin`](#password-stdin) | `bool` | | Take the password from stdin | | `-u`, `--username` | `string` | | Username | diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md index 840f0562a5c6..56e7671c5c2a 100644 --- a/docs/reference/commandline/logs.md +++ b/docs/reference/commandline/logs.md @@ -11,11 +11,11 @@ Fetch the logs of a container | Name | Type | Default | Description | |:---------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------| -| `--details` | | | Show extra details provided to logs | -| `-f`, `--follow` | | | Follow log output | +| `--details` | `bool` | | Show extra details provided to logs | +| `-f`, `--follow` | `bool` | | Follow log output | | `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | | `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs | -| `-t`, `--timestamps` | | | Show timestamps | +| `-t`, `--timestamps` | `bool` | | 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/commandline/manifest_create.md b/docs/reference/commandline/manifest_create.md index 2879fae6f798..1686ed53e951 100644 --- a/docs/reference/commandline/manifest_create.md +++ b/docs/reference/commandline/manifest_create.md @@ -5,10 +5,10 @@ Create a local manifest list for annotating and pushing to a registry ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:----------------------------------------------| -| `-a`, `--amend` | | | Amend an existing manifest list | -| `--insecure` | | | Allow communication with an insecure registry | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:----------------------------------------------| +| `-a`, `--amend` | `bool` | | Amend an existing manifest list | +| `--insecure` | `bool` | | Allow communication with an insecure registry | diff --git a/docs/reference/commandline/manifest_inspect.md b/docs/reference/commandline/manifest_inspect.md index 79c062193cab..cc2da1a8df59 100644 --- a/docs/reference/commandline/manifest_inspect.md +++ b/docs/reference/commandline/manifest_inspect.md @@ -5,10 +5,10 @@ Display an image manifest, or manifest list ### Options -| Name | Type | Default | Description | -|:------------------|:-----|:--------|:-----------------------------------------------------| -| `--insecure` | | | Allow communication with an insecure registry | -| `-v`, `--verbose` | | | Output additional info including layers and platform | +| Name | Type | Default | Description | +|:------------------|:-------|:--------|:-----------------------------------------------------| +| `--insecure` | `bool` | | Allow communication with an insecure registry | +| `-v`, `--verbose` | `bool` | | Output additional info including layers and platform | diff --git a/docs/reference/commandline/manifest_push.md b/docs/reference/commandline/manifest_push.md index 67a7d18a4f1c..34958bd21a2b 100644 --- a/docs/reference/commandline/manifest_push.md +++ b/docs/reference/commandline/manifest_push.md @@ -5,10 +5,10 @@ Push a manifest list to a repository ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:------------------------------------------| -| `--insecure` | | | Allow push to an insecure registry | -| `-p`, `--purge` | | | Remove the local manifest list after push | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:------------------------------------------| +| `--insecure` | `bool` | | Allow push to an insecure registry | +| `-p`, `--purge` | `bool` | | Remove the local manifest list after push | diff --git a/docs/reference/commandline/network_create.md b/docs/reference/commandline/network_create.md index 585bc373acdc..43c59ba3d07f 100644 --- a/docs/reference/commandline/network_create.md +++ b/docs/reference/commandline/network_create.md @@ -7,18 +7,18 @@ Create a network | Name | Type | Default | Description | |:--------------------------|:--------------|:----------|:--------------------------------------------------------| -| `--attachable` | | | Enable manual container attachment | +| `--attachable` | `bool` | | Enable manual container attachment | | `--aux-address` | `map` | `map[]` | Auxiliary IPv4 or IPv6 addresses used by Network driver | | `--config-from` | `string` | | The network from which to copy the configuration | -| `--config-only` | | | Create a configuration only network | +| `--config-only` | `bool` | | Create a configuration only network | | `-d`, `--driver` | `string` | `bridge` | Driver to manage the Network | | `--gateway` | `stringSlice` | | IPv4 or IPv6 Gateway for the master subnet | -| [`--ingress`](#ingress) | | | Create swarm routing-mesh network | -| [`--internal`](#internal) | | | Restrict external access to the network | +| [`--ingress`](#ingress) | `bool` | | Create swarm routing-mesh network | +| [`--internal`](#internal) | `bool` | | Restrict external access to the network | | `--ip-range` | `stringSlice` | | Allocate container ip from a sub-range | | `--ipam-driver` | `string` | `default` | IP Address Management Driver | | `--ipam-opt` | `map` | `map[]` | Set IPAM driver specific options | -| `--ipv6` | | | Enable or disable IPv6 networking | +| `--ipv6` | `bool` | | Enable or disable IPv6 networking | | `--label` | `list` | | Set metadata on a network | | `-o`, `--opt` | `map` | `map[]` | Set driver specific options | | `--scope` | `string` | | Control the network's scope | diff --git a/docs/reference/commandline/network_disconnect.md b/docs/reference/commandline/network_disconnect.md index 8ab6b9703531..b09a8faeb65d 100644 --- a/docs/reference/commandline/network_disconnect.md +++ b/docs/reference/commandline/network_disconnect.md @@ -5,9 +5,9 @@ Disconnect a container from a network ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------------------------------------| -| `-f`, `--force` | | | Force the container to disconnect from a network | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:-------------------------------------------------| +| `-f`, `--force` | `bool` | | Force the container to disconnect from a network | diff --git a/docs/reference/commandline/network_inspect.md b/docs/reference/commandline/network_inspect.md index 5025d964d967..1c5dec508150 100644 --- a/docs/reference/commandline/network_inspect.md +++ b/docs/reference/commandline/network_inspect.md @@ -8,7 +8,7 @@ Display detailed information on one or more networks | Name | Type | Default | Description | |:------------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `-f`, `--format` | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| [`-v`](#verbose), [`--verbose`](#verbose) | | | Verbose output for diagnostics | +| [`-v`](#verbose), [`--verbose`](#verbose) | `bool` | | Verbose output for diagnostics | diff --git a/docs/reference/commandline/network_ls.md b/docs/reference/commandline/network_ls.md index bce120c2ae4a..31e1501ac6bc 100644 --- a/docs/reference/commandline/network_ls.md +++ b/docs/reference/commandline/network_ls.md @@ -13,8 +13,8 @@ List networks |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-trunc` | | | Do not truncate the output | -| `-q`, `--quiet` | | | Only display network IDs | +| `--no-trunc` | `bool` | | Do not truncate the output | +| `-q`, `--quiet` | `bool` | | Only display network IDs | diff --git a/docs/reference/commandline/network_prune.md b/docs/reference/commandline/network_prune.md index 9a0ee1d247cc..9cbd79522cff 100644 --- a/docs/reference/commandline/network_prune.md +++ b/docs/reference/commandline/network_prune.md @@ -8,7 +8,7 @@ Remove all unused networks | Name | Type | Default | Description | |:----------------------|:---------|:--------|:-------------------------------------------------| | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=`) | -| `-f`, `--force` | | | Do not prompt for confirmation | +| `-f`, `--force` | `bool` | | Do not prompt for confirmation | diff --git a/docs/reference/commandline/network_rm.md b/docs/reference/commandline/network_rm.md index 755d2126fdac..0bbe2e4638fd 100644 --- a/docs/reference/commandline/network_rm.md +++ b/docs/reference/commandline/network_rm.md @@ -9,9 +9,9 @@ Remove one or more networks ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------------------------------| -| `-f`, `--force` | | | Do not error if the network does not exist | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:-------------------------------------------| +| `-f`, `--force` | `bool` | | Do not error if the network does not exist | diff --git a/docs/reference/commandline/node_inspect.md b/docs/reference/commandline/node_inspect.md index cc99d4f74084..da1c4033b007 100644 --- a/docs/reference/commandline/node_inspect.md +++ b/docs/reference/commandline/node_inspect.md @@ -8,7 +8,7 @@ Display detailed information on one or more nodes | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--pretty` | | | Print the information in a human friendly format | +| `--pretty` | `bool` | | Print the information in a human friendly format | diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index 823e85994f33..3c48b9a9f7a1 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -13,7 +13,7 @@ List nodes in the swarm |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only display IDs | +| `-q`, `--quiet` | `bool` | | Only display IDs | diff --git a/docs/reference/commandline/node_ps.md b/docs/reference/commandline/node_ps.md index dc79db74236c..d3c7e6b80e04 100644 --- a/docs/reference/commandline/node_ps.md +++ b/docs/reference/commandline/node_ps.md @@ -9,9 +9,9 @@ List tasks running on one or more nodes, defaults to current node |:---------------------------------------|:---------|:--------|:-------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Pretty-print tasks using a Go template | -| `--no-resolve` | | | Do not map IDs to Names | -| `--no-trunc` | | | Do not truncate output | -| `-q`, `--quiet` | | | Only display task IDs | +| `--no-resolve` | `bool` | | Do not map IDs to Names | +| `--no-trunc` | `bool` | | Do not truncate output | +| `-q`, `--quiet` | `bool` | | Only display task IDs | diff --git a/docs/reference/commandline/node_rm.md b/docs/reference/commandline/node_rm.md index 200adfe38577..812c76515e60 100644 --- a/docs/reference/commandline/node_rm.md +++ b/docs/reference/commandline/node_rm.md @@ -9,9 +9,9 @@ Remove one or more nodes from the swarm ### Options -| Name | Type | Default | Description | -|:------------------------------------|:-----|:--------|:-----------------------------------| -| [`-f`](#force), [`--force`](#force) | | | Force remove a node from the swarm | +| Name | Type | Default | Description | +|:------------------------------------|:-------|:--------|:-----------------------------------| +| [`-f`](#force), [`--force`](#force) | `bool` | | Force remove a node from the swarm | diff --git a/docs/reference/commandline/plugin_create.md b/docs/reference/commandline/plugin_create.md index ff1023406ea1..f68f7cfc3e84 100644 --- a/docs/reference/commandline/plugin_create.md +++ b/docs/reference/commandline/plugin_create.md @@ -5,9 +5,9 @@ Create a plugin from a rootfs and configuration. Plugin data directory must cont ### Options -| Name | Type | Default | Description | -|:-------------|:-----|:--------|:--------------------------------| -| `--compress` | | | Compress the context using gzip | +| Name | Type | Default | Description | +|:-------------|:-------|:--------|:--------------------------------| +| `--compress` | `bool` | | Compress the context using gzip | diff --git a/docs/reference/commandline/plugin_disable.md b/docs/reference/commandline/plugin_disable.md index ec1791155db3..42af48446c11 100644 --- a/docs/reference/commandline/plugin_disable.md +++ b/docs/reference/commandline/plugin_disable.md @@ -5,9 +5,9 @@ Disable a plugin ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:--------------------------------------| -| `-f`, `--force` | | | Force the disable of an active plugin | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:--------------------------------------| +| `-f`, `--force` | `bool` | | Force the disable of an active plugin | diff --git a/docs/reference/commandline/plugin_install.md b/docs/reference/commandline/plugin_install.md index 22c3bf2c7cb0..25ceb35c217e 100644 --- a/docs/reference/commandline/plugin_install.md +++ b/docs/reference/commandline/plugin_install.md @@ -8,9 +8,9 @@ Install a plugin | Name | Type | Default | Description | |:--------------------------|:---------|:--------|:--------------------------------------------------| | `--alias` | `string` | | Local name for plugin | -| `--disable` | | | Do not enable the plugin on install | +| `--disable` | `bool` | | Do not enable the plugin on install | | `--disable-content-trust` | `bool` | `true` | Skip image verification | -| `--grant-all-permissions` | | | Grant all permissions necessary to run the plugin | +| `--grant-all-permissions` | `bool` | | Grant all permissions necessary to run the plugin | diff --git a/docs/reference/commandline/plugin_ls.md b/docs/reference/commandline/plugin_ls.md index 894b926fc67c..036aad76c505 100644 --- a/docs/reference/commandline/plugin_ls.md +++ b/docs/reference/commandline/plugin_ls.md @@ -13,8 +13,8 @@ List plugins |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `enabled=true`) | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only display plugin IDs | +| `--no-trunc` | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only display plugin IDs | diff --git a/docs/reference/commandline/plugin_rm.md b/docs/reference/commandline/plugin_rm.md index 1dcd149a3dd9..23ad32f431fd 100644 --- a/docs/reference/commandline/plugin_rm.md +++ b/docs/reference/commandline/plugin_rm.md @@ -9,9 +9,9 @@ Remove one or more plugins ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:--------------------------------------| -| `-f`, `--force` | | | Force the removal of an active plugin | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:--------------------------------------| +| `-f`, `--force` | `bool` | | Force the removal of an active plugin | diff --git a/docs/reference/commandline/plugin_upgrade.md b/docs/reference/commandline/plugin_upgrade.md index c0147c86fdf4..39730104d4b7 100644 --- a/docs/reference/commandline/plugin_upgrade.md +++ b/docs/reference/commandline/plugin_upgrade.md @@ -8,8 +8,8 @@ Upgrade an existing plugin | Name | Type | Default | Description | |:--------------------------|:-------|:--------|:----------------------------------------------------------------------| | `--disable-content-trust` | `bool` | `true` | Skip image verification | -| `--grant-all-permissions` | | | Grant all permissions necessary to run the plugin | -| `--skip-remote-check` | | | Do not check if specified remote plugin matches existing plugin image | +| `--grant-all-permissions` | `bool` | | Grant all permissions necessary to run the plugin | +| `--skip-remote-check` | `bool` | | Do not check if specified remote plugin matches existing plugin image | diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md index 57fcc6199ab2..5d1cf16fcf6e 100644 --- a/docs/reference/commandline/ps.md +++ b/docs/reference/commandline/ps.md @@ -11,14 +11,14 @@ List containers | Name | Type | Default | Description | |:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all containers (default shows just running) | +| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | | `-f`, `--filter` | `filter` | | Filter output based on conditions provided | | `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | `-n`, `--last` | `int` | `-1` | Show n last created containers (includes all states) | -| `-l`, `--latest` | | | Show the latest created container (includes all states) | -| `--no-trunc` | | | Don't truncate output | -| `-q`, `--quiet` | | | Only display container IDs | -| `-s`, `--size` | | | Display total file sizes | +| `-l`, `--latest` | `bool` | | Show the latest created container (includes all states) | +| `--no-trunc` | `bool` | | Don't truncate output | +| `-q`, `--quiet` | `bool` | | Only display container IDs | +| `-s`, `--size` | `bool` | | Display total file sizes | diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index f100262fefba..66acb611da1b 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -11,10 +11,10 @@ Download an image from a registry | Name | Type | Default | Description | |:--------------------------|:---------|:--------|:-------------------------------------------------| -| `-a`, `--all-tags` | | | Download all tagged images in the repository | +| `-a`, `--all-tags` | `bool` | | Download all tagged images in the repository | | `--disable-content-trust` | `bool` | `true` | Skip image verification | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `-q`, `--quiet` | | | Suppress verbose output | +| `-q`, `--quiet` | `bool` | | Suppress verbose output | diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index b49467e99609..2d8358d6ff7f 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -11,10 +11,10 @@ Upload an image to a registry | Name | Type | Default | Description | |:--------------------------|:---------|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all-tags` | | | Push all tags of an image to the repository | +| `-a`, `--all-tags` | `bool` | | Push all tags of an image to the repository | | `--disable-content-trust` | `bool` | `true` | Skip image signing | | `--platform` | `string` | | Push a platform-specific manifest as a single-platform image to the registry.
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64) | -| `-q`, `--quiet` | | | Suppress verbose output | +| `-q`, `--quiet` | `bool` | | Suppress verbose output | diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md index 0c0bf058208e..4f9d92f42255 100644 --- a/docs/reference/commandline/rm.md +++ b/docs/reference/commandline/rm.md @@ -9,11 +9,11 @@ Remove one or more containers ### Options -| Name | Type | Default | Description | -|:------------------|:-----|:--------|:--------------------------------------------------------| -| `-f`, `--force` | | | Force the removal of a running container (uses SIGKILL) | -| `-l`, `--link` | | | Remove the specified link | -| `-v`, `--volumes` | | | Remove anonymous volumes associated with the container | +| Name | Type | Default | Description | +|:------------------|:-------|:--------|:--------------------------------------------------------| +| `-f`, `--force` | `bool` | | Force the removal of a running container (uses SIGKILL) | +| `-l`, `--link` | `bool` | | Remove the specified link | +| `-v`, `--volumes` | `bool` | | Remove anonymous volumes associated with the container | diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index 574fa03114d7..6aac0b757bf5 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -9,10 +9,10 @@ Remove one or more images ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------------------| -| `-f`, `--force` | | | Force removal of the image | -| `--no-prune` | | | Do not delete untagged parents | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:-------------------------------| +| `-f`, `--force` | `bool` | | Force removal of the image | +| `--no-prune` | `bool` | | Do not delete untagged parents | diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index d7913196efa2..f9e0fbfcf26a 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -31,7 +31,7 @@ Create and run a new container from an image | `--cpus` | `decimal` | | Number of CPUs | | `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) | | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) | -| `-d`, `--detach` | | | Run container in background and print container ID | +| `-d`, `--detach` | `bool` | | Run container in background and print container ID | | `--detach-keys` | `string` | | Override the key sequence for detaching a container | | `--device` | `list` | | Add a host device to the container | | `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list | @@ -56,10 +56,10 @@ Create and run a new container from an image | `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) | | `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) | | `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) | -| `--help` | | | Print usage | +| `--help` | `bool` | | Print usage | | `-h`, `--hostname` | `string` | | Container host name | -| `--init` | | | Run an init inside the container that forwards signals and reaps processes | -| `-i`, `--interactive` | | | Keep STDIN open even if not attached | +| `--init` | `bool` | | Run an init inside the container that forwards signals and reaps processes | +| `-i`, `--interactive` | `bool` | | Keep STDIN open even if not attached | | `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) | | `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) | | `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) | @@ -82,20 +82,20 @@ Create and run a new container from an image | `--name` | `string` | | Assign a name to the container | | `--network` | `network` | | Connect a container to a network | | `--network-alias` | `list` | | Add network-scoped alias for the container | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--oom-kill-disable` | | | Disable OOM Killer | +| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK | +| `--oom-kill-disable` | `bool` | | Disable OOM Killer | | `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) | | `--pid` | `string` | | PID namespace to use | | `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) | | `--platform` | `string` | | Set platform if server is multi-platform capable | -| `--privileged` | | | Give extended privileges to this container | +| `--privileged` | `bool` | | Give extended privileges to this container | | `-p`, `--publish` | `list` | | Publish a container's port(s) to the host | -| `-P`, `--publish-all` | | | Publish all exposed ports to random ports | +| `-P`, `--publish-all` | `bool` | | Publish all exposed ports to random ports | | `--pull` | `string` | `missing` | Pull image before running (`always`, `missing`, `never`) | -| `-q`, `--quiet` | | | Suppress the pull output | -| `--read-only` | | | Mount the container's root filesystem as read only | +| `-q`, `--quiet` | `bool` | | Suppress the pull output | +| `--read-only` | `bool` | | Mount the container's root filesystem as read only | | `--restart` | `string` | `no` | Restart policy to apply when a container exits | -| `--rm` | | | Automatically remove the container and its associated anonymous volumes when it exits | +| `--rm` | `bool` | | Automatically remove the container and its associated anonymous volumes when it exits | | `--runtime` | `string` | | Runtime to use for this container | | `--security-opt` | `list` | | Security Options | | `--shm-size` | `bytes` | `0` | Size of /dev/shm | @@ -105,7 +105,7 @@ Create and run a new container from an image | `--storage-opt` | `list` | | Storage driver options for the container | | `--sysctl` | `map` | `map[]` | Sysctl options | | `--tmpfs` | `list` | | Mount a tmpfs directory | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `--ulimit` | `ulimit` | | Ulimit options | | `-u`, `--user` | `string` | | Username or UID (format: [:]) | | `--userns` | `string` | | User namespace to use | diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index ddfbb8b3ebf8..d9d653039dc8 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -10,7 +10,7 @@ Search Docker Hub for images | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Pretty-print search using a Go template | | [`--limit`](#limit) | `int` | `0` | Max number of search results | -| [`--no-trunc`](#no-trunc) | | | Don't truncate output | +| [`--no-trunc`](#no-trunc) | `bool` | | Don't truncate output | diff --git a/docs/reference/commandline/secret_inspect.md b/docs/reference/commandline/secret_inspect.md index ba672bb2e03b..b5781d64f79a 100644 --- a/docs/reference/commandline/secret_inspect.md +++ b/docs/reference/commandline/secret_inspect.md @@ -8,7 +8,7 @@ Display detailed information on one or more secrets | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--pretty` | | | Print the information in a human friendly format | +| `--pretty` | `bool` | | Print the information in a human friendly format | diff --git a/docs/reference/commandline/secret_ls.md b/docs/reference/commandline/secret_ls.md index 53abd742f5a2..856334e3674a 100644 --- a/docs/reference/commandline/secret_ls.md +++ b/docs/reference/commandline/secret_ls.md @@ -13,7 +13,7 @@ List secrets |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only display IDs | +| `-q`, `--quiet` | `bool` | | Only display IDs | diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index 32d274694e0e..db821e2afe41 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -13,7 +13,7 @@ Create a new service | [`--constraint`](#constraint) | `list` | | Placement constraints | | `--container-label` | `list` | | Container labels | | `--credential-spec` | `credential-spec` | | Credential spec for managed service account (Windows only) | -| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | +| `-d`, `--detach` | `bool` | | Exit immediately instead of waiting for the service to converge | | `--dns` | `list` | | Set custom DNS servers | | `--dns-option` | `list` | | Set DNS options | | `--dns-search` | `list` | | Set custom DNS search domains | @@ -31,7 +31,7 @@ Create a new service | `--health-timeout` | `duration` | | Maximum time to allow one check to run (ms\|s\|m\|h) | | `--host` | `list` | | Set one or more custom host-to-IP mappings (host:ip) | | [`--hostname`](#hostname) | `string` | | Container hostname | -| `--init` | | | Use an init inside each service container to forward signals and reap processes | +| `--init` | `bool` | | Use an init inside each service container to forward signals and reap processes | | [`--isolation`](#isolation) | `string` | | Service container isolation mode | | [`-l`](#label), [`--label`](#label) | `list` | | Service labels | | `--limit-cpu` | `decimal` | | Limit CPUs | @@ -44,12 +44,12 @@ Create a new service | [`--mount`](#mount) | `mount` | | Attach a filesystem mount to the service | | `--name` | `string` | | Service name | | [`--network`](#network) | `network` | | Network attachments | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--no-resolve-image` | | | Do not query the registry to resolve image digest and supported platforms | +| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK | +| `--no-resolve-image` | `bool` | | Do not query the registry to resolve image digest and supported platforms | | [`--placement-pref`](#placement-pref) | `pref` | | Add a placement preference | | [`-p`](#publish), [`--publish`](#publish) | `port` | | Publish a port as a node port | -| `-q`, `--quiet` | | | Suppress progress output | -| `--read-only` | | | Mount the container's root filesystem as read only | +| `-q`, `--quiet` | `bool` | | Suppress progress output | +| `--read-only` | `bool` | | Mount the container's root filesystem as read only | | [`--replicas`](#replicas) | `uint` | | Number of tasks | | [`--replicas-max-per-node`](#replicas-max-per-node) | `uint64` | `0` | Maximum number of tasks per node (default 0 = unlimited) | | `--reserve-cpu` | `decimal` | | Reserve CPUs | @@ -68,7 +68,7 @@ Create a new service | `--stop-grace-period` | `duration` | | Time to wait before force killing a container (ns\|us\|ms\|s\|m\|h) (default 10s) | | `--stop-signal` | `string` | | Signal to stop the container | | `--sysctl` | `list` | | Sysctl options | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `--ulimit` | `ulimit` | | Ulimit options | | [`--update-delay`](#update-delay) | `duration` | `0s` | Delay between updates (ns\|us\|ms\|s\|m\|h) (default 0s) | | `--update-failure-action` | `string` | | Action on update failure (`pause`, `continue`, `rollback`) (default `pause`) | @@ -77,7 +77,7 @@ Create a new service | `--update-order` | `string` | | Update order (`start-first`, `stop-first`) (default `stop-first`) | | `--update-parallelism` | `uint64` | `1` | Maximum number of tasks updated simultaneously (0 to update all at once) | | `-u`, `--user` | `string` | | Username or UID (format: [:]) | -| [`--with-registry-auth`](#with-registry-auth) | | | Send registry authentication details to swarm agents | +| [`--with-registry-auth`](#with-registry-auth) | `bool` | | Send registry authentication details to swarm agents | | `-w`, `--workdir` | `string` | | Working directory inside the container | diff --git a/docs/reference/commandline/service_inspect.md b/docs/reference/commandline/service_inspect.md index 9bfd6f0afdab..97b73864130e 100644 --- a/docs/reference/commandline/service_inspect.md +++ b/docs/reference/commandline/service_inspect.md @@ -8,7 +8,7 @@ Display detailed information on one or more services | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| [`--pretty`](#pretty) | | | Print the information in a human friendly format | +| [`--pretty`](#pretty) | `bool` | | Print the information in a human friendly format | diff --git a/docs/reference/commandline/service_logs.md b/docs/reference/commandline/service_logs.md index 43919400ffe5..6aa9903662e1 100644 --- a/docs/reference/commandline/service_logs.md +++ b/docs/reference/commandline/service_logs.md @@ -7,15 +7,15 @@ Fetch the logs of a service or task | Name | Type | Default | Description | |:---------------------|:---------|:--------|:------------------------------------------------------------------------------------------------| -| `--details` | | | Show extra details provided to logs | -| `-f`, `--follow` | | | Follow log output | -| `--no-resolve` | | | Do not map IDs to Names in output | -| `--no-task-ids` | | | Do not include task IDs in output | -| `--no-trunc` | | | Do not truncate output | -| `--raw` | | | Do not neatly format logs | +| `--details` | `bool` | | Show extra details provided to logs | +| `-f`, `--follow` | `bool` | | Follow log output | +| `--no-resolve` | `bool` | | Do not map IDs to Names in output | +| `--no-task-ids` | `bool` | | Do not include task IDs in output | +| `--no-trunc` | `bool` | | Do not truncate output | +| `--raw` | `bool` | | Do not neatly format logs | | `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) | | `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs | -| `-t`, `--timestamps` | | | Show timestamps | +| `-t`, `--timestamps` | `bool` | | Show timestamps | diff --git a/docs/reference/commandline/service_ls.md b/docs/reference/commandline/service_ls.md index 304568f840c2..789d5396d560 100644 --- a/docs/reference/commandline/service_ls.md +++ b/docs/reference/commandline/service_ls.md @@ -13,7 +13,7 @@ List services |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only display IDs | +| `-q`, `--quiet` | `bool` | | Only display IDs | diff --git a/docs/reference/commandline/service_ps.md b/docs/reference/commandline/service_ps.md index 9736315d71e6..ed570c26cc8c 100644 --- a/docs/reference/commandline/service_ps.md +++ b/docs/reference/commandline/service_ps.md @@ -9,9 +9,9 @@ List the tasks of one or more services |:---------------------------------------|:---------|:--------|:-------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Pretty-print tasks using a Go template | -| `--no-resolve` | | | Do not map IDs to Names | -| `--no-trunc` | | | Do not truncate output | -| `-q`, `--quiet` | | | Only display task IDs | +| `--no-resolve` | `bool` | | Do not map IDs to Names | +| `--no-trunc` | `bool` | | Do not truncate output | +| `-q`, `--quiet` | `bool` | | Only display task IDs | diff --git a/docs/reference/commandline/service_rollback.md b/docs/reference/commandline/service_rollback.md index 52aaf1ce3969..50b5413990ce 100644 --- a/docs/reference/commandline/service_rollback.md +++ b/docs/reference/commandline/service_rollback.md @@ -5,10 +5,10 @@ Revert changes to a service's configuration ### Options -| Name | Type | Default | Description | -|:-----------------|:-----|:--------|:----------------------------------------------------------------| -| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | -| `-q`, `--quiet` | | | Suppress progress output | +| Name | Type | Default | Description | +|:-----------------|:-------|:--------|:----------------------------------------------------------------| +| `-d`, `--detach` | `bool` | | Exit immediately instead of waiting for the service to converge | +| `-q`, `--quiet` | `bool` | | Suppress progress output | diff --git a/docs/reference/commandline/service_scale.md b/docs/reference/commandline/service_scale.md index 594e6aea9b90..9e611769dfc5 100644 --- a/docs/reference/commandline/service_scale.md +++ b/docs/reference/commandline/service_scale.md @@ -5,9 +5,9 @@ Scale one or multiple replicated services ### Options -| Name | Type | Default | Description | -|:-----------------|:-----|:--------|:----------------------------------------------------------------| -| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | +| Name | Type | Default | Description | +|:-----------------|:-------|:--------|:----------------------------------------------------------------| +| `-d`, `--detach` | `bool` | | Exit immediately instead of waiting for the service to converge | diff --git a/docs/reference/commandline/service_update.md b/docs/reference/commandline/service_update.md index 3c9d4ee96091..634b95dac367 100644 --- a/docs/reference/commandline/service_update.md +++ b/docs/reference/commandline/service_update.md @@ -17,7 +17,7 @@ Update a service | `--container-label-add` | `list` | | Add or update a container label | | `--container-label-rm` | `list` | | Remove a container label by its key | | `--credential-spec` | `credential-spec` | | Credential spec for managed service account (Windows only) | -| `-d`, `--detach` | | | Exit immediately instead of waiting for the service to converge | +| `-d`, `--detach` | `bool` | | Exit immediately instead of waiting for the service to converge | | `--dns-add` | `list` | | Add or update a custom DNS server | | `--dns-option-add` | `list` | | Add or update a DNS option | | `--dns-option-rm` | `list` | | Remove a DNS option | @@ -28,7 +28,7 @@ Update a service | `--entrypoint` | `command` | | Overwrite the default ENTRYPOINT of the image | | `--env-add` | `list` | | Add or update an environment variable | | `--env-rm` | `list` | | Remove an environment variable | -| `--force` | | | Force update even if no changes require it | +| `--force` | `bool` | | Force update even if no changes require it | | `--generic-resource-add` | `list` | | Add a Generic resource | | `--generic-resource-rm` | `list` | | Remove a Generic resource | | `--group-add` | `list` | | Add an additional supplementary user group to the container | @@ -43,7 +43,7 @@ Update a service | `--host-rm` | `list` | | Remove a custom host-to-IP mapping (`host:ip`) | | `--hostname` | `string` | | Container hostname | | `--image` | `string` | | Service image tag | -| `--init` | | | Use an init inside each service container to forward signals and reap processes | +| `--init` | `bool` | | Use an init inside each service container to forward signals and reap processes | | [`--isolation`](#isolation) | `string` | | Service container isolation mode | | `--label-add` | `list` | | Add or update a service label | | `--label-rm` | `list` | | Remove a label by its key | @@ -57,14 +57,14 @@ Update a service | `--mount-rm` | `list` | | Remove a mount by its target path | | [`--network-add`](#network-add) | `network` | | Add a network | | `--network-rm` | `list` | | Remove a network | -| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK | -| `--no-resolve-image` | | | Do not query the registry to resolve image digest and supported platforms | +| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK | +| `--no-resolve-image` | `bool` | | Do not query the registry to resolve image digest and supported platforms | | `--placement-pref-add` | `pref` | | Add a placement preference | | `--placement-pref-rm` | `pref` | | Remove a placement preference | | [`--publish-add`](#publish-add) | `port` | | Add or update a published port | | `--publish-rm` | `port` | | Remove a published port by its target port | -| `-q`, `--quiet` | | | Suppress progress output | -| `--read-only` | | | Mount the container's root filesystem as read only | +| `-q`, `--quiet` | `bool` | | Suppress progress output | +| `--read-only` | `bool` | | Mount the container's root filesystem as read only | | `--replicas` | `uint` | | Number of tasks | | `--replicas-max-per-node` | `uint64` | `0` | Maximum number of tasks per node (default 0 = unlimited) | | `--reserve-cpu` | `decimal` | | Reserve CPUs | @@ -73,7 +73,7 @@ Update a service | `--restart-delay` | `duration` | | Delay between restart attempts (ns\|us\|ms\|s\|m\|h) | | `--restart-max-attempts` | `uint` | | Maximum number of restarts before giving up | | `--restart-window` | `duration` | | Window used to evaluate the restart policy (ns\|us\|ms\|s\|m\|h) | -| [`--rollback`](#rollback) | | | Rollback to previous specification | +| [`--rollback`](#rollback) | `bool` | | Rollback to previous specification | | `--rollback-delay` | `duration` | `0s` | Delay between task rollbacks (ns\|us\|ms\|s\|m\|h) | | `--rollback-failure-action` | `string` | | Action on rollback failure (`pause`, `continue`) | | `--rollback-max-failure-ratio` | `float` | `0` | Failure rate to tolerate during a rollback | @@ -86,7 +86,7 @@ Update a service | `--stop-signal` | `string` | | Signal to stop the container | | `--sysctl-add` | `list` | | Add or update a Sysctl option | | `--sysctl-rm` | `list` | | Remove a Sysctl option | -| `-t`, `--tty` | | | Allocate a pseudo-TTY | +| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY | | `--ulimit-add` | `ulimit` | | Add or update a ulimit option | | `--ulimit-rm` | `list` | | Remove a ulimit option | | `--update-delay` | `duration` | `0s` | Delay between updates (ns\|us\|ms\|s\|m\|h) | @@ -96,7 +96,7 @@ Update a service | `--update-order` | `string` | | Update order (`start-first`, `stop-first`) | | [`--update-parallelism`](#update-parallelism) | `uint64` | `0` | Maximum number of tasks updated simultaneously (0 to update all at once) | | `-u`, `--user` | `string` | | Username or UID (format: [:]) | -| `--with-registry-auth` | | | Send registry authentication details to swarm agents | +| `--with-registry-auth` | `bool` | | Send registry authentication details to swarm agents | | `-w`, `--workdir` | `string` | | Working directory inside the container | diff --git a/docs/reference/commandline/stack_config.md b/docs/reference/commandline/stack_config.md index 411d6d61527b..0ad91cb8137c 100644 --- a/docs/reference/commandline/stack_config.md +++ b/docs/reference/commandline/stack_config.md @@ -8,7 +8,7 @@ Outputs the final config file, after doing merges and interpolations | Name | Type | Default | Description | |:-----------------------|:--------------|:--------|:--------------------------------------------------| | `-c`, `--compose-file` | `stringSlice` | | Path to a Compose file, or `-` to read from stdin | -| `--skip-interpolation` | | | Skip interpolation and output only merged config | +| `--skip-interpolation` | `bool` | | Skip interpolation and output only merged config | diff --git a/docs/reference/commandline/stack_deploy.md b/docs/reference/commandline/stack_deploy.md index 82934f6f9221..56313b44f807 100644 --- a/docs/reference/commandline/stack_deploy.md +++ b/docs/reference/commandline/stack_deploy.md @@ -13,10 +13,10 @@ Deploy a new stack or update an existing stack |:---------------------------------------------------------|:--------------|:---------|:--------------------------------------------------------------------------------------------------| | [`-c`](#compose-file), [`--compose-file`](#compose-file) | `stringSlice` | | Path to a Compose file, or `-` to read from stdin | | `-d`, `--detach` | `bool` | `true` | Exit immediately instead of waiting for the stack services to converge | -| `--prune` | | | Prune services that are no longer referenced | -| `-q`, `--quiet` | | | Suppress progress output | +| `--prune` | `bool` | | Prune services that are no longer referenced | +| `-q`, `--quiet` | `bool` | | Suppress progress output | | `--resolve-image` | `string` | `always` | Query the registry to resolve image digest and supported platforms (`always`, `changed`, `never`) | -| `--with-registry-auth` | | | Send registry authentication details to Swarm agents | +| `--with-registry-auth` | `bool` | | Send registry authentication details to Swarm agents | diff --git a/docs/reference/commandline/stack_ps.md b/docs/reference/commandline/stack_ps.md index b9d2c4798d17..c7d0c3deafde 100644 --- a/docs/reference/commandline/stack_ps.md +++ b/docs/reference/commandline/stack_ps.md @@ -9,9 +9,9 @@ List the tasks in the stack |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| [`--no-resolve`](#no-resolve) | | | Do not map IDs to Names | -| [`--no-trunc`](#no-trunc) | | | Do not truncate output | -| [`-q`](#quiet), [`--quiet`](#quiet) | | | Only display task IDs | +| [`--no-resolve`](#no-resolve) | `bool` | | Do not map IDs to Names | +| [`--no-trunc`](#no-trunc) | `bool` | | Do not truncate output | +| [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display task IDs | diff --git a/docs/reference/commandline/stack_services.md b/docs/reference/commandline/stack_services.md index 251a6ce336db..db21f96bcafd 100644 --- a/docs/reference/commandline/stack_services.md +++ b/docs/reference/commandline/stack_services.md @@ -9,7 +9,7 @@ List the services in the stack |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only display IDs | +| `-q`, `--quiet` | `bool` | | Only display IDs | diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md index d4ea72a7c112..b89b47deea73 100644 --- a/docs/reference/commandline/start.md +++ b/docs/reference/commandline/start.md @@ -11,11 +11,11 @@ Start one or more stopped containers | Name | Type | Default | Description | |:----------------------|:---------|:--------|:----------------------------------------------------| -| `-a`, `--attach` | | | Attach STDOUT/STDERR and forward signals | +| `-a`, `--attach` | `bool` | | Attach STDOUT/STDERR and forward signals | | `--checkpoint` | `string` | | Restore from this checkpoint | | `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory | | `--detach-keys` | `string` | | Override the key sequence for detaching a container | -| `-i`, `--interactive` | | | Attach container's STDIN | +| `-i`, `--interactive` | `bool` | | Attach container's STDIN | diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index f1fec24e4941..efb8cd129155 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -11,10 +11,10 @@ Display a live stream of container(s) resource usage statistics | Name | Type | Default | Description | |:--------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | | | Show all containers (default shows just running) | +| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | | `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-stream` | | | Disable streaming stats and only pull the first result | -| `--no-trunc` | | | Do not truncate output | +| `--no-stream` | `bool` | | Disable streaming stats and only pull the first result | +| `--no-trunc` | `bool` | | Do not truncate output | diff --git a/docs/reference/commandline/swarm_ca.md b/docs/reference/commandline/swarm_ca.md index 28861091732f..b7272591e61f 100644 --- a/docs/reference/commandline/swarm_ca.md +++ b/docs/reference/commandline/swarm_ca.md @@ -10,10 +10,10 @@ Display and rotate the root CA | `--ca-cert` | `pem-file` | | Path to the PEM-formatted root CA certificate to use for the new cluster | | `--ca-key` | `pem-file` | | Path to the PEM-formatted root CA key to use for the new cluster | | `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) | -| [`-d`](#detach), [`--detach`](#detach) | | | Exit immediately instead of waiting for the root rotation to converge | +| [`-d`](#detach), [`--detach`](#detach) | `bool` | | Exit immediately instead of waiting for the root rotation to converge | | `--external-ca` | `external-ca` | | Specifications of one or more certificate signing endpoints | -| `-q`, `--quiet` | | | Suppress progress output | -| [`--rotate`](#rotate) | | | Rotate the swarm CA - if no certificate or key are provided, new ones will be generated | +| `-q`, `--quiet` | `bool` | | Suppress progress output | +| [`--rotate`](#rotate) | `bool` | | Rotate the swarm CA - if no certificate or key are provided, new ones will be generated | diff --git a/docs/reference/commandline/swarm_init.md b/docs/reference/commandline/swarm_init.md index 29897e8d0379..c189a98eedf7 100644 --- a/docs/reference/commandline/swarm_init.md +++ b/docs/reference/commandline/swarm_init.md @@ -8,7 +8,7 @@ Initialize a swarm | Name | Type | Default | Description | |:--------------------------------------------|:--------------|:---------------|:-----------------------------------------------------------------------------------------------------------------------------| | [`--advertise-addr`](#advertise-addr) | `string` | | Advertised address (format: `[:port]`) | -| [`--autolock`](#autolock) | | | Enable manager autolocking (requiring an unlock key to start a stopped manager) | +| [`--autolock`](#autolock) | `bool` | | Enable manager autolocking (requiring an unlock key to start a stopped manager) | | [`--availability`](#availability) | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) | | `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) | | [`--data-path-addr`](#data-path-addr) | `string` | | Address or interface to use for data path traffic (format: ``) | @@ -17,7 +17,7 @@ Initialize a swarm | `--default-addr-pool-mask-length` | `uint32` | `24` | default address pool subnet mask length | | `--dispatcher-heartbeat` | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) | | [`--external-ca`](#external-ca) | `external-ca` | | Specifications of one or more certificate signing endpoints | -| [`--force-new-cluster`](#force-new-cluster) | | | Force create a new cluster from current state | +| [`--force-new-cluster`](#force-new-cluster) | `bool` | | Force create a new cluster from current state | | [`--listen-addr`](#listen-addr) | `node-addr` | `0.0.0.0:2377` | Listen address (format: `[:port]`) | | [`--max-snapshots`](#max-snapshots) | `uint64` | `0` | Number of additional Raft snapshots to retain | | [`--snapshot-interval`](#snapshot-interval) | `uint64` | `10000` | Number of log entries between Raft snapshots | diff --git a/docs/reference/commandline/swarm_join-token.md b/docs/reference/commandline/swarm_join-token.md index 405209f9e1ec..56ba8c04ac90 100644 --- a/docs/reference/commandline/swarm_join-token.md +++ b/docs/reference/commandline/swarm_join-token.md @@ -5,10 +5,10 @@ Manage join tokens ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------| -| `-q`, `--quiet` | | | Only display token | -| `--rotate` | | | Rotate join token | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:-------------------| +| `-q`, `--quiet` | `bool` | | Only display token | +| `--rotate` | `bool` | | Rotate join token | diff --git a/docs/reference/commandline/swarm_leave.md b/docs/reference/commandline/swarm_leave.md index 459daa3a0fb9..41fa8013d0e0 100644 --- a/docs/reference/commandline/swarm_leave.md +++ b/docs/reference/commandline/swarm_leave.md @@ -5,9 +5,9 @@ Leave the swarm ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:------------------------------------------------------| -| `-f`, `--force` | | | Force this node to leave the swarm, ignoring warnings | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:------------------------------------------------------| +| `-f`, `--force` | `bool` | | Force this node to leave the swarm, ignoring warnings | diff --git a/docs/reference/commandline/swarm_unlock-key.md b/docs/reference/commandline/swarm_unlock-key.md index a2bbf72f9087..b5b53ecbbce5 100644 --- a/docs/reference/commandline/swarm_unlock-key.md +++ b/docs/reference/commandline/swarm_unlock-key.md @@ -5,10 +5,10 @@ Manage the unlock key ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:-------------------| -| `-q`, `--quiet` | | | Only display token | -| `--rotate` | | | Rotate unlock key | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:-------------------| +| `-q`, `--quiet` | `bool` | | Only display token | +| `--rotate` | `bool` | | Rotate unlock key | diff --git a/docs/reference/commandline/swarm_update.md b/docs/reference/commandline/swarm_update.md index 4879d2ee5074..dd1650c683fb 100644 --- a/docs/reference/commandline/swarm_update.md +++ b/docs/reference/commandline/swarm_update.md @@ -7,7 +7,7 @@ Update the swarm | Name | Type | Default | Description | |:-------------------------|:--------------|:------------|:------------------------------------------------------------| -| `--autolock` | | | Change manager autolocking setting (true\|false) | +| `--autolock` | `bool` | | Change manager autolocking setting (true\|false) | | `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) | | `--dispatcher-heartbeat` | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) | | `--external-ca` | `external-ca` | | Specifications of one or more certificate signing endpoints | diff --git a/docs/reference/commandline/system_df.md b/docs/reference/commandline/system_df.md index 98906152a706..9837aa93aaf5 100644 --- a/docs/reference/commandline/system_df.md +++ b/docs/reference/commandline/system_df.md @@ -8,7 +8,7 @@ Show docker disk usage | Name | Type | Default | Description | |:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-v`, `--verbose` | | | Show detailed information on space usage | +| `-v`, `--verbose` | `bool` | | Show detailed information on space usage | diff --git a/docs/reference/commandline/system_prune.md b/docs/reference/commandline/system_prune.md index 04b7ace8f762..49d20a564716 100644 --- a/docs/reference/commandline/system_prune.md +++ b/docs/reference/commandline/system_prune.md @@ -7,10 +7,10 @@ Remove unused data | Name | Type | Default | Description | |:----------------------|:---------|:--------|:---------------------------------------------------| -| `-a`, `--all` | | | Remove all unused images not just dangling ones | +| `-a`, `--all` | `bool` | | Remove all unused images not just dangling ones | | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `label==`) | -| `-f`, `--force` | | | Do not prompt for confirmation | -| `--volumes` | | | Prune anonymous volumes | +| `-f`, `--force` | `bool` | | Do not prompt for confirmation | +| `--volumes` | `bool` | | Prune anonymous volumes | diff --git a/docs/reference/commandline/trust_inspect.md b/docs/reference/commandline/trust_inspect.md index 5cb0ac0394b7..11c8ecf6d233 100644 --- a/docs/reference/commandline/trust_inspect.md +++ b/docs/reference/commandline/trust_inspect.md @@ -5,9 +5,9 @@ Return low-level information about keys and signatures ### Options -| Name | Type | Default | Description | -|:-----------|:-----|:--------|:-------------------------------------------------| -| `--pretty` | | | Print the information in a human friendly format | +| Name | Type | Default | Description | +|:-----------|:-------|:--------|:-------------------------------------------------| +| `--pretty` | `bool` | | Print the information in a human friendly format | diff --git a/docs/reference/commandline/trust_revoke.md b/docs/reference/commandline/trust_revoke.md index 06a2aa4eddc4..ed9efa52ab3d 100644 --- a/docs/reference/commandline/trust_revoke.md +++ b/docs/reference/commandline/trust_revoke.md @@ -5,9 +5,9 @@ Remove trust for an image ### Options -| Name | Type | Default | Description | -|:--------------|:-----|:--------|:-------------------------------| -| `-y`, `--yes` | | | Do not prompt for confirmation | +| Name | Type | Default | Description | +|:--------------|:-------|:--------|:-------------------------------| +| `-y`, `--yes` | `bool` | | Do not prompt for confirmation | diff --git a/docs/reference/commandline/trust_sign.md b/docs/reference/commandline/trust_sign.md index c5b8148224f8..c8596d571931 100644 --- a/docs/reference/commandline/trust_sign.md +++ b/docs/reference/commandline/trust_sign.md @@ -5,9 +5,9 @@ Sign an image ### Options -| Name | Type | Default | Description | -|:----------|:-----|:--------|:----------------------------| -| `--local` | | | Sign a locally tagged image | +| Name | Type | Default | Description | +|:----------|:-------|:--------|:----------------------------| +| `--local` | `bool` | | Sign a locally tagged image | diff --git a/docs/reference/commandline/trust_signer_remove.md b/docs/reference/commandline/trust_signer_remove.md index 5e425d5e6f79..2b8d52772934 100644 --- a/docs/reference/commandline/trust_signer_remove.md +++ b/docs/reference/commandline/trust_signer_remove.md @@ -5,9 +5,9 @@ Remove a signer ### Options -| Name | Type | Default | Description | -|:----------------|:-----|:--------|:----------------------------------------------------------------------| -| `-f`, `--force` | | | Do not prompt for confirmation before removing the most recent signer | +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:----------------------------------------------------------------------| +| `-f`, `--force` | `bool` | | Do not prompt for confirmation before removing the most recent signer | diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index e5da1c8bf083..8420080a7347 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -11,10 +11,10 @@ List volumes | Name | Type | Default | Description | |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--cluster` | | | Display only cluster volumes, and use cluster volume list formatting | +| `--cluster` | `bool` | | Display only cluster volumes, and use cluster volume list formatting | | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `dangling=true`) | | [`--format`](#format) | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `-q`, `--quiet` | | | Only display volume names | +| `-q`, `--quiet` | `bool` | | Only display volume names | diff --git a/docs/reference/commandline/volume_prune.md b/docs/reference/commandline/volume_prune.md index d2671fa7a0ed..b0aa7061c524 100644 --- a/docs/reference/commandline/volume_prune.md +++ b/docs/reference/commandline/volume_prune.md @@ -7,9 +7,9 @@ Remove unused local volumes | Name | Type | Default | Description | |:------------------------------|:---------|:--------|:---------------------------------------------------| -| [`-a`](#all), [`--all`](#all) | | | Remove all unused volumes, not just anonymous ones | +| [`-a`](#all), [`--all`](#all) | `bool` | | Remove all unused volumes, not just anonymous ones | | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `label=