Debian Codegraph @

docs/reference/docker_compose_down.yaml

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