File: buildx_build.md

package info (click to toggle)
golang-github-docker-cli-docs-tool 0.8.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 424 kB
  • sloc: makefile: 4
file content (40 lines) | stat: -rw-r--r-- 8,295 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# docker buildx build

<!---MARKER_GEN_START-->
Start a build

### Aliases

`docker image build`, `docker buildx build`, `docker buildx b`, `docker build`

### Options

| Name                                                                                                                                                                                         | Type          | Default   | Description                                                                                          |
|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------|
| [`--add-host`](https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---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`)                       |
| [`--build-arg`](https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg)                                                                            | `stringArray` |           | Set build-time variables                                                                             |
| `--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`)                    |
| [`--cgroup-parent`](https://docs.docker.com/engine/reference/commandline/build/#use-a-custom-parent-cgroup---cgroup-parent)                                                                  | `string`      |           | Optional parent cgroup for the container                                                             |
| `--detach`                                                                                                                                                                                   | `bool`        | `true`    | Dummy flag that tests boolean flags with true as default                                             |
| [`-f`](https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f), [`--file`](https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f) | `string`      |           | Name of the Dockerfile (default: `PATH/Dockerfile`)                                                  |
| `--iidfile`                                                                                                                                                                                  | `string`      |           | Write the image ID to the file                                                                       |
| `--label`                                                                                                                                                                                    | `stringArray` |           | Set metadata for an image                                                                            |
| `--load`                                                                                                                                                                                     | `bool`        |           | Shorthand for `--output=type=docker`                                                                 |
| `--network`                                                                                                                                                                                  | `string`      | `default` | Set the networking mode for the `RUN` instructions during build                                      |
| `-o`, `--output`                                                                                                                                                                             | `stringArray` |           | Output destination (format: `type=local,dest=path`)                                                  |
| `--platform`                                                                                                                                                                                 | `stringArray` | local     | Set target platform for build                                                                        |
| `--push`                                                                                                                                                                                     | `bool`        |           | Shorthand for `--output=type=registry`                                                               |
| `-q`, `--quiet`                                                                                                                                                                              | `bool`        |           | Suppress the build output and print image ID on success                                              |
| `--secret`                                                                                                                                                                                   | `stringArray` |           | Secret file to expose to the build (format: `id=mysecret,src=/local/secret`)                         |
| `--shm-size`                                                                                                                                                                                 | `string`      |           | Size of `/dev/shm`                                                                                   |
| `--ssh`                                                                                                                                                                                      | `stringArray` |           | SSH agent socket or keys to expose to the build<br>format: `default\|<id>[=<socket>\|<key>[,<key>]]` |
| [`-t`](https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t), [`--tag`](https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t)                  | `stringArray` |           | Name and optionally a tag (format: `name:tag`)                                                       |
| [`--target`](https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target)                                                                             | `string`      |           | Set the target build stage to build.                                                                 |
| `--ulimit`                                                                                                                                                                                   | `string`      |           | Ulimit options                                                                                       |


<!---MARKER_GEN_END-->