docker_compose_run.yaml 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. command: docker compose run
  2. short: Run a one-off command on a service.
  3. long: Run a one-off command on a service.
  4. usage: docker compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l
  5. KEY=VALUE...] SERVICE [COMMAND] [ARGS...]
  6. pname: docker compose
  7. plink: docker_compose.yaml
  8. options:
  9. - option: detach
  10. shorthand: d
  11. value_type: bool
  12. default_value: "false"
  13. description: Run container in background and print container ID
  14. deprecated: false
  15. experimental: false
  16. experimentalcli: false
  17. kubernetes: false
  18. swarm: false
  19. - option: entrypoint
  20. value_type: string
  21. description: Override the entrypoint of the image
  22. deprecated: false
  23. experimental: false
  24. experimentalcli: false
  25. kubernetes: false
  26. swarm: false
  27. - option: env
  28. shorthand: e
  29. value_type: stringArray
  30. default_value: '[]'
  31. description: Set environment variables
  32. deprecated: false
  33. experimental: false
  34. experimentalcli: false
  35. kubernetes: false
  36. swarm: false
  37. - option: labels
  38. shorthand: l
  39. value_type: stringArray
  40. default_value: '[]'
  41. description: Add or override a label
  42. deprecated: false
  43. experimental: false
  44. experimentalcli: false
  45. kubernetes: false
  46. swarm: false
  47. - option: name
  48. value_type: string
  49. description: ' Assign a name to the container'
  50. deprecated: false
  51. experimental: false
  52. experimentalcli: false
  53. kubernetes: false
  54. swarm: false
  55. - option: no-TTY
  56. shorthand: T
  57. value_type: bool
  58. default_value: "false"
  59. description: |
  60. Disable pseudo-tty allocation. By default docker compose run allocates a TTY
  61. deprecated: false
  62. experimental: false
  63. experimentalcli: false
  64. kubernetes: false
  65. swarm: false
  66. - option: no-deps
  67. value_type: bool
  68. default_value: "false"
  69. description: Don't start linked services.
  70. deprecated: false
  71. experimental: false
  72. experimentalcli: false
  73. kubernetes: false
  74. swarm: false
  75. - option: publish
  76. shorthand: p
  77. value_type: stringArray
  78. default_value: '[]'
  79. description: Publish a container's port(s) to the host.
  80. deprecated: false
  81. experimental: false
  82. experimentalcli: false
  83. kubernetes: false
  84. swarm: false
  85. - option: rm
  86. value_type: bool
  87. default_value: "false"
  88. description: Automatically remove the container when it exits
  89. deprecated: false
  90. experimental: false
  91. experimentalcli: false
  92. kubernetes: false
  93. swarm: false
  94. - option: service-ports
  95. value_type: bool
  96. default_value: "false"
  97. description: |
  98. Run command with the service's ports enabled and mapped to the host.
  99. deprecated: false
  100. experimental: false
  101. experimentalcli: false
  102. kubernetes: false
  103. swarm: false
  104. - option: use-aliases
  105. value_type: bool
  106. default_value: "false"
  107. description: |
  108. Use the service's network useAliases in the network(s) the container connects to.
  109. deprecated: false
  110. experimental: false
  111. experimentalcli: false
  112. kubernetes: false
  113. swarm: false
  114. - option: user
  115. shorthand: u
  116. value_type: string
  117. description: Run as specified username or uid
  118. deprecated: false
  119. experimental: false
  120. experimentalcli: false
  121. kubernetes: false
  122. swarm: false
  123. - option: volumes
  124. shorthand: v
  125. value_type: stringArray
  126. default_value: '[]'
  127. description: Bind mount a volume.
  128. deprecated: false
  129. experimental: false
  130. experimentalcli: false
  131. kubernetes: false
  132. swarm: false
  133. - option: workdir
  134. shorthand: w
  135. value_type: string
  136. description: Working directory inside the container
  137. deprecated: false
  138. experimental: false
  139. experimentalcli: false
  140. kubernetes: false
  141. swarm: false
  142. deprecated: false
  143. experimental: false
  144. experimentalcli: false
  145. kubernetes: false
  146. swarm: false