docker_compose
Read-only
Read a project's declared Compose configuration and environment variables directly from files, showing each variable's origin and masking secrets.
Instructions
Reads what the project declares: config for the resolved compose file, env for the variables with the file each came from. Both read files rather than a running process — a variable here is what was written down, not what the container now holds. What is actually running is docker_container.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mask | No | Hide values whose key names a secret. Default: true. | |
| action | Yes | config: the compose configuration, as fields and as the file itself. env: the variables the project declares, each naming the file it came from. | |
| profile | No | Which Docker host, by profile name. Default: the profile marked as default. | |
| project | No | Which compose project. Default: the project of the working directory. A name matching nothing is an error, not a fall back to every container on the host. | |
| resolve | No | Substitute variables the way Docker does before starting anything, which is what turns declared ports into published ones. Costs a call to docker compose. Default: false. | |
| service | No | Service name as written in the compose file. Narrows the answer to this one service. | |
| compose_path | No | Where the compose file is: the file itself, or the directory holding it. Needed only when no container of the host carries the project label — a project that was never brought up there. A directory holding several compose files is refused with their names rather than guessed through. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | ||
| action | No | ||
| legend | No | What the words in this answer mean. A key names the field before the value — "state=running", "containers[].health=unhealthy" — and only the values this answer used are listed. | |
| reason | No | ||
| project | No | ||
| service | No | ||
| volumes | No | ||
| networks | No | ||
| resolved | No | ||
| services | No | ||
| variables | No | ||
| compose_file | No |