From f8894d5b3e8ed467bb58fe2c654c363dd7e5eb9e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Thu, 23 Apr 2026 08:46:14 +0100 Subject: [PATCH] docs: align cli index with command surface --- docs/cli/index.md | 53 ++++++++++++++++++++++++++++++----------------- docs/cli/proxy.md | 45 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+), 19 deletions(-) create mode 100644 docs/cli/proxy.md diff --git a/docs/cli/index.md b/docs/cli/index.md index 006964ebf97..dbf7906f7fc 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -8,28 +8,29 @@ title: "CLI Reference" # CLI reference -`openclaw` is the main CLI entry point. Each subcommand has its own dedicated -reference page; this index lists the commands, the global flags, and the -output styling rules that apply across the CLI. +`openclaw` is the main CLI entry point. Each core command has either a +dedicated reference page or is documented with the command it aliases; this +index lists the commands, the global flags, and the output styling rules that +apply across the CLI. ## Command pages -| Area | Commands | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Setup and onboarding | [`setup`](/cli/setup) · [`onboard`](/cli/onboard) · [`configure`](/cli/configure) · [`config`](/cli/config) · [`completion`](/cli/completion) · [`doctor`](/cli/doctor) · [`dashboard`](/cli/dashboard) | -| Reset and uninstall | [`backup`](/cli/backup) · [`reset`](/cli/reset) · [`uninstall`](/cli/uninstall) · [`update`](/cli/update) | -| Messaging and agents | [`message`](/cli/message) · [`agent`](/cli/agent) · [`agents`](/cli/agents) · [`acp`](/cli/acp) · [`mcp`](/cli/mcp) | -| Health and sessions | [`status`](/cli/status) · [`health`](/cli/health) · [`sessions`](/cli/sessions) | -| Gateway and logs | [`gateway`](/cli/gateway) · [`logs`](/cli/logs) · [`system`](/cli/system) | -| Models and inference | [`models`](/cli/models) · [`infer`](/cli/infer) · [`memory`](/cli/memory) · [`wiki`](/cli/wiki) | -| Network and nodes | [`directory`](/cli/directory) · [`nodes`](/cli/nodes) · [`devices`](/cli/devices) · [`node`](/cli/node) | -| Runtime and sandbox | [`approvals`](/cli/approvals) · [`sandbox`](/cli/sandbox) · [`tui`](/cli/tui) · [`browser`](/cli/browser) | -| Automation | [`cron`](/cli/cron) · [`tasks`](/cli/tasks) · [`flows`](/cli/flows) · [`hooks`](/cli/hooks) · [`webhooks`](/cli/webhooks) | -| Discovery and docs | [`dns`](/cli/dns) · [`docs`](/cli/docs) | -| Pairing and channels | [`pairing`](/cli/pairing) · [`qr`](/cli/qr) · [`channels`](/cli/channels) | -| Security and plugins | [`security`](/cli/security) · [`secrets`](/cli/secrets) · [`skills`](/cli/skills) · [`plugins`](/cli/plugins) | -| Legacy aliases | [`daemon`](/cli/daemon) (gateway service) · [`clawbot`](/cli/clawbot) (namespace) | -| Plugins (optional) | [`voicecall`](/cli/voicecall) (if installed) | +| Area | Commands | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Setup and onboarding | [`setup`](/cli/setup) · [`onboard`](/cli/onboard) · [`configure`](/cli/configure) · [`config`](/cli/config) · [`completion`](/cli/completion) · [`doctor`](/cli/doctor) · [`dashboard`](/cli/dashboard) | +| Reset and uninstall | [`backup`](/cli/backup) · [`reset`](/cli/reset) · [`uninstall`](/cli/uninstall) · [`update`](/cli/update) | +| Messaging and agents | [`message`](/cli/message) · [`agent`](/cli/agent) · [`agents`](/cli/agents) · [`acp`](/cli/acp) · [`mcp`](/cli/mcp) | +| Health and sessions | [`status`](/cli/status) · [`health`](/cli/health) · [`sessions`](/cli/sessions) | +| Gateway and logs | [`gateway`](/cli/gateway) · [`logs`](/cli/logs) · [`system`](/cli/system) | +| Models and inference | [`models`](/cli/models) · [`infer`](/cli/infer) · `capability` (alias for [`infer`](/cli/infer)) · [`memory`](/cli/memory) · [`wiki`](/cli/wiki) | +| Network and nodes | [`directory`](/cli/directory) · [`nodes`](/cli/nodes) · [`devices`](/cli/devices) · [`node`](/cli/node) | +| Runtime and sandbox | [`approvals`](/cli/approvals) · `exec-policy` (see [`approvals`](/cli/approvals)) · [`sandbox`](/cli/sandbox) · [`tui`](/cli/tui) · `chat`/`terminal` (aliases for [`tui --local`](/cli/tui)) · [`browser`](/cli/browser) | +| Automation | [`cron`](/cli/cron) · [`tasks`](/cli/tasks) · [`hooks`](/cli/hooks) · [`webhooks`](/cli/webhooks) | +| Discovery and docs | [`dns`](/cli/dns) · [`docs`](/cli/docs) | +| Pairing and channels | [`pairing`](/cli/pairing) · [`qr`](/cli/qr) · [`channels`](/cli/channels) | +| Security and plugins | [`security`](/cli/security) · [`secrets`](/cli/secrets) · [`skills`](/cli/skills) · [`plugins`](/cli/plugins) · [`proxy`](/cli/proxy) | +| Legacy aliases | [`daemon`](/cli/daemon) (gateway service) · [`clawbot`](/cli/clawbot) (namespace) | +| Plugins (optional) | [`voicecall`](/cli/voicecall) (if installed) | ## Global flags @@ -282,6 +283,10 @@ openclaw [--dev] [--profile ] get set allowlist add|remove + exec-policy + show + preset + set browser status start @@ -321,6 +326,14 @@ openclaw [--dev] [--profile ] update webhooks gmail setup|run + proxy + start + run + coverage + sessions + query + blob + purge pairing list approve @@ -331,6 +344,8 @@ openclaw [--dev] [--profile ] dns setup tui + chat (alias: tui --local) + terminal (alias: tui --local) ``` Plugins can add additional top-level commands (for example `openclaw voicecall`). diff --git a/docs/cli/proxy.md b/docs/cli/proxy.md new file mode 100644 index 00000000000..e5f64deff52 --- /dev/null +++ b/docs/cli/proxy.md @@ -0,0 +1,45 @@ +--- +summary: "CLI reference for `openclaw proxy`, the local debug proxy and capture inspector" +read_when: + - You need to capture OpenClaw transport traffic locally for debugging + - You want to inspect debug proxy sessions, blobs, or built-in query presets +title: "proxy" +--- + +# `openclaw proxy` + +Run the local explicit debug proxy and inspect captured traffic. + +This is a debugging command for transport-level investigation. It can start a +local proxy, run a child command with capture enabled, list capture sessions, +query common traffic patterns, read captured blobs, and purge local capture +data. + +## Commands + +```bash +openclaw proxy start [--host ] [--port ] +openclaw proxy run [--host ] [--port ] -- +openclaw proxy coverage +openclaw proxy sessions [--limit ] +openclaw proxy query --preset [--session ] +openclaw proxy blob --id +openclaw proxy purge +``` + +## Query presets + +`openclaw proxy query --preset ` accepts: + +- `double-sends` +- `retry-storms` +- `cache-busting` +- `ws-duplicate-frames` +- `missing-ack` +- `error-bursts` + +## Notes + +- `start` defaults to `127.0.0.1` unless `--host` is set. +- `run` starts a local debug proxy and then runs the command after `--`. +- Captures are local debugging data; use `openclaw proxy purge` when finished.