mirror of https://github.com/openclaw/openclaw.git
docs: refresh system health and sessions refs
This commit is contained in:
parent
d584ccfc77
commit
df09fe9adf
|
|
@ -9,10 +9,21 @@ title: "health"
|
|||
|
||||
Fetch health from the running Gateway.
|
||||
|
||||
Options:
|
||||
|
||||
- `--json`: machine-readable output
|
||||
- `--timeout <ms>`: connection timeout in milliseconds (default `10000`)
|
||||
- `--verbose`: verbose logging
|
||||
- `--debug`: alias for `--verbose`
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
openclaw health
|
||||
openclaw health --json
|
||||
openclaw health --timeout 2500
|
||||
openclaw health --verbose
|
||||
openclaw health --debug
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
|
|
|||
|
|
@ -889,6 +889,7 @@ Options:
|
|||
- `--json`
|
||||
- `--timeout <ms>`
|
||||
- `--verbose`
|
||||
- `--debug` (alias for `--verbose`)
|
||||
|
||||
### `sessions`
|
||||
|
||||
|
|
@ -907,6 +908,10 @@ Subcommands:
|
|||
|
||||
- `sessions cleanup` — remove expired or orphaned sessions
|
||||
|
||||
Notes:
|
||||
|
||||
- `sessions cleanup` also supports `--fix-missing` to prune entries whose transcript files are gone.
|
||||
|
||||
## Reset / Uninstall
|
||||
|
||||
### `reset`
|
||||
|
|
|
|||
|
|
@ -14,12 +14,14 @@ openclaw sessions
|
|||
openclaw sessions --agent work
|
||||
openclaw sessions --all-agents
|
||||
openclaw sessions --active 120
|
||||
openclaw sessions --verbose
|
||||
openclaw sessions --json
|
||||
```
|
||||
|
||||
Scope selection:
|
||||
|
||||
- default: configured default agent store
|
||||
- `--verbose`: verbose logging
|
||||
- `--agent <id>`: one configured agent store
|
||||
- `--all-agents`: aggregate all configured agent stores
|
||||
- `--store <path>`: explicit store path (cannot be combined with `--agent` or `--all-agents`)
|
||||
|
|
@ -71,6 +73,7 @@ openclaw sessions cleanup --json
|
|||
- `--dry-run`: preview how many entries would be pruned/capped without writing.
|
||||
- In text mode, dry-run prints a per-session action table (`Action`, `Key`, `Age`, `Model`, `Flags`) so you can see what would be kept vs removed.
|
||||
- `--enforce`: apply maintenance even when `session.maintenance.mode` is `warn`.
|
||||
- `--fix-missing`: remove entries whose transcript files are missing, even if they would not normally age/count out yet.
|
||||
- `--active-key <key>`: protect a specific active key from disk-budget eviction.
|
||||
- `--agent <id>`: run cleanup for one configured agent store.
|
||||
- `--all-agents`: run cleanup for all configured agent stores.
|
||||
|
|
|
|||
|
|
@ -12,10 +12,18 @@ title: "system"
|
|||
System-level helpers for the Gateway: enqueue system events, control heartbeats,
|
||||
and view presence.
|
||||
|
||||
All `system` subcommands use Gateway RPC and accept the shared client flags:
|
||||
|
||||
- `--url <url>`
|
||||
- `--token <token>`
|
||||
- `--timeout <ms>`
|
||||
- `--expect-final`
|
||||
|
||||
## Common commands
|
||||
|
||||
```bash
|
||||
openclaw system event --text "Check for urgent follow-ups" --mode now
|
||||
openclaw system event --text "Check for urgent follow-ups" --url ws://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"
|
||||
openclaw system heartbeat enable
|
||||
openclaw system heartbeat last
|
||||
openclaw system presence
|
||||
|
|
@ -32,6 +40,7 @@ Flags:
|
|||
- `--text <text>`: required system event text.
|
||||
- `--mode <mode>`: `now` or `next-heartbeat` (default).
|
||||
- `--json`: machine-readable output.
|
||||
- `--url`, `--token`, `--timeout`, `--expect-final`: shared Gateway RPC flags.
|
||||
|
||||
## `system heartbeat last|enable|disable`
|
||||
|
||||
|
|
@ -44,6 +53,7 @@ Heartbeat controls:
|
|||
Flags:
|
||||
|
||||
- `--json`: machine-readable output.
|
||||
- `--url`, `--token`, `--timeout`, `--expect-final`: shared Gateway RPC flags.
|
||||
|
||||
## `system presence`
|
||||
|
||||
|
|
@ -53,6 +63,7 @@ instances, and similar status lines).
|
|||
Flags:
|
||||
|
||||
- `--json`: machine-readable output.
|
||||
- `--url`, `--token`, `--timeout`, `--expect-final`: shared Gateway RPC flags.
|
||||
|
||||
## Notes
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue