Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

openclaw health

Fetch health from the running Gateway.

Options

FlagDefaultDescription
--jsonfalsePrint machine-readable JSON instead of text.
--timeout <ms>10000Connection timeout in milliseconds.
--verbosefalseVerbose logging. Forces a live probe and expands per-agent output.
--debugfalseAlias for --verbose.
Examples:
openclaw health
openclaw health --json
openclaw health --timeout 2500
openclaw health --verbose
openclaw health --debug
Notes:
  • Default openclaw health asks the running gateway for its health snapshot. When the gateway already has a fresh cached snapshot, it can return that cached payload and refresh in the background.
  • --verbose forces a live probe, prints gateway connection details, and expands the human-readable output across all configured accounts and agents.
  • Output includes per-agent session stores when multiple agents are configured.