Skip to content

cropscode doctor

Terminal window
cropscode doctor

Runs a comprehensive health check on this machine’s CropsCode setup. Checks:

  • Authentication — valid credentials in ~/.cropscode/credentials.json
  • Worker registration — worker configured with a tenant
  • Orchestrator connectivity — can reach the health endpoint
  • WSL2 — (Windows only) WSL2 installed with a Linux distro
  • Container runtime — Podman or Docker installed and running
  • Disk space — at least 5 GB free
  • Memory — at least 1 GB free
FlagDescription
--jsonMachine-readable JSON output (for CI/automation)

Each check shows a pass/fail/warn status:

✓ Logged in as you@example.com
✓ Registered (your-tenant)
✓ Reachable (console.cropscode.io)
✓ podman v5.3.1
✓ 42.0GB free
⚠ Low memory: 0.8GB free of 16.0GB

Icons: pass, fail, warning. Disk and memory use warnings (⚠) instead of failures — they won’t block you but indicate potential issues.

When failures are found, doctor prompts you to run cropscode onboard to fix them automatically. If only warnings remain, it reports them without prompting.

Terminal window
cropscode doctor --json

Returns a JSON object with healthy (boolean) and checks (array). Exit code is 0 when healthy, 1 otherwise.

Getting Started Concepts Guides CLI Self-Hosting Reference Links