Skip to content

Commit 4ad96f5

Browse files
committed
[wip] docs
Signed-off-by: Joana Hrotko <joana.hrotko@docker.com>
1 parent 176dc79 commit 4ad96f5

File tree

3 files changed

+32
-32
lines changed

3 files changed

+32
-32
lines changed

cmd/compose/up.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ func upCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service, ex
164164
flags.BoolVar(&up.wait, "wait", false, "Wait for services to be running|healthy. Implies detached mode.")
165165
flags.IntVar(&up.waitTimeout, "wait-timeout", 0, "Maximum duration to wait for the project to be running|healthy")
166166
flags.BoolVarP(&up.watch, "watch", "w", false, "Watch source code and rebuild/refresh containers when files are updated.")
167-
flags.BoolVar(&up.navigationMenu, "menu", false, "Enable interactive shortcuts when running attached (Experimental). Incompatible with --detach.")
167+
flags.BoolVar(&up.navigationMenu, "menu", false, "(Experimental) Enable interactive shortcuts when running attached. Incompatible with --detach. Alternatively, you can enable/disable this by setting COMPOSE_MENU environment variable.")
168168

169169
return upCmd
170170
}

docs/reference/compose_up.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,36 @@ Create and start containers
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:-------------------------------|:--------------|:---------|:--------------------------------------------------------------------------------------------------------|
10-
| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d |
11-
| `--abort-on-container-failure` | | | Stops all containers if any container exited with failure. Incompatible with -d |
12-
| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. |
13-
| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. |
14-
| `--attach-dependencies` | | | Automatically attach to log output of dependent services |
15-
| `--build` | | | Build images before starting containers |
16-
| `-d`, `--detach` | | | Detached mode: Run containers in the background |
17-
| `--dry-run` | | | Execute command in dry run mode |
18-
| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit |
19-
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed |
20-
| `--menu` | | | Enable interactive shortcuts when running attached (Experimental). Incompatible with --detach. |
21-
| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services |
22-
| `--no-build` | | | Don't build an image, even if it's policy |
23-
| `--no-color` | | | Produce monochrome output |
24-
| `--no-deps` | | | Don't start linked services |
25-
| `--no-log-prefix` | | | Don't print prefix in logs |
26-
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
27-
| `--no-start` | | | Don't start the services after creating them |
28-
| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") |
29-
| `--quiet-pull` | | | Pull without printing progress information |
30-
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file |
31-
| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers |
32-
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
33-
| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running |
34-
| `--timestamps` | | | Show timestamps |
35-
| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. |
36-
| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy |
37-
| `-w`, `--watch` | | | Watch source code and rebuild/refresh containers when files are updated. |
8+
| Name | Type | Default | Description |
9+
|:-------------------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
10+
| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d |
11+
| `--abort-on-container-failure` | | | Stops all containers if any container exited with failure. Incompatible with -d |
12+
| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. |
13+
| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. |
14+
| `--attach-dependencies` | | | Automatically attach to log output of dependent services |
15+
| `--build` | | | Build images before starting containers |
16+
| `-d`, `--detach` | | | Detached mode: Run containers in the background |
17+
| `--dry-run` | | | Execute command in dry run mode |
18+
| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit |
19+
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed |
20+
| `--menu` | | | (Experimental) Enable interactive shortcuts when running attached. Incompatible with --detach. Alternatively, you can enable/disable this by setting COMPOSE_MENU environment variable. |
21+
| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services |
22+
| `--no-build` | | | Don't build an image, even if it's policy |
23+
| `--no-color` | | | Produce monochrome output |
24+
| `--no-deps` | | | Don't start linked services |
25+
| `--no-log-prefix` | | | Don't print prefix in logs |
26+
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
27+
| `--no-start` | | | Don't start the services after creating them |
28+
| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") |
29+
| `--quiet-pull` | | | Pull without printing progress information |
30+
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file |
31+
| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers |
32+
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
33+
| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running |
34+
| `--timestamps` | | | Show timestamps |
35+
| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. |
36+
| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy |
37+
| `-w`, `--watch` | | | Watch source code and rebuild/refresh containers when files are updated. |
3838

3939

4040
<!---MARKER_GEN_END-->

docs/reference/docker_compose_up.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ options:
123123
value_type: bool
124124
default_value: "false"
125125
description: |
126-
Enable interactive shortcuts when running attached (Experimental). Incompatible with --detach.
126+
(Experimental) Enable interactive shortcuts when running attached. Incompatible with --detach. Alternatively, you can enable/disable this by setting COMPOSE_MENU environment variable.
127127
deprecated: false
128128
hidden: false
129129
experimental: false

0 commit comments

Comments
 (0)