muster doctor
Run 6 categories of diagnostics to verify your muster installation, project configuration, and service health. Doctor identifies problems and can automatically fix many common issues.
Usage
bash
muster doctor [options]Options
| Name | Description |
|---|---|
--fix | booleanAutomatically fix issues where possible (stale PIDs, old logs, missing directories, .dockerignore entries). |
--json | booleanOutput diagnostics as JSON. |
Diagnostics
Doctor runs the following checks:
Categories
| Name | Description |
|---|---|
Platform & Tools | categoryOS/architecture detection, Docker daemon, Docker Compose, kubectl, jq, git, SSH client availability. |
Configuration | categoryConfig file JSON validity, hook directory structure, hook scripts present and executable, deploy order consistency, health check config, .env detection, hook manifest integrity. |
Stack Readiness | categoryDocker daemon responding, Dockerfiles found, Docker Compose files, K8s context and cluster reachability, K8s namespaces and deployments. |
Connectivity | categorySSH remote reachability, SSH key files, fleet machine connectivity, fleet agent status, app integrity verification. |
Health & Runtime | categoryHealth endpoints reachable (HTTP/TCP), health commands running, health timeout validation. |
Storage & Maintenance | categoryLog directory writable, stale PID files, old log files, build context overlaps, disk space, .muster directory permissions. |
bash
# Run all diagnostics
muster doctor
# Run diagnostics and auto-fix issues
muster doctor --fix
# Output as JSON
muster doctor --jsonNote
The
--fix flag will attempt to repair issues like stale PID files, old log files, missing directories, and build context overlaps (adds to .dockerignore). It will not modify your muster.json or hook script contents.