docker compose config


Parse, resolve and render compose file in canonical format

Usage

$ docker compose config [OPTIONS] [SERVICE...]

Refer to the options section for an overview of available OPTIONS for this command.

Description

docker compose config renders the actual data model to be applied on the Docker engine. it merges the Compose files set by -f flags, resolves variables in the Compose file, and expands short-notation into the canonical format.

Options

Name, shorthand Default Description
--format yaml Format the output. Values: [yaml | json]
--hash Print the service config hash, one per line.
--images Print the image names, one per line.
--no-consistency Don’t check model consistency - warning: may produce invalid Compose output
--no-interpolate Don’t interpolate environment variables.
--no-normalize Don’t normalize compose model.
--no-path-resolution Don’t resolve file paths.
--output , -o Save to file (default to stdout)
--profiles Print the profile names, one per line.
--quiet , -q Only validate the configuration, don’t print anything.
--resolve-image-digests Pin image tags to digests.
--services Print the service names, one per line.
--volumes Print the volume names, one per line.
--dry-run Execute command in dry run mode

Parent command

Command Description
docker compose Docker Compose
Command Description
docker compose build Build or rebuild services
docker compose config Parse, resolve and render compose file in canonical format
docker compose cp Copy files/folders between a service container and the local filesystem
docker compose create Creates containers for a service.
docker compose down Stop and remove containers, networks
docker compose events Receive real time events from containers.
docker compose exec Execute a command in a running container.
docker compose images List images used by the created containers
docker compose kill Force stop service containers.
docker compose logs View output from containers
docker compose ls List running compose projects
docker compose pause Pause services
docker compose port Print the public port for a port binding.
docker compose ps List containers
docker compose pull Pull service images
docker compose push Push service images
docker compose restart Restart service containers
docker compose rm Removes stopped service containers
docker compose run Run a one-off command on a service.
docker compose start Start services
docker compose stop Stop services
docker compose top Display the running processes
docker compose unpause Unpause services
docker compose up Create and start containers
docker compose version Show the Docker Compose version information