2022-03-09 12:57:07 +01:00
# docker compose up
<!-- - MARKER_GEN_START -->
2024-07-17 11:27:58 +02:00
Builds, (re)creates, starts, and attaches to containers for a service.
Unless they are already running, this command also starts any linked services.
The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does).
One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using
`--no-attach` to prevent output to be flooded by some verbose services.
When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the
background and leaves them running.
If there are existing containers for a service, and the service’
container’ `docker compose up` picks up the changes by stopping and recreating the containers
(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.
If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.
If the process encounters an error, the exit code for this command is `1` .
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM` , the containers are stopped, and the exit code is `0` .
2022-03-09 12:57:07 +01:00
### Options
2024-05-07 13:42:08 +01:00
| Name | Type | Default | Description |
|:-------------------------------|:--------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------|
2024-07-17 11:27:58 +02:00
| `--abort-on-container-exit` | `bool` | | Stops all containers if any container was stopped. Incompatible with -d |
| `--abort-on-container-failure` | `bool` | | Stops all containers if any container exited with failure. Incompatible with -d |
| `--always-recreate-deps` | `bool` | | Recreate dependent containers. Incompatible with --no-recreate. |
2024-05-07 13:42:08 +01:00
| `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. |
2024-07-17 11:27:58 +02:00
| `--attach-dependencies` | `bool` | | Automatically attach to log output of dependent services |
| `--build` | `bool` | | Build images before starting containers |
| `-d` , `--detach` | `bool` | | Detached mode: Run containers in the background |
| `--dry-run` | `bool` | | Execute command in dry run mode |
2024-05-07 13:42:08 +01:00
| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit |
2024-07-17 11:27:58 +02:00
| `--force-recreate` | `bool` | | Recreate containers even if their configuration and image haven't changed |
| `--menu` | `bool` | | Enable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var. |
2024-05-07 13:42:08 +01:00
| `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services |
2024-07-17 11:27:58 +02:00
| `--no-build` | `bool` | | Don't build an image, even if it's policy |
| `--no-color` | `bool` | | Produce monochrome output |
| `--no-deps` | `bool` | | Don't start linked services |
| `--no-log-prefix` | `bool` | | Don't print prefix in logs |
| `--no-recreate` | `bool` | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
| `--no-start` | `bool` | | Don't start the services after creating them |
2024-05-07 13:42:08 +01:00
| `--pull` | `string` | `policy` | Pull image before running ("always"\|"missing"\|"never") |
2024-07-17 11:27:58 +02:00
| `--quiet-pull` | `bool` | | Pull without printing progress information |
| `--remove-orphans` | `bool` | | Remove containers for services not defined in the Compose file |
| `-V` , `--renew-anon-volumes` | `bool` | | Recreate anonymous volumes instead of retrieving data from the previous containers |
2024-05-07 13:42:08 +01:00
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
| `-t` , `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running |
2024-07-17 11:27:58 +02:00
| `--timestamps` | `bool` | | Show timestamps |
| `--wait` | `bool` | | Wait for services to be running\|healthy. Implies detached mode. |
2024-11-22 23:31:04 -05:00
| `--wait-timeout` | `int` | `0` | Maximum duration in seconds to wait for the project to be running\|healthy |
2024-07-17 11:27:58 +02:00
| `-w` , `--watch` | `bool` | | Watch source code and rebuild/refresh containers when files are updated. |
2025-03-11 08:03:17 +01:00
| `-y` , `--yes` | `bool` | | Assume "yes" as answer to all prompts and run non-interactively |
2022-03-09 12:57:07 +01:00
<!-- - MARKER_GEN_END -->
2021-03-11 16:20:30 +01:00
## Description
Builds, (re)creates, starts, and attaches to containers for a service.
Unless they are already running, this command also starts any linked services.
2022-03-09 13:24:09 +01:00
The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does).
2023-01-03 15:35:24 +01:00
One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using
`--no-attach` to prevent output to be flooded by some verbose services.
2022-03-09 13:24:09 +01:00
When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the
2021-03-11 16:20:30 +01:00
background and leaves them running.
2022-03-09 13:24:09 +01:00
If there are existing containers for a service, and the service’
container’ `docker compose up` picks up the changes by stopping and recreating the containers
2021-03-11 16:20:30 +01:00
(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.
If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.
If the process encounters an error, the exit code for this command is `1` .
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM` , the containers are stopped, and the exit code is `0` .
