nyrn
/
openclaw
mirror of https://github.com/openclaw/openclaw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
openclaw/docs/cli/status.md

2.7 KiB
Raw Blame History

summary read_when title
CLI reference for `openclaw status` (diagnostics, probes, usage snapshots)
You want a quick diagnosis of channel health + recent session recipients
You want a pasteable “all” status for debugging
status

openclaw status

Diagnostics for channels + sessions.

openclaw status
openclaw status --all
openclaw status --deep
openclaw status --usage

Notes:

  • --deep runs live probes (WhatsApp Web + Telegram + Discord + Slack + Signal).
  • --usage prints normalized provider usage windows as X% left.
  • MiniMax's raw usage_percent / usagePercent fields are remaining quota, so OpenClaw inverts them before display; count-based fields win when present. model_remains responses prefer the chat-model entry, derive the window label from timestamps when needed, and include the model name in the plan label.
  • When the current session snapshot is sparse, /status can backfill token and cache counters from the most recent transcript usage log. Existing nonzero live values still win over transcript fallback values.
  • Transcript fallback can also recover the active runtime model label when the live session entry is missing it. If that transcript model differs from the selected model, status resolves the context window against the recovered runtime model instead of the selected one.
  • For prompt-size accounting, transcript fallback prefers the larger prompt-oriented total when session metadata is missing or smaller, so custom-provider sessions do not collapse to 0 token displays.
  • Output includes per-agent session stores when multiple agents are configured.
  • Overview includes Gateway + node host service install/runtime status when available.
  • Overview includes update channel + git SHA (for source checkouts).
  • Update info surfaces in the Overview; if an update is available, status prints a hint to run openclaw update (see Updating).
  • Read-only status surfaces (status, status --json, status --all) resolve supported SecretRefs for their targeted config paths when possible.
  • If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as “configured token unavailable in this command path”, and JSON output includes secretDiagnostics.
  • When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient “secret unavailable” channel markers from the final output.
  • status --all includes a Secrets overview row and a diagnosis section that summarizes secret diagnostics (truncated for readability) without stopping report generation.