data/engine-cli: update to 28.2.0

vvoland · vvoland · commit fae74c20cf38 · 2025-05-28T21:01:00.000+02:00
Signed-off-by: Paweł Gronowski &lt;pawel.gronowski@docker.com&gt;
diff --git a/data/engine-cli/docker.yaml b/data/engine-cli/docker.yaml
@@ -339,6 +339,7 @@ long: |-
     list of root Certificate Authorities.
 cname:
     - docker attach
+    - docker bake
     - docker build
     - docker builder
     - docker checkpoint
@@ -397,6 +398,7 @@ cname:
     - docker wait
 clink:
     - docker_attach.yaml
+    - docker_bake.yaml
     - docker_build.yaml
     - docker_builder.yaml
     - docker_checkpoint.yaml
diff --git a/data/engine-cli/docker_bake.yaml b/data/engine-cli/docker_bake.yaml
@@ -0,0 +1,26 @@
+command: docker bake
+aliases: docker buildx bake
+short: Build from a file
+long: Build from a file
+usage: docker bake [OPTIONS] [TARGET...]
+pname: docker
+plink: docker.yaml
+inherited_options:
+    - option: help
+      value_type: bool
+      default_value: "false"
+      description: Print usage
+      deprecated: false
+      hidden: true
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+deprecated: false
+hidden: false
+min_api_version: "1.31"
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+
diff --git a/data/engine-cli/docker_container_create.yaml b/data/engine-cli/docker_container_create.yaml
@@ -971,6 +971,16 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: use-api-socket
+      value_type: bool
+      default_value: "false"
+      description: Bind mount Docker API socket and required auth
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: true
+      kubernetes: false
+      swarm: false
     - option: user
       shorthand: u
       value_type: string
diff --git a/data/engine-cli/docker_container_run.yaml b/data/engine-cli/docker_container_run.yaml
@@ -1024,6 +1024,16 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: use-api-socket
+      value_type: bool
+      default_value: "false"
+      description: Bind mount Docker API socket and required auth
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
     - option: user
       shorthand: u
       value_type: string
@@ -1356,7 +1366,7 @@ examples: |-
     ### Set working directory (-w, --workdir) {#workdir}
 
     ```console
-    $ docker run -w /path/to/dir/ -i -t ubuntu pwd
+    $ docker run -w /path/to/dir/ ubuntu pwd
     ```
 
     The `-w` option runs the command executed inside the directory specified, in this example,
diff --git a/data/engine-cli/docker_create.yaml b/data/engine-cli/docker_create.yaml
@@ -954,6 +954,16 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: use-api-socket
+      value_type: bool
+      default_value: "false"
+      description: Bind mount Docker API socket and required auth
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: true
+      kubernetes: false
+      swarm: false
     - option: user
       shorthand: u
       value_type: string
diff --git a/data/engine-cli/docker_image_build.yaml b/data/engine-cli/docker_image_build.yaml
@@ -51,7 +51,7 @@ long: |-
     file to exclude files and directories that you don't require in your build from
     being sent as part of the build context.
 
-    #### Access paths outside the build context
+    #### Accessing paths outside the build context
 
     The legacy builder will error out if you try to access files outside of the
     build context using relative paths in your Dockerfile.
diff --git a/data/engine-cli/docker_image_import.yaml b/data/engine-cli/docker_image_import.yaml
@@ -9,10 +9,6 @@ long: |-
     (root). If you specify an individual file, you must specify the full path within
     the host. To import from a remote location, specify a `URI` that begins with the
     `http://` or `https://` protocol.
-
-    The `--change` option applies `Dockerfile` instructions to the image that is
-    created. Supported `Dockerfile` instructions:
-    `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
 usage: docker image import [OPTIONS] file|URL|- [REPOSITORY[:TAG]]
 pname: docker image
 plink: docker_image.yaml
@@ -21,6 +17,7 @@ options:
       shorthand: c
       value_type: list
       description: Apply Dockerfile instruction to the created image
+      details_url: '#change'
       deprecated: false
       hidden: false
       experimental: false
@@ -31,6 +28,7 @@ options:
       shorthand: m
       value_type: string
       description: Set commit message for imported image
+      details_url: '#message'
       deprecated: false
       hidden: false
       experimental: false
@@ -40,6 +38,7 @@ options:
     - option: platform
       value_type: string
       description: Set platform if server is multi-platform capable
+      details_url: '#platform'
       deprecated: false
       hidden: false
       min_api_version: "1.32"
@@ -75,12 +74,6 @@ examples: |-
     $ cat exampleimage.tgz | docker import - exampleimagelocal:new
     ```
 
-    Import with a commit message.
-
-    ```console
-    $ cat exampleimage.tgz | docker import --message "New image imported from tarball" - exampleimagelocal:new
-    ```
-
     Import to docker from a local archive.
 
     ```console
@@ -93,16 +86,109 @@ examples: |-
     $ sudo tar -c . | docker import - exampleimagedir
     ```
 
