compose/docs/reference/compose_up.md
Guillaume Lours d79cb959b5 feat(up): stream the logs while --wait waits for the services
Without --detach, `up --wait` now attaches to the containers and streams
their logs until the services are running|healthy, then ends the
session and leaves them up. Until now --wait silently forced --detach,
so a service failing to become healthy left no clue about why.

--detach --wait keeps the previous silent behavior, and --dry-run
stays on the detached plan. The library Validate accepts Wait with
Attach, and still rejects OnExit, ExitCodeFrom and Watch with it. The
navigation menu is disabled while waiting.

Signed-off-by: Guillaume Lours <glours@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-17 09:35:33 +01:00

10 KiB
Raw Blame History

docker compose up

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’s configuration or image was changed after the container’s creation, 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.

Pre-start hook failures

When a pre_start lifecycle hook exits with a non-zero code, Compose stops the service startup and retains the hook’s container so you can inspect what went wrong:

$ docker ps -a --filter label=com.docker.compose.hook=pre_start
$ docker logs <container-id>

On the next compose up, any retained hook containers for the same service are cleaned up automatically before the hook runs again. Running compose down also removes them.

Options

Name Type Default Description
--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.
--attach stringArray Restrict attaching to the specified services. Incompatible with --attach-dependencies.
--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
--exit-code-from string Return the exit code of the selected service container. Implies --abort-on-container-exit
--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.
--no-attach stringArray Do not attach (stream logs) to the specified services
--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
--pull string policy Pull image before running ("always"|"missing"|"never")
--quiet-build bool Suppress the build output
--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
--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
--timestamps bool Show timestamps
--wait bool Wait for services to be running|healthy, streaming their logs unless --detach is set
--wait-timeout int 0 Maximum duration in seconds to wait for the project to be running|healthy
-w, --watch bool Watch source code and rebuild/refresh containers when files are updated.
-y, --yes bool Assume "yes" as answer to all prompts and run non-interactively

Description

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’s configuration or image was changed after the container’s creation, 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.

Pre-start hook failures

When a pre_start lifecycle hook exits with a non-zero code, Compose stops the service startup and retains the hook’s container so you can inspect what went wrong:

$ docker ps -a --filter label=com.docker.compose.hook=pre_start
$ docker logs <container-id>

On the next compose up, any retained hook containers for the same service are cleaned up automatically before the hook runs again. Running compose down also removes them.