| 1 |
command: docker compose build |
| 2 |
short: Build or rebuild services |
| 3 |
long: |- |
| 4 |
Services are built once and then tagged, by default as `project-service`. |
| 5 |
|
| 6 |
If the Compose file specifies an |
| 7 |
[image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name, |
| 8 |
the image is tagged with that name, substituting any variables beforehand. See |
| 9 |
[variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation). |
| 10 |
|
| 11 |
If you change a service's `Dockerfile` or the contents of its build directory, |
| 12 |
run `docker compose build` to rebuild it. |
| 13 |
usage: docker compose build [OPTIONS] [SERVICE...] |
| 14 |
pname: docker compose |
| 15 |
plink: docker_compose.yaml |
| 16 |
options: |
| 17 |
- option: build-arg |
| 18 |
value_type: stringArray |
| 19 |
default_value: '[]' |
| 20 |
description: Set build-time variables for services |
| 21 |
deprecated: false |
| 22 |
hidden: false |
| 23 |
experimental: false |
| 24 |
experimentalcli: false |
| 25 |
kubernetes: false |
| 26 |
swarm: false |
| 27 |
- option: builder |
| 28 |
value_type: string |
| 29 |
description: Set builder to use |
| 30 |
deprecated: false |
| 31 |
hidden: false |
| 32 |
experimental: false |
| 33 |
experimentalcli: false |
| 34 |
kubernetes: false |
| 35 |
swarm: false |
| 36 |
- option: check |
| 37 |
value_type: bool |
| 38 |
default_value: "false" |
| 39 |
description: Check build configuration |
| 40 |
deprecated: false |
| 41 |
hidden: false |
| 42 |
experimental: false |
| 43 |
experimentalcli: false |
| 44 |
kubernetes: false |
| 45 |
swarm: false |
| 46 |
- option: compress |
| 47 |
value_type: bool |
| 48 |
default_value: "true" |
| 49 |
description: Compress the build context using gzip. DEPRECATED |
| 50 |
deprecated: false |
| 51 |
hidden: true |
| 52 |
experimental: false |
| 53 |
experimentalcli: false |
| 54 |
kubernetes: false |
| 55 |
swarm: false |
| 56 |
- option: force-rm |
| 57 |
value_type: bool |
| 58 |
default_value: "true" |
| 59 |
description: Always remove intermediate containers. DEPRECATED |
| 60 |
deprecated: false |
| 61 |
hidden: true |
| 62 |
experimental: false |
| 63 |
experimentalcli: false |
| 64 |
kubernetes: false |
| 65 |
swarm: false |
| 66 |
- option: memory |
| 67 |
shorthand: m |
| 68 |
value_type: bytes |
| 69 |
default_value: "0" |
| 70 |
description: | |
| 71 |
Set memory limit for the build container. Not supported by BuildKit. |
| 72 |
deprecated: false |
| 73 |
hidden: false |
| 74 |
experimental: false |
| 75 |
experimentalcli: false |
| 76 |
kubernetes: false |
| 77 |
swarm: false |
| 78 |
- option: no-cache |
| 79 |
value_type: bool |
| 80 |
default_value: "false" |
| 81 |
description: Do not use cache when building the image |
| 82 |
deprecated: false |
| 83 |
hidden: false |
| 84 |
experimental: false |
| 85 |
experimentalcli: false |
| 86 |
kubernetes: false |
| 87 |
swarm: false |
| 88 |
- option: no-rm |
| 89 |
value_type: bool |
| 90 |
default_value: "false" |
| 91 |
description: | |
| 92 |
Do not remove intermediate containers after a successful build. DEPRECATED |
| 93 |
deprecated: false |
| 94 |
hidden: true |
| 95 |
experimental: false |
| 96 |
experimentalcli: false |
| 97 |
kubernetes: false |
| 98 |
swarm: false |
| 99 |
- option: parallel |
| 100 |
value_type: bool |
| 101 |
default_value: "true" |
| 102 |
description: Build images in parallel. DEPRECATED |
| 103 |
deprecated: false |
| 104 |
hidden: true |
| 105 |
experimental: false |
| 106 |
experimentalcli: false |
| 107 |
kubernetes: false |
| 108 |
swarm: false |
| 109 |
- option: print |
| 110 |
value_type: bool |
| 111 |
default_value: "false" |
| 112 |
description: Print equivalent bake file |
| 113 |
deprecated: false |
| 114 |
hidden: false |
| 115 |
experimental: false |
| 116 |
experimentalcli: false |
| 117 |
kubernetes: false |
| 118 |
swarm: false |
| 119 |
- option: progress |
| 120 |
value_type: string |
| 121 |
description: Set type of ui output (auto, tty, plain, json, quiet) |
| 122 |
deprecated: false |
| 123 |
hidden: true |
| 124 |
experimental: false |
| 125 |
experimentalcli: false |
| 126 |
kubernetes: false |
| 127 |
swarm: false |
| 128 |
- option: provenance |
| 129 |
value_type: string |
| 130 |
description: Add a provenance attestation |
| 131 |
deprecated: false |
| 132 |
hidden: false |
| 133 |
experimental: false |
| 134 |
experimentalcli: false |
| 135 |
kubernetes: false |
| 136 |
swarm: false |
| 137 |
- option: pull |
| 138 |
value_type: bool |
| 139 |
default_value: "false" |
| 140 |
description: Always attempt to pull a newer version of the image |
| 141 |
deprecated: false |
| 142 |
hidden: false |
| 143 |
experimental: false |
| 144 |
experimentalcli: false |
| 145 |
kubernetes: false |
| 146 |
swarm: false |
| 147 |
- option: push |
| 148 |
value_type: bool |
| 149 |
default_value: "false" |
| 150 |
description: Push service images |
| 151 |
deprecated: false |
| 152 |
hidden: false |
| 153 |
experimental: false |
| 154 |
experimentalcli: false |
| 155 |
kubernetes: false |
| 156 |
swarm: false |
| 157 |
- option: quiet |
| 158 |
shorthand: q |
| 159 |
value_type: bool |
| 160 |
default_value: "false" |
| 161 |
description: Suppress the build output |
| 162 |
deprecated: false |
| 163 |
hidden: false |
| 164 |
experimental: false |
| 165 |
experimentalcli: false |
| 166 |
kubernetes: false |
| 167 |
swarm: false |
| 168 |
- option: sbom |
| 169 |
value_type: string |
| 170 |
description: Add a SBOM attestation |
| 171 |
deprecated: false |
| 172 |
hidden: false |
| 173 |
experimental: false |
| 174 |
experimentalcli: false |
| 175 |
kubernetes: false |
| 176 |
swarm: false |
| 177 |
- option: ssh |
| 178 |
value_type: string |
| 179 |
description: | |
| 180 |
Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent) |
| 181 |
deprecated: false |
| 182 |
hidden: false |
| 183 |
experimental: false |
| 184 |
experimentalcli: false |
| 185 |
kubernetes: false |
| 186 |
swarm: false |
| 187 |
- option: with-dependencies |
| 188 |
value_type: bool |
| 189 |
default_value: "false" |
| 190 |
description: Also build dependencies (transitively) |
| 191 |
deprecated: false |
| 192 |
hidden: false |
| 193 |
experimental: false |
| 194 |
experimentalcli: false |
| 195 |
kubernetes: false |
| 196 |
swarm: false |
| 197 |
inherited_options: |
| 198 |
- option: dry-run |
| 199 |
value_type: bool |
| 200 |
default_value: "false" |
| 201 |
description: Execute command in dry run mode |
| 202 |
deprecated: false |
| 203 |
hidden: false |
| 204 |
experimental: false |
| 205 |
experimentalcli: false |
| 206 |
kubernetes: false |
| 207 |
swarm: false |
| 208 |
deprecated: false |
| 209 |
hidden: false |
| 210 |
experimental: false |
| 211 |
experimentalcli: false |
| 212 |
kubernetes: false |
| 213 |
swarm: false |
| 214 |
|