diff --git a/commands/build.go b/commands/build.go index 7850c1b45e18..264c13400b78 100644 --- a/commands/build.go +++ b/commands/build.go @@ -720,7 +720,7 @@ type commonFlags struct { func commonBuildFlags(options *commonFlags, flags *pflag.FlagSet) { options.noCache = flags.Bool("no-cache", false, "Do not use cache when building the image") - flags.StringVar(&options.progress, "progress", "auto", `Set type of progress output ("auto", "plain", "tty", "rawjson"). Use plain to show container output`) + flags.StringVar(&options.progress, "progress", "auto", `Set type of progress output ("auto", "quiet", "plain", "tty", "rawjson"). Use plain to show container output`) options.pull = flags.Bool("pull", false, "Always attempt to pull all referenced images") flags.StringVar(&options.metadataFile, "metadata-file", "", "Write build result metadata to a file") } diff --git a/docs/reference/buildx_bake.md b/docs/reference/buildx_bake.md index 224d2f112e2a..a2b6ff0c2c14 100644 --- a/docs/reference/buildx_bake.md +++ b/docs/reference/buildx_bake.md @@ -13,25 +13,25 @@ Build from a file ### Options -| Name | Type | Default | Description | -|:------------------------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------| -| `--allow` | `stringArray` | | Allow build to access specified resources | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| [`--call`](#call) | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) | -| [`--check`](#check) | `bool` | | Shorthand for `--call=check` | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`-f`](#file), [`--file`](#file) | `stringArray` | | Build definition file | -| [`--list`](#list) | `string` | | List targets or variables | -| `--load` | `bool` | | Shorthand for `--set=*.output=type=docker` | -| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to a file | -| [`--no-cache`](#no-cache) | `bool` | | Do not use cache when building the image | -| [`--print`](#print) | `bool` | | Print the options without building | -| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output | -| [`--provenance`](#provenance) | `string` | | Shorthand for `--set=*.attest=type=provenance` | -| [`--pull`](#pull) | `bool` | | Always attempt to pull all referenced images | -| `--push` | `bool` | | Shorthand for `--set=*.output=type=registry` | -| [`--sbom`](#sbom) | `string` | | Shorthand for `--set=*.attest=type=sbom` | -| [`--set`](#set) | `stringArray` | | Override target value (e.g., `targetpattern.key=value`) | +| Name | Type | Default | Description | +|:------------------------------------|:--------------|:--------|:-------------------------------------------------------------------------------------------------------------| +| `--allow` | `stringArray` | | Allow build to access specified resources | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| [`--call`](#call) | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) | +| [`--check`](#check) | `bool` | | Shorthand for `--call=check` | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| [`-f`](#file), [`--file`](#file) | `stringArray` | | Build definition file | +| [`--list`](#list) | `string` | | List targets or variables | +| `--load` | `bool` | | Shorthand for `--set=*.output=type=docker` | +| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to a file | +| [`--no-cache`](#no-cache) | `bool` | | Do not use cache when building the image | +| [`--print`](#print) | `bool` | | Print the options without building | +| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `quiet`, `plain`, `tty`, `rawjson`). Use plain to show container output | +| [`--provenance`](#provenance) | `string` | | Shorthand for `--set=*.attest=type=provenance` | +| [`--pull`](#pull) | `bool` | | Always attempt to pull all referenced images | +| `--push` | `bool` | | Shorthand for `--set=*.output=type=registry` | +| [`--sbom`](#sbom) | `string` | | Shorthand for `--set=*.attest=type=sbom` | +| [`--set`](#set) | `stringArray` | | Override target value (e.g., `targetpattern.key=value`) | diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md index 5f97c26c8d66..215eff9aace4 100644 --- a/docs/reference/buildx_build.md +++ b/docs/reference/buildx_build.md @@ -13,46 +13,46 @@ Start a build ### Options -| Name | Type | Default | Description | -|:----------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| -| [`--add-host`](#add-host) | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | -| [`--allow`](#allow) | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | -| [`--annotation`](#annotation) | `stringArray` | | Add annotation to the image | -| [`--attest`](#attest) | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | -| [`--build-arg`](#build-arg) | `stringArray` | | Set build-time variables | -| [`--build-context`](#build-context) | `stringArray` | | Additional build contexts (e.g., name=path) | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| [`--cache-from`](#cache-from) | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | -| [`--cache-to`](#cache-to) | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | -| [`--call`](#call) | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) | -| [`--cgroup-parent`](#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| [`--check`](#check) | `bool` | | Shorthand for `--call=check` | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--detach` | `bool` | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | -| [`-f`](#file), [`--file`](#file) | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | -| `--iidfile` | `string` | | Write the image ID to a file | -| `--label` | `stringArray` | | Set metadata for an image | -| [`--load`](#load) | `bool` | | Shorthand for `--output=type=docker` | -| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to a file | -| [`--network`](#network) | `string` | `default` | Set the networking mode for the `RUN` instructions during build | -| `--no-cache` | `bool` | | Do not use cache when building the image | -| [`--no-cache-filter`](#no-cache-filter) | `stringArray` | | Do not cache specified stages | -| [`-o`](#output), [`--output`](#output) | `stringArray` | | Output destination (format: `type=local,dest=path`) | -| [`--platform`](#platform) | `stringArray` | | Set target platform for build | -| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output | -| [`--provenance`](#provenance) | `string` | | Shorthand for `--attest=type=provenance` | -| `--pull` | `bool` | | Always attempt to pull all referenced images | -| [`--push`](#push) | `bool` | | Shorthand for `--output=type=registry` | -| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | -| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | -| [`--sbom`](#sbom) | `string` | | Shorthand for `--attest=type=sbom` | -| [`--secret`](#secret) | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | -| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | -| [`--shm-size`](#shm-size) | `bytes` | `0` | Shared memory size for build containers | -| [`--ssh`](#ssh) | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | -| [`-t`](#tag), [`--tag`](#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | -| [`--target`](#target) | `string` | | Set the target build stage to build | -| [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | +| Name | Type | Default | Description | +|:----------------------------------------|:--------------|:----------|:-------------------------------------------------------------------------------------------------------------| +| [`--add-host`](#add-host) | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | +| [`--allow`](#allow) | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | +| [`--annotation`](#annotation) | `stringArray` | | Add annotation to the image | +| [`--attest`](#attest) | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | +| [`--build-arg`](#build-arg) | `stringArray` | | Set build-time variables | +| [`--build-context`](#build-context) | `stringArray` | | Additional build contexts (e.g., name=path) | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| [`--cache-from`](#cache-from) | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | +| [`--cache-to`](#cache-to) | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | +| [`--call`](#call) | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) | +| [`--cgroup-parent`](#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | +| [`--check`](#check) | `bool` | | Shorthand for `--call=check` | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--detach` | `bool` | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | +| [`-f`](#file), [`--file`](#file) | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | +| `--iidfile` | `string` | | Write the image ID to a file | +| `--label` | `stringArray` | | Set metadata for an image | +| [`--load`](#load) | `bool` | | Shorthand for `--output=type=docker` | +| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to a file | +| [`--network`](#network) | `string` | `default` | Set the networking mode for the `RUN` instructions during build | +| `--no-cache` | `bool` | | Do not use cache when building the image | +| [`--no-cache-filter`](#no-cache-filter) | `stringArray` | | Do not cache specified stages | +| [`-o`](#output), [`--output`](#output) | `stringArray` | | Output destination (format: `type=local,dest=path`) | +| [`--platform`](#platform) | `stringArray` | | Set target platform for build | +| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `quiet`, `plain`, `tty`, `rawjson`). Use plain to show container output | +| [`--provenance`](#provenance) | `string` | | Shorthand for `--attest=type=provenance` | +| `--pull` | `bool` | | Always attempt to pull all referenced images | +| [`--push`](#push) | `bool` | | Shorthand for `--output=type=registry` | +| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | +| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | +| [`--sbom`](#sbom) | `string` | | Shorthand for `--attest=type=sbom` | +| [`--secret`](#secret) | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | +| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | +| [`--shm-size`](#shm-size) | `bytes` | `0` | Shared memory size for build containers | +| [`--ssh`](#ssh) | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | +| [`-t`](#tag), [`--tag`](#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | +| [`--target`](#target) | `string` | | Set the target build stage to build | +| [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | @@ -828,8 +828,12 @@ $ docker buildx build --platform=darwin . --progress=VALUE ``` -Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use `plain` to show container -output (default `auto`). +Set type of progress output. Supported values are: +- `auto` (default): Uses the `tty` mode if the client is a TTY, or `plain` otherwise +- `tty`: An interactive stream of the output with color and redrawing +- `plain`: Prints the raw build progress in a plaintext format +- `quiet`: Suppress the build output and print image ID on success (same as `--quiet`) +- `rawjson`: Prints the raw build progress as JSON lines > [!NOTE] > You can also use the `BUILDKIT_PROGRESS` environment variable to set its value. diff --git a/docs/reference/buildx_debug_build.md b/docs/reference/buildx_debug_build.md index be0499c2d23a..66340169509f 100644 --- a/docs/reference/buildx_debug_build.md +++ b/docs/reference/buildx_debug_build.md @@ -9,46 +9,46 @@ Start a build ### Options -| Name | Type | Default | Description | -|:--------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------| -| `--add-host` | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | -| `--allow` | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | -| `--annotation` | `stringArray` | | Add annotation to the image | -| `--attest` | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | -| `--build-arg` | `stringArray` | | Set build-time variables | -| `--build-context` | `stringArray` | | Additional build contexts (e.g., name=path) | -| `--builder` | `string` | | Override the configured builder instance | -| `--cache-from` | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | -| `--cache-to` | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | -| `--call` | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) | -| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build | -| `--check` | `bool` | | Shorthand for `--call=check` | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--detach` | `bool` | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | -| `-f`, `--file` | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | -| `--iidfile` | `string` | | Write the image ID to a file | -| `--label` | `stringArray` | | Set metadata for an image | -| `--load` | `bool` | | Shorthand for `--output=type=docker` | -| `--metadata-file` | `string` | | Write build result metadata to a file | -| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build | -| `--no-cache` | `bool` | | Do not use cache when building the image | -| `--no-cache-filter` | `stringArray` | | Do not cache specified stages | -| `-o`, `--output` | `stringArray` | | Output destination (format: `type=local,dest=path`) | -| `--platform` | `stringArray` | | Set target platform for build | -| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output | -| `--provenance` | `string` | | Shorthand for `--attest=type=provenance` | -| `--pull` | `bool` | | Always attempt to pull all referenced images | -| `--push` | `bool` | | Shorthand for `--output=type=registry` | -| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | -| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | -| `--sbom` | `string` | | Shorthand for `--attest=type=sbom` | -| `--secret` | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | -| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | -| `--shm-size` | `bytes` | `0` | Shared memory size for build containers | -| `--ssh` | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | -| `-t`, `--tag` | `stringArray` | | Name and optionally a tag (format: `name:tag`) | -| `--target` | `string` | | Set the target build stage to build | -| `--ulimit` | `ulimit` | | Ulimit options | +| Name | Type | Default | Description | +|:--------------------|:--------------|:----------|:-------------------------------------------------------------------------------------------------------------| +| `--add-host` | `stringSlice` | | Add a custom host-to-IP mapping (format: `host:ip`) | +| `--allow` | `stringSlice` | | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`) | +| `--annotation` | `stringArray` | | Add annotation to the image | +| `--attest` | `stringArray` | | Attestation parameters (format: `type=sbom,generator=image`) | +| `--build-arg` | `stringArray` | | Set build-time variables | +| `--build-context` | `stringArray` | | Additional build contexts (e.g., name=path) | +| `--builder` | `string` | | Override the configured builder instance | +| `--cache-from` | `stringArray` | | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`) | +| `--cache-to` | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | +| `--call` | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) | +| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build | +| `--check` | `bool` | | Shorthand for `--call=check` | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--detach` | `bool` | | Detach buildx server (supported only on linux) (EXPERIMENTAL) | +| `-f`, `--file` | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | +| `--iidfile` | `string` | | Write the image ID to a file | +| `--label` | `stringArray` | | Set metadata for an image | +| `--load` | `bool` | | Shorthand for `--output=type=docker` | +| `--metadata-file` | `string` | | Write build result metadata to a file | +| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build | +| `--no-cache` | `bool` | | Do not use cache when building the image | +| `--no-cache-filter` | `stringArray` | | Do not cache specified stages | +| `-o`, `--output` | `stringArray` | | Output destination (format: `type=local,dest=path`) | +| `--platform` | `stringArray` | | Set target platform for build | +| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `quiet`, `plain`, `tty`, `rawjson`). Use plain to show container output | +| `--provenance` | `string` | | Shorthand for `--attest=type=provenance` | +| `--pull` | `bool` | | Always attempt to pull all referenced images | +| `--push` | `bool` | | Shorthand for `--output=type=registry` | +| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success | +| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) | +| `--sbom` | `string` | | Shorthand for `--attest=type=sbom` | +| `--secret` | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | +| `--server-config` | `string` | | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL) | +| `--shm-size` | `bytes` | `0` | Shared memory size for build containers | +| `--ssh` | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | +| `-t`, `--tag` | `stringArray` | | Name and optionally a tag (format: `name:tag`) | +| `--target` | `string` | | Set the target build stage to build | +| `--ulimit` | `ulimit` | | Ulimit options |