PetClaw CLI Commands

This page focuses on the actual commands you run with petclaw.

Note: upstream docs may still show openclaw ...; in this project, you can usually read those as petclaw ....

The 5 most-used commands

| Command | Purpose | When to use it | |---|---|---| | petclaw --version | Check runtime version | Verify installation | | petclaw health | Check local gateway health | When the app cannot connect | | petclaw gateway | Start the local gateway | When the service is not running | | petclaw dashboard --no-open | Print dashboard URL with token | Debug dashboard access | | petclaw channels login --channel whatsapp | Start WhatsApp login flow | Configure channel login |

Startup and basic checks

petclaw --version
petclaw health
petclaw status
  • --version: confirm runtime installation
  • health: confirm the gateway is responding
  • status: read a more human-friendly global status

Gateway commands

petclaw gateway
petclaw gateway run
petclaw gateway status
petclaw gateway health
petclaw gateway probe
petclaw gateway discover
petclaw gateway call <method>

Use these to start the gateway, inspect status, probe reachability, and call RPC methods manually.

Dashboard and session commands

petclaw dashboard --no-open
petclaw sessions
petclaw sessions cleanup

dashboard --no-open prints a tokenized dashboard URL. sessions helps inspect or clean up session data.

Channels commands

petclaw channels list
petclaw channels status
petclaw channels add
petclaw channels remove
petclaw channels login --channel whatsapp
petclaw channels logout

Use channels to manage channel configuration and login state.

Setup and diagnostics

petclaw setup
petclaw onboard
petclaw configure
petclaw config
petclaw doctor
petclaw backup
petclaw reset
  • setup: initialize local config and workspace
  • onboard: run first-time setup flow
  • configure: interactive configuration
  • config: inspect or validate config
  • doctor: run diagnostics and get fix suggestions
  • backup: back up local state
  • reset: reset local state

Other useful command groups

| Command group | Purpose | |---|---| | logs | Read gateway logs | | models | Discover and configure models | | approvals | Manage execution approvals | | devices | Pair devices and manage tokens | | plugins | Manage plugins and extensions | | skills | Inspect available skills | | docs | Search OpenClaw docs | | update | Update runtime / OpenClaw |

Recommended troubleshooting order

petclaw --version
petclaw health
petclaw gateway
petclaw dashboard --no-open
petclaw channels status
petclaw channels login --channel whatsapp
PetClaw CLI Commands