docker_compose_build.yaml 4.5 KB

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