docker_compose_down.yaml 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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
  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: |
  21. Remove containers for services not defined in the Compose file.
  22. deprecated: 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. experimental: false
  33. experimentalcli: false
  34. kubernetes: false
  35. swarm: false
  36. - option: timeout
  37. shorthand: t
  38. value_type: int
  39. default_value: "10"
  40. description: Specify a shutdown timeout in seconds
  41. deprecated: false
  42. experimental: false
  43. experimentalcli: false
  44. kubernetes: false
  45. swarm: false
  46. - option: volumes
  47. shorthand: v
  48. value_type: bool
  49. default_value: "false"
  50. description: |4
  51. Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers.
  52. deprecated: false
  53. experimental: false
  54. experimentalcli: false
  55. kubernetes: false
  56. swarm: false
  57. deprecated: false
  58. experimental: false
  59. experimentalcli: false
  60. kubernetes: false
  61. swarm: false