docker_compose_build.yaml 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  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/master/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/master/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: compress
  35. value_type: bool
  36. default_value: "true"
  37. description: Compress the build context using gzip. DEPRECATED
  38. deprecated: false
  39. hidden: true
  40. experimental: false
  41. experimentalcli: false
  42. kubernetes: false
  43. swarm: false
  44. - option: force-rm
  45. value_type: bool
  46. default_value: "true"
  47. description: Always remove intermediate containers. DEPRECATED
  48. deprecated: false
  49. hidden: true
  50. experimental: false
  51. experimentalcli: false
  52. kubernetes: false
  53. swarm: false
  54. - option: memory
  55. shorthand: m
  56. value_type: bytes
  57. default_value: "0"
  58. description: |
  59. Set memory limit for the build container. Not supported by BuildKit.
  60. deprecated: false
  61. hidden: false
  62. experimental: false
  63. experimentalcli: false
  64. kubernetes: false
  65. swarm: false
  66. - option: no-cache
  67. value_type: bool
  68. default_value: "false"
  69. description: Do not use cache when building the image
  70. deprecated: false
  71. hidden: false
  72. experimental: false
  73. experimentalcli: false
  74. kubernetes: false
  75. swarm: false
  76. - option: no-rm
  77. value_type: bool
  78. default_value: "false"
  79. description: |
  80. Do not remove intermediate containers after a successful build. DEPRECATED
  81. deprecated: false
  82. hidden: true
  83. experimental: false
  84. experimentalcli: false
  85. kubernetes: false
  86. swarm: false
  87. - option: parallel
  88. value_type: bool
  89. default_value: "true"
  90. description: Build images in parallel. DEPRECATED
  91. deprecated: false
  92. hidden: true
  93. experimental: false
  94. experimentalcli: false
  95. kubernetes: false
  96. swarm: false
  97. - option: progress
  98. value_type: string
  99. default_value: auto
  100. description: Set type of ui output (auto, tty, plain, json, quiet)
  101. deprecated: false
  102. hidden: true
  103. experimental: false
  104. experimentalcli: false
  105. kubernetes: false
  106. swarm: false
  107. - option: pull
  108. value_type: bool
  109. default_value: "false"
  110. description: Always attempt to pull a newer version of the image
  111. deprecated: false
  112. hidden: false
  113. experimental: false
  114. experimentalcli: false
  115. kubernetes: false
  116. swarm: false
  117. - option: push
  118. value_type: bool
  119. default_value: "false"
  120. description: Push service images
  121. deprecated: false
  122. hidden: false
  123. experimental: false
  124. experimentalcli: false
  125. kubernetes: false
  126. swarm: false
  127. - option: quiet
  128. shorthand: q
  129. value_type: bool
  130. default_value: "false"
  131. description: Don't print anything to STDOUT
  132. deprecated: false
  133. hidden: false
  134. experimental: false
  135. experimentalcli: false
  136. kubernetes: false
  137. swarm: false
  138. - option: ssh
  139. value_type: string
  140. description: |
  141. Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent)
  142. deprecated: false
  143. hidden: false
  144. experimental: false
  145. experimentalcli: false
  146. kubernetes: false
  147. swarm: false
  148. - option: with-dependencies
  149. value_type: bool
  150. default_value: "false"
  151. description: Also build dependencies (transitively)
  152. deprecated: false
  153. hidden: false
  154. experimental: false
  155. experimentalcli: false
  156. kubernetes: false
  157. swarm: false
  158. inherited_options:
  159. - option: dry-run
  160. value_type: bool
  161. default_value: "false"
  162. description: Execute command in dry run mode
  163. deprecated: false
  164. hidden: false
  165. experimental: false
  166. experimentalcli: false
  167. kubernetes: false
  168. swarm: false
  169. deprecated: false
  170. hidden: false
  171. experimental: false
  172. experimentalcli: false
  173. kubernetes: false
  174. swarm: false