github.com/pdmccormick/importable-docker-buildx@v0.0.0-20240426161518-e47091289030/docs/reference/buildx_debug_build.md (about)

     1  # docker buildx debug build
     2  
     3  <!---MARKER_GEN_START-->
     4  Start a build
     5  
     6  ### Aliases
     7  
     8  `docker buildx debug build`, `docker buildx debug b`
     9  
    10  ### Options
    11  
    12  | Name                                                                                                                                               | Type          | Default   | Description                                                                                         |
    13  |:---------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------------|
    14  | [`--add-host`](https://docs.docker.com/reference/cli/docker/image/build/#add-host)                                                                 | `stringSlice` |           | Add a custom host-to-IP mapping (format: `host:ip`)                                                 |
    15  | `--allow`                                                                                                                                          | `stringSlice` |           | Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`)                      |
    16  | `--annotation`                                                                                                                                     | `stringArray` |           | Add annotation to the image                                                                         |
    17  | `--attest`                                                                                                                                         | `stringArray` |           | Attestation parameters (format: `type=sbom,generator=image`)                                        |
    18  | `--build-arg`                                                                                                                                      | `stringArray` |           | Set build-time variables                                                                            |
    19  | `--build-context`                                                                                                                                  | `stringArray` |           | Additional build contexts (e.g., name=path)                                                         |
    20  | `--builder`                                                                                                                                        | `string`      |           | Override the configured builder instance                                                            |
    21  | `--cache-from`                                                                                                                                     | `stringArray` |           | External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`)                       |
    22  | `--cache-to`                                                                                                                                       | `stringArray` |           | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`)                   |
    23  | [`--cgroup-parent`](https://docs.docker.com/reference/cli/docker/image/build/#cgroup-parent)                                                       | `string`      |           | Set the parent cgroup for the `RUN` instructions during build                                       |
    24  | `--detach`                                                                                                                                         |               |           | Detach buildx server (supported only on linux) (EXPERIMENTAL)                                       |
    25  | [`-f`](https://docs.docker.com/reference/cli/docker/image/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/image/build/#file) | `string`      |           | Name of the Dockerfile (default: `PATH/Dockerfile`)                                                 |
    26  | `--iidfile`                                                                                                                                        | `string`      |           | Write the image ID to a file                                                                        |
    27  | `--label`                                                                                                                                          | `stringArray` |           | Set metadata for an image                                                                           |
    28  | `--load`                                                                                                                                           |               |           | Shorthand for `--output=type=docker`                                                                |
    29  | `--metadata-file`                                                                                                                                  | `string`      |           | Write build result metadata to a file                                                               |
    30  | `--network`                                                                                                                                        | `string`      | `default` | Set the networking mode for the `RUN` instructions during build                                     |
    31  | `--no-cache`                                                                                                                                       |               |           | Do not use cache when building the image                                                            |
    32  | `--no-cache-filter`                                                                                                                                | `stringArray` |           | Do not cache specified stages                                                                       |
    33  | `-o`, `--output`                                                                                                                                   | `stringArray` |           | Output destination (format: `type=local,dest=path`)                                                 |
    34  | `--platform`                                                                                                                                       | `stringArray` |           | Set target platform for build                                                                       |
    35  | `--print`                                                                                                                                          | `string`      |           | Print result of information request (e.g., outline, targets) (EXPERIMENTAL)                         |
    36  | `--progress`                                                                                                                                       | `string`      | `auto`    | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output            |
    37  | `--provenance`                                                                                                                                     | `string`      |           | Shorthand for `--attest=type=provenance`                                                            |
    38  | `--pull`                                                                                                                                           |               |           | Always attempt to pull all referenced images                                                        |
    39  | `--push`                                                                                                                                           |               |           | Shorthand for `--output=type=registry`                                                              |
    40  | `-q`, `--quiet`                                                                                                                                    |               |           | Suppress the build output and print image ID on success                                             |
    41  | `--root`                                                                                                                                           | `string`      |           | Specify root directory of server to connect (EXPERIMENTAL)                                          |
    42  | `--sbom`                                                                                                                                           | `string`      |           | Shorthand for `--attest=type=sbom`                                                                  |
    43  | `--secret`                                                                                                                                         | `stringArray` |           | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`)                           |
    44  | `--server-config`                                                                                                                                  | `string`      |           | Specify buildx server config file (used only when launching new server) (EXPERIMENTAL)              |
    45  | `--shm-size`                                                                                                                                       | `bytes`       | `0`       | Shared memory size for build containers                                                             |
    46  | `--ssh`                                                                                                                                            | `stringArray` |           | SSH agent socket or keys to expose to the build (format: `default\|<id>[=<socket>\|<key>[,<key>]]`) |
    47  | [`-t`](https://docs.docker.com/reference/cli/docker/image/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/image/build/#tag)    | `stringArray` |           | Name and optionally a tag (format: `name:tag`)                                                      |
    48  | [`--target`](https://docs.docker.com/reference/cli/docker/image/build/#target)                                                                     | `string`      |           | Set the target build stage to build                                                                 |
    49  | `--ulimit`                                                                                                                                         | `ulimit`      |           | Ulimit options                                                                                      |
    50  
    51  
    52  <!---MARKER_GEN_END-->
    53