docker_compose_down.yaml 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. command: docker compose down
  2. short: Stop and remove containers, networks
  3. long: |-
  4. Stops containers and removes containers, networks, volumes, and images created by `up`.
  5. By default, the only things removed are:
  6. - Containers for services defined in the Compose file
  7. - Networks defined in the networks section of the Compose file
  8. - The default network, if one is used
  9. Networks and volumes defined as external are never removed.
  10. Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically
  11. mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
  12. named volumes.
  13. usage: docker compose down [OPTIONS] [SERVICES]
  14. pname: docker compose
  15. plink: docker_compose.yaml
  16. options:
  17. - option: remove-orphans
  18. value_type: bool
  19. default_value: "false"
  20. description: Remove containers for services not defined in the Compose file.
  21. deprecated: false
  22. hidden: false
  23. experimental: false
  24. experimentalcli: false
  25. kubernetes: false
  26. swarm: false
  27. - option: rmi
  28. value_type: string
  29. description: |
  30. Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
  31. deprecated: false
  32. hidden: false
  33. experimental: false
  34. experimentalcli: false
  35. kubernetes: false
  36. swarm: false
  37. - option: timeout
  38. shorthand: t
  39. value_type: int
  40. default_value: "0"
  41. description: Specify a shutdown timeout in seconds
  42. deprecated: false
  43. hidden: false
  44. experimental: false
  45. experimentalcli: false
  46. kubernetes: false
  47. swarm: false
  48. - option: volumes
  49. shorthand: v
  50. value_type: bool
  51. default_value: "false"
  52. description: |
  53. Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers.
  54. deprecated: false
  55. hidden: false
  56. experimental: false
  57. experimentalcli: false
  58. kubernetes: false
  59. swarm: false
  60. inherited_options:
  61. - option: dry-run
  62. value_type: bool
  63. default_value: "false"
  64. description: Execute command in dry run mode
  65. deprecated: false
  66. hidden: false
  67. experimental: false
  68. experimentalcli: false
  69. kubernetes: false
  70. swarm: false
  71. deprecated: false
  72. experimental: false
  73. experimentalcli: false
  74. kubernetes: false
  75. swarm: false