docs: refresh gateway health snapshot refs

This commit is contained in:
Peter Steinberger
2026-04-04 18:54:04 +01:00
parent 72b59231a3
commit 9d45f4b4e9
4 changed files with 27 additions and 10 deletions

View File

@@ -1,5 +1,5 @@
---
summary: "CLI reference for `openclaw health` (gateway health endpoint via RPC)"
summary: "CLI reference for `openclaw health` (gateway health snapshot via RPC)"
read_when:
- You want to quickly check the running Gateways health
title: "health"
@@ -28,5 +28,9 @@ openclaw health --debug
Notes:
- `--verbose` runs live probes and prints per-account timings when multiple accounts are configured.
- 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.

View File

@@ -1203,7 +1203,7 @@ Options:
- `--json`
- `--all` (full diagnosis; read-only, pasteable)
- `--deep` (probe channels)
- `--deep` (ask the gateway for a live health probe, including channel probes when supported)
- `--usage` (show model provider usage/quota)
- `--timeout <ms>`
- `--verbose`
@@ -1241,9 +1241,14 @@ Options:
- `--json`
- `--timeout <ms>`
- `--verbose`
- `--verbose` (force a live probe and print gateway connection details)
- `--debug` (alias for `--verbose`)
Notes:
- Default `health` can return a fresh cached gateway snapshot.
- `health --verbose` forces a live probe and expands human-readable output across all configured accounts and agents.
### `sessions`
List stored conversation sessions.