Skip to content

Commit 08ffb4b

Browse files
vvolandvvoland
committed
cli: Update docs
Signed-off-by: Paweł Gronowski <[email protected]>
1 parent fe911f2 commit 08ffb4b

29 files changed

+232
-167
lines changed

‎data/engine-cli/docker.yaml‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ long: |-
3737
| `DOCKER_API_VERSION` | Override the negotiated API version to use for debugging (e.g. `1.19`) |
3838
| `DOCKER_CERT_PATH` | Location of your authentication keys. This variable is used both by the `docker` CLI and the [`dockerd` daemon](/reference/cli/dockerd/) |
3939
| `DOCKER_CONFIG` | The location of your client configuration files. |
40-
| `DOCKER_CONTENT_TRUST_SERVER` | The URL of the Notary server to use. Defaults to the same URL as the registry. |
41-
| `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. |
4240
| `DOCKER_CONTEXT` | Name of the `docker context` to use (overrides `DOCKER_HOST` env var and default context set with `docker context use`) |
4341
| `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. |
4442
| `DOCKER_DEFAULT_PLATFORM` | Default platform for commands that take the `--platform` flag. |
@@ -47,6 +45,8 @@ long: |-
4745
| `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. |
4846
| `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/) |
4947
| `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`). |
48+
| `NO_COLOR` | Disable any ANSI escape codes in the output in accordance with https://no-color.org/
49+
|
5050
5151
Because Docker is developed using Go, you can also use any environment
5252
variables used by the Go runtime. In particular, you may find these useful:
@@ -234,8 +234,8 @@ long: |-
234234
235235
These settings are used to configure proxy settings for containers only, and not
236236
used as proxy settings for the `docker` CLI or the `dockerd` daemon. Refer to the
237-
[environment variables](#environment-variables) and [HTTP/HTTPS proxy](/engine/daemon/proxy/#httphttps-proxy)
238-
sections for configuring proxy settings for the CLI and daemon.
237+
[environment variables](#environment-variables) section and the [Daemon proxy configuration](/engine/daemon/proxy/)
238+
guide for configuring proxy settings for the CLI and daemon.
239239
240240
> [!WARNING]
241241
> Proxy settings may contain sensitive information (for example, if the proxy
@@ -390,7 +390,6 @@ cname:
390390
- docker system
391391
- docker tag
392392
- docker top
393-
- docker trust
394393
- docker unpause
395394
- docker update
396395
- docker version
@@ -449,7 +448,6 @@ clink:
449448
- docker_system.yaml
450449
- docker_tag.yaml
451450
- docker_top.yaml
452-
- docker_trust.yaml
453451
- docker_unpause.yaml
454452
- docker_update.yaml
455453
- docker_version.yaml
@@ -500,7 +498,7 @@ options:
500498
swarm: false
501499
- option: host
502500
shorthand: H
503-
value_type: list
501+
value_type: string
504502
description: Daemon socket to connect to
505503
details_url: '#host'
506504
deprecated: false

‎data/engine-cli/docker_build.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ options:
108108
- option: disable-content-trust
109109
value_type: bool
110110
default_value: "true"
111-
description: Skip image verification
112-
deprecated: false
113-
hidden: false
111+
description: Skip image verification (deprecated)
112+
deprecated: true
113+
hidden: true
114114
experimental: false
115115
experimentalcli: false
116116
kubernetes: false

‎data/engine-cli/docker_builder_build.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ options:
109109
- option: disable-content-trust
110110
value_type: bool
111111
default_value: "true"
112-
description: Skip image verification
113-
deprecated: false
114-
hidden: false
112+
description: Skip image verification (deprecated)
113+
deprecated: true
114+
hidden: true
115115
experimental: false
116116
experimentalcli: false
117117
kubernetes: false

‎data/engine-cli/docker_commit.yaml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,23 @@ options:
3636
experimentalcli: false
3737
kubernetes: false
3838
swarm: false
39+
- option: no-pause
40+
value_type: bool
41+
default_value: "false"
42+
description: Disable pausing container during commit
43+
deprecated: false
44+
hidden: false
45+
experimental: false
46+
experimentalcli: false
47+
kubernetes: false
48+
swarm: false
3949
- option: pause
4050
shorthand: p
4151
value_type: bool
4252
default_value: "true"
43-
description: Pause container during commit
44-
deprecated: false
45-
hidden: false
53+
description: 'Pause container during commit (deprecated: use --no-pause instead)'
54+
deprecated: true
55+
hidden: true
4656
experimental: false
4757
experimentalcli: false
4858
kubernetes: false

‎data/engine-cli/docker_container_commit.yaml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,23 @@ options:
5151
experimentalcli: false
5252
kubernetes: false
5353
swarm: false
54+
- option: no-pause
55+
value_type: bool
56+
default_value: "false"
57+
description: Disable pausing container during commit
58+
deprecated: false
59+
hidden: false
60+
experimental: false
61+
experimentalcli: false
62+
kubernetes: false
63+
swarm: false
5464
- option: pause
5565
shorthand: p
5666
value_type: bool
5767
default_value: "true"
58-
description: Pause container during commit
59-
deprecated: false
60-
hidden: false
68+
description: 'Pause container during commit (deprecated: use --no-pause instead)'
69+
deprecated: true
70+
hidden: true
6171
experimental: false
6272
experimentalcli: false
6373
kubernetes: false

‎data/engine-cli/docker_container_create.yaml‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -290,9 +290,9 @@ options:
290290
- option: disable-content-trust
291291
value_type: bool
292292
default_value: "true"
293-
description: Skip image verification
294-
deprecated: false
295-
hidden: false
293+
description: Skip image verification (deprecated)
294+
deprecated: true
295+
hidden: true
296296
experimental: false
297297
experimentalcli: false
298298
kubernetes: false
@@ -527,7 +527,8 @@ options:
527527
swarm: false
528528
os_type: windows
529529
- option: ip
530-
value_type: string
530+
value_type: ip
531+
default_value: <nil>
531532
description: IPv4 address (e.g., 172.30.100.104)
532533
deprecated: false
533534
hidden: false
@@ -536,7 +537,8 @@ options:
536537
kubernetes: false
537538
swarm: false
538539
- option: ip6
539-
value_type: string
540+
value_type: ip
541+
default_value: <nil>
540542
description: IPv6 address (e.g., 2001:db8::33)
541543
deprecated: false
542544
hidden: false
@@ -565,9 +567,9 @@ options:
565567
- option: kernel-memory
566568
value_type: bytes
567569
default_value: "0"
568-
description: Kernel memory limit
569-
deprecated: false
570-
hidden: false
570+
description: Kernel memory limit (deprecated)
571+
deprecated: true
572+
hidden: true
571573
experimental: false
572574
experimentalcli: false
573575
kubernetes: false

‎data/engine-cli/docker_container_run.yaml‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -305,9 +305,9 @@ options:
305305
- option: disable-content-trust
306306
value_type: bool
307307
default_value: "true"
308-
description: Skip image verification
309-
deprecated: false
310-
hidden: false
308+
description: Skip image verification (deprecated)
309+
deprecated: true
310+
hidden: true
311311
experimental: false
312312
experimentalcli: false
313313
kubernetes: false
@@ -546,7 +546,8 @@ options:
546546
swarm: false
547547
os_type: windows
548548
- option: ip
549-
value_type: string
549+
value_type: ip
550+
default_value: <nil>
550551
description: IPv4 address (e.g., 172.30.100.104)
551552
deprecated: false
552553
hidden: false
@@ -555,7 +556,8 @@ options:
555556
kubernetes: false
556557
swarm: false
557558
- option: ip6
558-
value_type: string
559+
value_type: ip
560+
default_value: <nil>
559561
description: IPv6 address (e.g., 2001:db8::33)
560562
deprecated: false
561563
hidden: false
@@ -586,9 +588,9 @@ options:
586588
- option: kernel-memory
587589
value_type: bytes
588590
default_value: "0"
589-
description: Kernel memory limit
590-
deprecated: false
591-
hidden: false
591+
description: Kernel memory limit (deprecated)
592+
deprecated: true
593+
hidden: true
592594
experimental: false
593595
experimentalcli: false
594596
kubernetes: false
@@ -2262,7 +2264,7 @@ examples: |-
22622264
22632265
It's conventional to use `host.docker.internal` as the hostname referring to
22642266
`host-gateway`. Docker Desktop automatically resolves this hostname, see
2265-
[Explore networking features](/desktop/features/networking/networking-how-tos/#connect-a-container-to-a-service-on-the-host).
2267+
[Explore networking features](/desktop/features/networking/networking-how-tos/#i-want-to-connect-from-a-container-to-a-service-on-the-host).
22662268
22672269
The following example shows how the special `host-gateway` value works. The
22682270
example runs an HTTP server that serves a file from host to container over the

‎data/engine-cli/docker_create.yaml‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,9 @@ options:
273273
- option: disable-content-trust
274274
value_type: bool
275275
default_value: "true"
276-
description: Skip image verification
277-
deprecated: false
278-
hidden: false
276+
description: Skip image verification (deprecated)
277+
deprecated: true
278+
hidden: true
279279
experimental: false
280280
experimentalcli: false
281281
kubernetes: false
@@ -510,7 +510,8 @@ options:
510510
swarm: false
511511
os_type: windows
512512
- option: ip
513-
value_type: string
513+
value_type: ip
514+
default_value: <nil>
514515
description: IPv4 address (e.g., 172.30.100.104)
515516
deprecated: false
516517
hidden: false
@@ -519,7 +520,8 @@ options:
519520
kubernetes: false
520521
swarm: false
521522
- option: ip6
522-
value_type: string
523+
value_type: ip
524+
default_value: <nil>
523525
description: IPv6 address (e.g., 2001:db8::33)
524526
deprecated: false
525527
hidden: false
@@ -548,9 +550,9 @@ options:
548550
- option: kernel-memory
549551
value_type: bytes
550552
default_value: "0"
551-
description: Kernel memory limit
552-
deprecated: false
553-
hidden: false
553+
description: Kernel memory limit (deprecated)
554+
deprecated: true
555+
hidden: true
554556
experimental: false
555557
experimentalcli: false
556558
kubernetes: false

‎data/engine-cli/docker_image_build.yaml‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,9 @@ options:
177177
- option: disable-content-trust
178178
value_type: bool
179179
default_value: "true"
180-
description: Skip image verification
181-
deprecated: false
182-
hidden: false
180+
description: Skip image verification (deprecated)
181+
deprecated: true
182+
hidden: true
183183
experimental: false
184184
experimentalcli: false
185185
kubernetes: false
@@ -470,22 +470,22 @@ examples: |-
470470
471471
```console
472472
Client: Docker Engine - Community
473-
Version: 23.0.3
474-
API version: 1.42
475-
Go version: go1.19.7
476-
Git commit: 3e7cbfd
477-
Built: Tue Apr 4 22:05:41 2023
478-
OS/Arch: darwin/amd64
479-
Context: default
473+
Version: 28.5.1
474+
API version: 1.51
475+
Go version: go1.24.8
476+
Git commit: e180ab8
477+
Built: Wed Oct 8 12:16:17 2025
478+
OS/Arch: darwin/arm64
479+
Context: desktop-linux
480480
481481
Server: Docker Engine - Community
482482
Engine:
483-
Version: 23.0.3
484-
API version: 1.42 (minimum version 1.12)
485-
Go version: go1.19.7
486-
Git commit: 59118bf
487-
Built: Tue Apr 4 22:05:41 2023
488-
OS/Arch: linux/amd64
483+
Version: 28.5.1
484+
API version: 1.51 (minimum version 1.24)
485+
Go version: go1.24.8
486+
Git commit: f8215cc
487+
Built: Wed Oct 8 12:18:25 2025
488+
OS/Arch: linux/arm64
489489
Experimental: true
490490
[...]
491491
```

‎data/engine-cli/docker_image_load.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ options:
2020
kubernetes: false
2121
swarm: false
2222
- option: platform
23-
value_type: string
23+
value_type: stringSlice
24+
default_value: '[]'
2425
description: |
25-
Load only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
26+
Load only the given platform(s). Formatted as a comma-separated list of `os[/arch[/variant]]` (e.g., `linux/amd64,linux/arm64/v8`).
2627
details_url: '#platform'
2728
deprecated: false
2829
hidden: false

0 commit comments

Comments
 (0)