docker_compose_build.yaml 5.9 KB

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