-    ### Import from a local directory with new configurations
-
-    ```console
-    $ sudo tar -c . | docker import --change "ENV DEBUG=true" - exampleimagedir
-    ```
-
     Note the `sudo` in this example – you must preserve
     the ownership of the files (especially root ownership) during the
     archiving with tar. If you are not root (or the sudo command) when you
     tar, then the ownerships might not get preserved.
+
+    ### Import with new configurations (-c, --change) {#change}
+
+    The `--change` option applies `Dockerfile` instructions to the image that is
+    created. Not all `Dockerfile` instructions are supported; the list of instructions
+    is limited to metadata (configuration) changes. The following `Dockerfile`
+    instructions are supported:
+
+    - [`CMD`](/reference/dockerfile/#cmd)
+    - [`ENTRYPOINT`](/reference/dockerfile/#entrypoint)
+    - [`ENV`](/reference/dockerfile/#env)
+    - [`EXPOSE`](/reference/dockerfile/#expose)
+    - [`HEALTHCHECK`](/reference/dockerfile/#healthcheck)
+    - [`LABEL`](/reference/dockerfile/#label)
+    - [`ONBUILD`](/reference/dockerfile/#onbuild)
+    - [`STOPSIGNAL`](/reference/dockerfile/#stopsignal)
+    - [`USER`](/reference/dockerfile/#user)
+    - [`VOLUME`](/reference/dockerfile/#volume)
+    - [`WORKDIR`](/reference/dockerfile/#workdir)
+
+    The following example imports an image from a TAR-file containing a root-filesystem,
+    and sets the `DEBUG` environment-variable in the resulting image:
+
+    ```console
+    $ docker import --change "ENV DEBUG=true" ./rootfs.tgz exampleimagedir
+    ```
+
+    The `--change` option can be set multiple times to apply multiple `Dockerfile`
+    instructions. The example below sets the `LABEL1` and `LABEL2` labels on
+    the imported image, in addition to the `DEBUG` environment variable from
+    the previous example:
+
+    ```console
+    $ docker import \
+        --change "ENV DEBUG=true" \
+        --change "LABEL LABEL1=hello" \
+        --change "LABEL LABEL2=world" \
+        ./rootfs.tgz exampleimagedir
+    ```
+
+    ### Import with a commit message (-m, --message) {#message}
+
+    The `--message`  (or `-m`) option allows you to set a custom comment in
+    the image's metadata. The following example imports an image from a local
+    archive and sets a custom message.
+
+    ```console
+    $ docker import --message "New image imported from tarball" ./rootfs.tgz exampleimagelocal:new
+    sha256:25e54c0df7dc49da9093d50541e0ed4508a6b78705057f1a9bebf1d564e2cb00
+    ```
+
+    After importing, the message is set in the "Comment" field of the image's
+    configuration, which is shown when viewing the image's history:
+
+    ```console
+    $ docker image history exampleimagelocal:new
+
+    IMAGE          CREATED         CREATED BY   SIZE      COMMENT
+    25e54c0df7dc   2 minutes ago                53.6MB    New image imported from tarball
+    ```
+
+    ### When the daemon supports multiple operating systems
+
+    If the daemon supports multiple operating systems, and the image being imported
+    does not match the default operating system, it may be necessary to add
+    `--platform`. This would be necessary when importing a Linux image into a Windows
+    daemon.
+
+    ```console
+    $ docker import --platform=linux .\linuximage.tar
+    ```
+
+    ### Set the platform for the imported image (--platform) {#platform}
+
+    The `--platform` option allows you to specify the platform for the imported
+    image. By default, the daemon's native platform is used as platform, but
+    the `--platform` option allows you to override the default, for example, in
+    situations where the imported root filesystem is for a different architecture
+    or operating system.
+
+    The platform option takes the `os[/arch[/variant]]` format; for example,
+    `linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
+    and default to the daemon's native architecture if omitted.
+
+    The following example imports an image from a root-filesystem in `rootfs.tgz`,
+    and sets the image's platform to `linux/amd64`;
+
+    ```console
+    $ docker image import --platform=linux/amd64  ./rootfs.tgz imported:latest
+    sha256:44a8b44157dad5edcff85f0c93a3e455f3b20a046d025af4ec50ed990d7ebc09
+    ```
+
+    After importing the image, the image's platform is set in the image's
+    configuration;
+
+    ```console
+    $ docker image inspect --format '{{.Os}}/{{.Architecture}}' imported:latest
+    linux/amd64
+    ```
 deprecated: false
 hidden: false
 experimental: false
diff --git a/data/engine-cli/docker_image_inspect.yaml b/data/engine-cli/docker_image_inspect.yaml
@@ -19,6 +19,19 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: platform
+      value_type: string
+      description: |-
+        Inspect a specific platform of the multi-platform image.
+        If the image or the server is not multi-platform capable, the command will error out if the platform does not match.
+        'os[/arch[/variant]]': Explicit platform (eg. linux/amd64)
+      deprecated: false
+      hidden: false
+      min_api_version: "1.49"
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 inherited_options:
     - option: help
       value_type: bool
diff --git a/data/engine-cli/docker_image_rm.yaml b/data/engine-cli/docker_image_rm.yaml
@@ -35,6 +35,19 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: platform
+      value_type: stringSlice
+      default_value: '[]'
+      description: |
+        Remove only the given platform variant. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)
+      details_url: '#platform'
+      deprecated: false
+      hidden: false
+      min_api_version: "1.50"
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 inherited_options:
     - option: help
       value_type: bool
@@ -122,6 +135,76 @@ examples: |-
     Deleted: ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2
     Deleted: df7546f9f060a2268024c8a230d8639878585defcc1bc6f79d2728a13957871b
     ```
+
+    ### Remove specific platforms (`--platform`) {#platform}
+
+    The `--platform` option allows you to specify which platform variants of the
+    image to remove. By default, `docker image remove` removes all platform variants
+    that are present. Use the `--platform` option to specify which platform variant
+    of the image to remove.
+
+    Removing a specific platform removes the image from all images that reference
+    the same content, and requires the `--force` option to be used. Omitting the
+    `--force` option produces a warning, and the remove is canceled:
+
+    ```console
+    $ docker image rm --platform=linux/amd64 alpine
+    Error response from daemon: Content will be removed from all images referencing this variant. Use —-force to force delete.
+    ```
+
+    The platform option takes the `os[/arch[/variant]]` format; for example,
+    `linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
+    and default to the daemon's native architecture if omitted.
+
+    You can pass multiple platforms either by passing the `--platform` flag
+    multiple times, or by passing a comma-separated list of platforms to remove.
+    The following uses of this option are equivalent;
+
+    ```console
+    $ docker image rm --plaform linux/amd64 --platform linux/ppc64le myimage
+    $ docker image rm --plaform linux/amd64,linux/ppc64le myimage
+    ```
+
+    The following example removes the `linux/amd64` and `linux/ppc64le` variants
+    of an `alpine` image that contains multiple platform variants in the image
+    cache:
+
+    ```console
+    $ docker image ls --tree
+
+    IMAGE                   ID             DISK USAGE   CONTENT SIZE   EXTRA
+    alpine:latest           a8560b36e8b8       37.8MB         11.2MB    U
+    ├─ linux/amd64          1c4eef651f65       12.1MB         3.64MB    U
+    ├─ linux/arm/v6         903bfe2ae994           0B             0B
+    ├─ linux/arm/v7         9c2d245b3c01           0B             0B
+    ├─ linux/arm64/v8       757d680068d7       12.8MB         3.99MB
+    ├─ linux/386            2436f2b3b7d2           0B             0B
+    ├─ linux/ppc64le        9ed53fd3b831       12.8MB         3.58MB
+    ├─ linux/riscv64        1de5eb4a9a67           0B             0B
+    └─ linux/s390x          fe0dcdd1f783           0B             0B
+
+    $ docker image --platform=linux/amd64,linux/ppc64le --force alpine
+    Deleted: sha256:1c4eef651f65e2f7daee7ee785882ac164b02b78fb74503052a26dc061c90474
+    Deleted: sha256:9ed53fd3b83120f78b33685d930ce9bf5aa481f6e2d165c42cbbddbeaa196f6f
+    ```
+
+    After the command completes, the given variants of the `alpine` image are removed
+    from the image cache:
+
+    ```console
+    $ docker image ls --tree
+
+    IMAGE                   ID             DISK USAGE   CONTENT SIZE   EXTRA
+    alpine:latest           a8560b36e8b8       12.8MB         3.99MB
+    ├─ linux/amd64          1c4eef651f65           0B             0B
+    ├─ linux/arm/v6         903bfe2ae994           0B             0B
+    ├─ linux/arm/v7         9c2d245b3c01           0B             0B
+    ├─ linux/arm64/v8       757d680068d7       12.8MB         3.99MB
+    ├─ linux/386            2436f2b3b7d2           0B             0B
+    ├─ linux/ppc64le        9ed53fd3b831           0B             0B
+    ├─ linux/riscv64        1de5eb4a9a67           0B             0B
+    └─ linux/s390x          fe0dcdd1f783           0B             0B
+    ```
 deprecated: false
 hidden: false
 experimental: false
diff --git a/data/engine-cli/docker_inspect.yaml b/data/engine-cli/docker_inspect.yaml
diff --git a/data/engine-cli/docker_rmi.yaml b/data/engine-cli/docker_rmi.yaml
diff --git a/data/engine-cli/docker_run.yaml b/data/engine-cli/docker_run.yaml
diff --git a/data/engine-cli/docker_search.yaml b/data/engine-cli/docker_search.yaml
