docker compose up

DescriptionCreate and start containers
Usagedocker compose up [OPTIONS] [SERVICE...]

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.

Options

OptionDefaultDescription
--abort-on-container-exitStops all containers if any container was stopped. Incompatible with -d
--abort-on-container-failureStops all containers if any container exited with failure. Incompatible with -d
--always-recreate-depsRecreate dependent containers. Incompatible with --no-recreate.
--attachRestrict attaching to the specified services. Incompatible with --attach-dependencies.
--attach-dependenciesAutomatically attach to log output of dependent services
--buildBuild images before starting containers
-d, --detachDetached mode: Run containers in the background
--exit-code-fromReturn the exit code of the selected service container. Implies --abort-on-container-exit
--force-recreateRecreate containers even if their configuration and image haven't changed
--menuEnable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var.
--no-attachDo not attach (stream logs) to the specified services
--no-buildDon't build an image, even if it's policy
--no-colorProduce monochrome output
--no-depsDon't start linked services
--no-log-prefixDon't print prefix in logs
--no-recreateIf containers already exist, don't recreate them. Incompatible with --force-recreate.
--no-startDon't start the services after creating them
--pullpolicyPull image before running ("always"|"missing"|"never")
--quiet-pullPull without printing progress information
--remove-orphansRemove containers for services not defined in the Compose file
-V, --renew-anon-volumesRecreate anonymous volumes instead of retrieving data from the previous containers
--scaleScale SERVICE to NUM instances. Overrides the scale setting in the Compose file if present.
-t, --timeoutUse this timeout in seconds for container shutdown when attached or when containers are already running
--timestampsShow timestamps
--waitWait for services to be running|healthy. Implies detached mode.
--wait-timeoutMaximum duration to wait for the project to be running|healthy
-w, --watchWatch source code and rebuild/refresh containers when files are updated.