Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions data/engine-cli/docker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ long: |-
| `DOCKER_API_VERSION` | Override the negotiated API version to use for debugging (e.g. `1.19`) |
| `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the `docker` CLI and the [`dockerd` daemon](/reference/cli/dockerd/) |
| `DOCKER_CONFIG` | The location of your client configuration files. |
| `DOCKER_CONTENT_TRUST_SERVER` | The URL of the Notary server to use. Defaults to the same URL as the registry. |
| `DOCKER_CONTENT_TRUST` | When set Docker uses notary to sign and verify images. Equates to `--disable-content-trust=false` for build, create, pull, push, run. |
| `DOCKER_CONTEXT` | Name of the `docker context` to use (overrides `DOCKER_HOST` env var and default context set with `docker context use`) |
| `DOCKER_CUSTOM_HEADERS` | (Experimental) Configure [custom HTTP headers](#custom-http-headers) to be sent by the client. Headers must be provided as a comma-separated list of `name=value` pairs. This is the equivalent to the `HttpHeaders` field in the configuration file. |
| `DOCKER_DEFAULT_PLATFORM` | Default platform for commands that take the `--platform` flag. |
Expand All @@ -47,6 +45,8 @@ long: |-
| `DOCKER_TLS` | Enable TLS for connections made by the `docker` CLI (equivalent of the `--tls` command-line option). Set to a non-empty value to enable TLS. Note that TLS is enabled automatically if any of the other TLS options are set. |
| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](/reference/cli/dockerd/) |
| `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`) when [building](/reference/cli/docker/image/build/) with [BuildKit backend](/build/buildkit/). Use plain to show container output (default `auto`). |
| `NO_COLOR` | Disable any ANSI escape codes in the output in accordance with https://no-color.org/
|

Because Docker is developed using Go, you can also use any environment
variables used by the Go runtime. In particular, you may find these useful:
Expand Down Expand Up @@ -234,8 +234,8 @@ long: |-

These settings are used to configure proxy settings for containers only, and not
used as proxy settings for the `docker` CLI or the `dockerd` daemon. Refer to the
[environment variables](#environment-variables) and [HTTP/HTTPS proxy](/engine/daemon/proxy/#httphttps-proxy)
sections for configuring proxy settings for the CLI and daemon.
[environment variables](#environment-variables) section and the [Daemon proxy configuration](/engine/daemon/proxy/)
guide for configuring proxy settings for the CLI and daemon.

> [!WARNING]
> Proxy settings may contain sensitive information (for example, if the proxy
Expand Down Expand Up @@ -390,7 +390,6 @@ cname:
- docker system
- docker tag
- docker top
- docker trust
- docker unpause
- docker update
- docker version
Expand Down Expand Up @@ -449,7 +448,6 @@ clink:
- docker_system.yaml
- docker_tag.yaml
- docker_top.yaml
- docker_trust.yaml
- docker_unpause.yaml
- docker_update.yaml
- docker_version.yaml
Expand Down Expand Up @@ -500,7 +498,7 @@ options:
swarm: false
- option: host
shorthand: H
value_type: list
value_type: string
description: Daemon socket to connect to
details_url: '#host'
deprecated: false
Expand Down
6 changes: 3 additions & 3 deletions data/engine-cli/docker_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
6 changes: 3 additions & 3 deletions data/engine-cli/docker_builder_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
16 changes: 13 additions & 3 deletions data/engine-cli/docker_commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,23 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-pause
value_type: bool
default_value: "false"
description: Disable pausing container during commit
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause
shorthand: p
value_type: bool
default_value: "true"
description: Pause container during commit
deprecated: false
hidden: false
description: 'Pause container during commit (deprecated: use --no-pause instead)'
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
16 changes: 13 additions & 3 deletions data/engine-cli/docker_container_commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,23 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: no-pause
value_type: bool
default_value: "false"
description: Disable pausing container during commit
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pause
shorthand: p
value_type: bool
default_value: "true"
description: Pause container during commit
deprecated: false
hidden: false
description: 'Pause container during commit (deprecated: use --no-pause instead)'
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
18 changes: 10 additions & 8 deletions data/engine-cli/docker_container_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -290,9 +290,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down Expand Up @@ -527,7 +527,8 @@ options:
swarm: false
os_type: windows
- option: ip
value_type: string
value_type: ip
default_value: <nil>
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
hidden: false
Expand All @@ -536,7 +537,8 @@ options:
kubernetes: false
swarm: false
- option: ip6
value_type: string
value_type: ip
default_value: <nil>
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
hidden: false
Expand Down Expand Up @@ -565,9 +567,9 @@ options:
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
hidden: false
description: Kernel memory limit (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
22 changes: 13 additions & 9 deletions data/engine-cli/docker_container_run.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down Expand Up @@ -546,7 +546,8 @@ options:
swarm: false
os_type: windows
- option: ip
value_type: string
value_type: ip
default_value: <nil>
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
hidden: false
Expand All @@ -555,7 +556,8 @@ options:
kubernetes: false
swarm: false
- option: ip6
value_type: string
value_type: ip
default_value: <nil>
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
hidden: false
Expand Down Expand Up @@ -586,9 +588,9 @@ options:
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
hidden: false
description: Kernel memory limit (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down Expand Up @@ -2262,7 +2264,9 @@ examples: |-
It's conventional to use `host.docker.internal` as the hostname referring to
`host-gateway`. Docker Desktop automatically resolves this hostname, see
[Explore networking features](/desktop/features/networking/networking-how-tos/#connect-a-container-to-a-service-on-the-host).
[Explore networking how-tos on Docker Desktop](/desktop/features/networking/networking-how-tos/#connect-a-container-to-a-service-on-the-host)
and
[Configure host gateway IP](/reference/cli/dockerd/#configure-host-gateway-ip).
The following example shows how the special `host-gateway` value works. The
example runs an HTTP server that serves a file from host to container over the
Expand Down
18 changes: 10 additions & 8 deletions data/engine-cli/docker_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -273,9 +273,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down Expand Up @@ -510,7 +510,8 @@ options:
swarm: false
os_type: windows
- option: ip
value_type: string
value_type: ip
default_value: <nil>
description: IPv4 address (e.g., 172.30.100.104)
deprecated: false
hidden: false
Expand All @@ -519,7 +520,8 @@ options:
kubernetes: false
swarm: false
- option: ip6
value_type: string
value_type: ip
default_value: <nil>
description: IPv6 address (e.g., 2001:db8::33)
deprecated: false
hidden: false
Expand Down Expand Up @@ -548,9 +550,9 @@ options:
- option: kernel-memory
value_type: bytes
default_value: "0"
description: Kernel memory limit
deprecated: false
hidden: false
description: Kernel memory limit (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
32 changes: 16 additions & 16 deletions data/engine-cli/docker_image_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down Expand Up @@ -470,22 +470,22 @@ examples: |-
```console
Client: Docker Engine - Community
Version: 23.0.3
API version: 1.42
Go version: go1.19.7
Git commit: 3e7cbfd
Built: Tue Apr 4 22:05:41 2023
OS/Arch: darwin/amd64
Context: default
Version: 28.5.1
API version: 1.51
Go version: go1.24.8
Git commit: e180ab8
Built: Wed Oct 8 12:16:17 2025
OS/Arch: darwin/arm64
Context: desktop-linux
Server: Docker Engine - Community
Engine:
Version: 23.0.3
API version: 1.42 (minimum version 1.12)
Go version: go1.19.7
Git commit: 59118bf
Built: Tue Apr 4 22:05:41 2023
OS/Arch: linux/amd64
Version: 28.5.1
API version: 1.51 (minimum version 1.24)
Go version: go1.24.8
Git commit: f8215cc
Built: Wed Oct 8 12:18:25 2025
OS/Arch: linux/arm64
Experimental: true
[...]
```
Expand Down
5 changes: 3 additions & 2 deletions data/engine-cli/docker_image_load.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ options:
kubernetes: false
swarm: false
- option: platform
value_type: string
value_type: stringSlice
default_value: '[]'
description: |
Load only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
Load only the given platform(s). Formatted as a comma-separated list of `os[/arch[/variant]]` (e.g., `linux/amd64,linux/arm64/v8`).
details_url: '#platform'
deprecated: false
hidden: false
Expand Down
9 changes: 6 additions & 3 deletions data/engine-cli/docker_image_ls.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ long: |-
allowing each step to be cached. These intermediate layers are not shown
by default.

Untagged (dangling) images are also hidden by default. Use the `-a` (`--all`)
flag to show intermediate layers and dangling images.

The `SIZE` is the cumulative space taken up by the image and all
its parent images. This is also the disk space used by the contents of the
Tar file created when you `docker save` an image.
Expand All @@ -25,7 +28,7 @@ options:
shorthand: a
value_type: bool
default_value: "false"
description: Show all images (default hides intermediate images)
description: Show all images (default hides intermediate and dangling images)
deprecated: false
hidden: false
experimental: false
Expand Down Expand Up @@ -415,8 +418,8 @@ examples: |-

```console
$ docker images --format json
{"Containers":"N/A","CreatedAt":"2021-03-04 03:24:42 +0100 CET","CreatedSince":"5 days ago","Digest":"\u003cnone\u003e","ID":"4dd97cefde62","Repository":"ubuntu","SharedSize":"N/A","Size":"72.9MB","Tag":"latest","UniqueSize":"N/A","VirtualSize":"72.9MB"}
{"Containers":"N/A","CreatedAt":"2021-02-17 22:19:54 +0100 CET","CreatedSince":"2 weeks ago","Digest":"\u003cnone\u003e","ID":"28f6e2705743","Repository":"alpine","SharedSize":"N/A","Size":"5.61MB","Tag":"latest","UniqueSize":"N/A","VirtualSize":"5.613MB"}
{"Containers":"N/A","CreatedAt":"2021-03-04 03:24:42 +0100 CET","CreatedSince":"5 days ago","Digest":"\u003cnone\u003e","ID":"4dd97cefde62","Repository":"ubuntu","SharedSize":"N/A","Size":"72.9MB","Tag":"latest","UniqueSize":"N/A"}
{"Containers":"N/A","CreatedAt":"2021-02-17 22:19:54 +0100 CET","CreatedSince":"2 weeks ago","Digest":"\u003cnone\u003e","ID":"28f6e2705743","Repository":"alpine","SharedSize":"N/A","Size":"5.61MB","Tag":"latest","UniqueSize":"N/A"}
```
deprecated: false
hidden: false
Expand Down
6 changes: 3 additions & 3 deletions data/engine-cli/docker_image_pull.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ options:
- option: disable-content-trust
value_type: bool
default_value: "true"
description: Skip image verification
deprecated: false
hidden: false
description: Skip image verification (deprecated)
deprecated: true
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
Loading
Loading