docker_compose_exec.yaml 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. command: docker compose exec
  2. short: Execute a command in a running container.
  3. long: Execute a command in a running container.
  4. usage: docker compose exec [options] [-e KEY=VAL...] [--] SERVICE COMMAND [ARGS...]
  5. pname: docker compose
  6. plink: docker_compose.yaml
  7. options:
  8. - option: ""
  9. shorthand: T
  10. value_type: bool
  11. default_value: "false"
  12. description: |
  13. Disable pseudo-tty allocation. By default `docker compose exec` allocates a TTY.
  14. deprecated: false
  15. experimental: false
  16. experimentalcli: false
  17. kubernetes: false
  18. swarm: false
  19. - option: detach
  20. shorthand: d
  21. value_type: bool
  22. default_value: "false"
  23. description: 'Detached mode: Run command in the background.'
  24. deprecated: false
  25. experimental: false
  26. experimentalcli: false
  27. kubernetes: false
  28. swarm: false
  29. - option: env
  30. shorthand: e
  31. value_type: stringArray
  32. default_value: '[]'
  33. description: Set environment variables
  34. deprecated: false
  35. experimental: false
  36. experimentalcli: false
  37. kubernetes: false
  38. swarm: false
  39. - option: index
  40. value_type: int
  41. default_value: "1"
  42. description: |
  43. index of the container if there are multiple instances of a service [default: 1].
  44. deprecated: false
  45. experimental: false
  46. experimentalcli: false
  47. kubernetes: false
  48. swarm: false
  49. - option: privileged
  50. value_type: bool
  51. default_value: "false"
  52. description: Give extended privileges to the process.
  53. deprecated: false
  54. experimental: false
  55. experimentalcli: false
  56. kubernetes: false
  57. swarm: false
  58. - option: user
  59. shorthand: u
  60. value_type: string
  61. description: Run the command as this user.
  62. deprecated: false
  63. experimental: false
  64. experimentalcli: false
  65. kubernetes: false
  66. swarm: false
  67. - option: workdir
  68. shorthand: w
  69. value_type: string
  70. description: Path to workdir directory for this command.
  71. deprecated: false
  72. experimental: false
  73. experimentalcli: false
  74. kubernetes: false
  75. swarm: false
  76. deprecated: false
  77. experimental: false
  78. experimentalcli: false
  79. kubernetes: false
  80. swarm: false