Skip to main content

Synopsis

profclaw doctor [flags]

Description

doctor runs a series of health checks against the local environment and the running profClaw server. Each check reports pass, warn, or fail along with a suggested fix command. Checks performed:
CheckWhat it tests
Node.jsVersion is >= 22
Configconfig/settings.yml exists
PortConfigured port is available or in use
RedisREDIS_URL is reachable (optional for pico/mini)
OllamaOllama API is reachable at localhost:11434
ServerprofClaw HTTP server responds at /health
DatabaseDatabase is configured and accessible
AI ProviderAt least one healthy provider is configured
MemorySufficient free system RAM
DiskSufficient free disk space
Cloudflaredcloudflared binary is installed (optional)
Tailscaletailscale binary is installed (optional)

Flags

--json
boolean
Output all check results as a JSON array instead of the colored table. Each result includes name, status, message, and optional fix.

Examples

profclaw doctor

Example Output

profClaw Doctor

  ✓ Node.js       v22.11.0
  ✓ Config        settings.yml found (+.env)
  ✓ Port          Port 3000 available
  ⚠ Redis         REDIS_URL not set (optional for pico/mini mode)
    Fix: docker compose up redis -d
  ⚠ Ollama        Not running (optional)
    Fix: https://ollama.com/download
  ✓ Server        Running and healthy
  ✓ Database      Configured and accessible
  ✓ AI Provider   2/2 healthy
  ✓ Memory        14.2 GB free
  ✓ Disk          120G free (42% used)
  ⚠ Cloudflared   Not installed (optional)
    Fix: brew install cloudflared
  ⚠ Tailscale     Not installed (optional)
    Fix: https://tailscale.com/download

  10/12 passed, 4 warnings

Exit Codes

CodeMeaning
0All checks passed (warnings do not cause failure)
1One or more checks failed