| 1 |
# docker compose convert |
| 2 |
|
| 3 |
<!---MARKER_GEN_START--> |
| 4 |
`docker compose config` renders the actual data model to be applied on the Docker Engine. |
| 5 |
It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into |
| 6 |
the canonical format. |
| 7 |
|
| 8 |
### Options |
| 9 |
|
| 10 |
| Name | Type | Default | Description | |
| 11 |
|:--------------------------|:---------|:--------|:----------------------------------------------------------------------------| |
| 12 |
| `--dry-run` | `bool` | | Execute command in dry run mode | |
| 13 |
| `--environment` | `bool` | | Print environment used for interpolation. | |
| 14 |
| `--format` | `string` | | Format the output. Values: [yaml \| json] | |
| 15 |
| `--hash` | `string` | | Print the service config hash, one per line. | |
| 16 |
| `--images` | `bool` | | Print the image names, one per line. | |
| 17 |
| `--lock-image-digests` | `bool` | | Produces an override file with image digests | |
| 18 |
| `--models` | `bool` | | Print the model names, one per line. | |
| 19 |
| `--networks` | `bool` | | Print the network names, one per line. | |
| 20 |
| `--no-consistency` | `bool` | | Don't check model consistency - warning: may produce invalid Compose output | |
| 21 |
| `--no-env-resolution` | `bool` | | Don't resolve service env files | |
| 22 |
| `--no-interpolate` | `bool` | | Don't interpolate environment variables | |
| 23 |
| `--no-normalize` | `bool` | | Don't normalize compose model | |
| 24 |
| `--no-path-resolution` | `bool` | | Don't resolve file paths | |
| 25 |
| `-o`, `--output` | `string` | | Save to file (default to stdout) | |
| 26 |
| `--profiles` | `bool` | | Print the profile names, one per line. | |
| 27 |
| `-q`, `--quiet` | `bool` | | Only validate the configuration, don't print anything | |
| 28 |
| `--resolve-image-digests` | `bool` | | Pin image tags to digests | |
| 29 |
| `--services` | `bool` | | Print the service names, one per line. | |
| 30 |
| `--variables` | `bool` | | Print model variables and default values. | |
| 31 |
| `--volumes` | `bool` | | Print the volume names, one per line. | |
| 32 |
|
| 33 |
|
| 34 |
<!---MARKER_GEN_END--> |
| 35 |
|
| 36 |
## Description |
| 37 |
|
| 38 |
`docker compose config` renders the actual data model to be applied on the Docker Engine. |
| 39 |
It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into |
| 40 |
the canonical format. |