docker_compose_config.yaml 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. command: docker compose config
  2. aliases: docker compose config, docker compose convert
  3. short: Parse, resolve and render compose file in canonical format
  4. long: |-
  5. `docker compose config` renders the actual data model to be applied on the Docker engine.
  6. it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
  7. the canonical format.
  8. usage: docker compose config [OPTIONS] [SERVICE...]
  9. pname: docker compose
  10. plink: docker_compose.yaml
  11. options:
  12. - option: format
  13. value_type: string
  14. default_value: yaml
  15. description: 'Format the output. Values: [yaml | json]'
  16. deprecated: false
  17. hidden: false
  18. experimental: false
  19. experimentalcli: false
  20. kubernetes: false
  21. swarm: false
  22. - option: hash
  23. value_type: string
  24. description: Print the service config hash, one per line.
  25. deprecated: false
  26. hidden: false
  27. experimental: false
  28. experimentalcli: false
  29. kubernetes: false
  30. swarm: false
  31. - option: images
  32. value_type: bool
  33. default_value: "false"
  34. description: Print the image names, one per line.
  35. deprecated: false
  36. hidden: false
  37. experimental: false
  38. experimentalcli: false
  39. kubernetes: false
  40. swarm: false
  41. - option: no-consistency
  42. value_type: bool
  43. default_value: "false"
  44. description: |
  45. Don't check model consistency - warning: may produce invalid Compose output
  46. deprecated: false
  47. hidden: false
  48. experimental: false
  49. experimentalcli: false
  50. kubernetes: false
  51. swarm: false
  52. - option: no-interpolate
  53. value_type: bool
  54. default_value: "false"
  55. description: Don't interpolate environment variables.
  56. deprecated: false
  57. hidden: false
  58. experimental: false
  59. experimentalcli: false
  60. kubernetes: false
  61. swarm: false
  62. - option: no-normalize
  63. value_type: bool
  64. default_value: "false"
  65. description: Don't normalize compose model.
  66. deprecated: false
  67. hidden: false
  68. experimental: false
  69. experimentalcli: false
  70. kubernetes: false
  71. swarm: false
  72. - option: no-path-resolution
  73. value_type: bool
  74. default_value: "false"
  75. description: Don't resolve file paths.
  76. deprecated: false
  77. hidden: false
  78. experimental: false
  79. experimentalcli: false
  80. kubernetes: false
  81. swarm: false
  82. - option: output
  83. shorthand: o
  84. value_type: string
  85. description: Save to file (default to stdout)
  86. deprecated: false
  87. hidden: false
  88. experimental: false
  89. experimentalcli: false
  90. kubernetes: false
  91. swarm: false
  92. - option: profiles
  93. value_type: bool
  94. default_value: "false"
  95. description: Print the profile names, one per line.
  96. deprecated: false
  97. hidden: false
  98. experimental: false
  99. experimentalcli: false
  100. kubernetes: false
  101. swarm: false
  102. - option: quiet
  103. shorthand: q
  104. value_type: bool
  105. default_value: "false"
  106. description: Only validate the configuration, don't print anything.
  107. deprecated: false
  108. hidden: false
  109. experimental: false
  110. experimentalcli: false
  111. kubernetes: false
  112. swarm: false
  113. - option: resolve-image-digests
  114. value_type: bool
  115. default_value: "false"
  116. description: Pin image tags to digests.
  117. deprecated: false
  118. hidden: false
  119. experimental: false
  120. experimentalcli: false
  121. kubernetes: false
  122. swarm: false
  123. - option: services
  124. value_type: bool
  125. default_value: "false"
  126. description: Print the service names, one per line.
  127. deprecated: false
  128. hidden: false
  129. experimental: false
  130. experimentalcli: false
  131. kubernetes: false
  132. swarm: false
  133. - option: volumes
  134. value_type: bool
  135. default_value: "false"
  136. description: Print the volume names, one per line.
  137. deprecated: false
  138. hidden: false
  139. experimental: false
  140. experimentalcli: false
  141. kubernetes: false
  142. swarm: false
  143. inherited_options:
  144. - option: dry-run
  145. value_type: bool
  146. default_value: "false"
  147. description: Execute command in dry run mode
  148. deprecated: false
  149. hidden: false
  150. experimental: false
  151. experimentalcli: false
  152. kubernetes: false
  153. swarm: false
  154. deprecated: false
  155. hidden: false
  156. experimental: false
  157. experimentalcli: false
  158. kubernetes: false
  159. swarm: false