docker_compose_up.yaml 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. command: docker compose up
  2. short: Create and start containers
  3. long: Create and start containers
  4. usage: docker compose up [SERVICE...]
  5. pname: docker compose
  6. plink: docker_compose.yaml
  7. options:
  8. - option: abort-on-container-exit
  9. value_type: bool
  10. default_value: "false"
  11. description: |
  12. Stops all containers if any container was stopped. Incompatible with -d
  13. deprecated: false
  14. experimental: false
  15. experimentalcli: false
  16. kubernetes: false
  17. swarm: false
  18. - option: always-recreate-deps
  19. value_type: bool
  20. default_value: "false"
  21. description: |
  22. Recreate dependent containers. Incompatible with --no-recreate.
  23. deprecated: false
  24. experimental: false
  25. experimentalcli: false
  26. kubernetes: false
  27. swarm: false
  28. - option: attach-dependencies
  29. value_type: bool
  30. default_value: "false"
  31. description: Attach to dependent containers.
  32. deprecated: false
  33. experimental: false
  34. experimentalcli: false
  35. kubernetes: false
  36. swarm: false
  37. - option: build
  38. value_type: bool
  39. default_value: "false"
  40. description: Build images before starting containers.
  41. deprecated: false
  42. experimental: false
  43. experimentalcli: false
  44. kubernetes: false
  45. swarm: false
  46. - option: detach
  47. shorthand: d
  48. value_type: bool
  49. default_value: "false"
  50. description: 'Detached mode: Run containers in the background'
  51. deprecated: false
  52. experimental: false
  53. experimentalcli: false
  54. kubernetes: false
  55. swarm: false
  56. - option: environment
  57. shorthand: e
  58. value_type: stringArray
  59. default_value: '[]'
  60. description: Environment variables
  61. deprecated: false
  62. experimental: false
  63. experimentalcli: false
  64. kubernetes: false
  65. swarm: false
  66. - option: exit-code-from
  67. value_type: string
  68. description: |
  69. Return the exit code of the selected service container. Implies --abort-on-container-exit
  70. deprecated: false
  71. experimental: false
  72. experimentalcli: false
  73. kubernetes: false
  74. swarm: false
  75. - option: force-recreate
  76. value_type: bool
  77. default_value: "false"
  78. description: |
  79. Recreate containers even if their configuration and image haven't changed.
  80. deprecated: false
  81. experimental: false
  82. experimentalcli: false
  83. kubernetes: false
  84. swarm: false
  85. - option: no-build
  86. value_type: bool
  87. default_value: "false"
  88. description: Don't build an image, even if it's missing.
  89. deprecated: false
  90. experimental: false
  91. experimentalcli: false
  92. kubernetes: false
  93. swarm: false
  94. - option: no-color
  95. value_type: bool
  96. default_value: "false"
  97. description: Produce monochrome output.
  98. deprecated: false
  99. experimental: false
  100. experimentalcli: false
  101. kubernetes: false
  102. swarm: false
  103. - option: no-deps
  104. value_type: bool
  105. default_value: "false"
  106. description: Don't start linked services.
  107. deprecated: false
  108. experimental: false
  109. experimentalcli: false
  110. kubernetes: false
  111. swarm: false
  112. - option: no-log-prefix
  113. value_type: bool
  114. default_value: "false"
  115. description: Don't print prefix in logs.
  116. deprecated: false
  117. experimental: false
  118. experimentalcli: false
  119. kubernetes: false
  120. swarm: false
  121. - option: no-recreate
  122. value_type: bool
  123. default_value: "false"
  124. description: |
  125. If containers already exist, don't recreate them. Incompatible with --force-recreate.
  126. deprecated: false
  127. experimental: false
  128. experimentalcli: false
  129. kubernetes: false
  130. swarm: false
  131. - option: no-start
  132. value_type: bool
  133. default_value: "false"
  134. description: Don't start the services after creating them.
  135. deprecated: false
  136. experimental: false
  137. experimentalcli: false
  138. kubernetes: false
  139. swarm: false
  140. - option: remove-orphans
  141. value_type: bool
  142. default_value: "false"
  143. description: |
  144. Remove containers for services not defined in the Compose file.
  145. deprecated: false
  146. experimental: false
  147. experimentalcli: false
  148. kubernetes: false
  149. swarm: false
  150. - option: renew-anon-volumes
  151. shorthand: V
  152. value_type: bool
  153. default_value: "false"
  154. description: |
  155. Recreate anonymous volumes instead of retrieving data from the previous containers.
  156. deprecated: false
  157. experimental: false
  158. experimentalcli: false
  159. kubernetes: false
  160. swarm: false
  161. - option: scale
  162. value_type: stringArray
  163. default_value: '[]'
  164. description: |
  165. Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
  166. deprecated: false
  167. experimental: false
  168. experimentalcli: false
  169. kubernetes: false
  170. swarm: false
  171. - option: timeout
  172. shorthand: t
  173. value_type: int
  174. default_value: "10"
  175. description: |
  176. Use this timeout in seconds for container shutdown when attached or when containers are already running.
  177. deprecated: false
  178. experimental: false
  179. experimentalcli: false
  180. kubernetes: false
  181. swarm: false
  182. deprecated: false
  183. experimental: false
  184. experimentalcli: false
  185. kubernetes: false
  186. swarm: false