compose_up
Start Docker Compose services in detached mode, with options to build images, specify services, and wait for healthy status. Returns CLI output for verification and troubleshooting.
Instructions
Bring up a Docker Compose project, detached.
Always runs detached (-d) so it can't block the server. Use compose_ps to confirm
services are running, or wait=True to block until they're healthy.
Does not raise on a non-zero CLI exit (a missing compose plugin or a timeout still raises) - inspect
returncode/stderr in the result.
Args:
project_dir: Dir with the compose file (default: server cwd, copied to the target host if no local plugin; paths
verbatim, no shell expansion)
files: Explicit compose file paths (repeatable, -f)
project_name: Compose project name override
services: Specific services to bring up (default: all)
build: Build images before starting
pull: Pull strategy; omit to use each service's own pull_policy
remove_orphans: Remove containers for services not in the compose file
wait: Block until services are healthy (adds --wait)
timeout_seconds: Subprocess timeout (default 600s)
Returns: dict: {"returncode": int, "stdout": str, "stderr": str, "truncated": bool}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pull | No | ||
| wait | No | ||
| build | No | ||
| files | No | ||
| profiles | No | ||
| services | No | ||
| project_dir | No | ||
| project_name | No | ||
| remove_orphans | No | ||
| timeout_seconds | No |