From 470898b5e167f60e14f105a3e1fc780bcfd42ae1 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 08:52:33 +0100 Subject: [PATCH] docs: refresh gateway update and memory refs --- docs/cli/gateway.md | 21 +++++++++++++++++++++ docs/cli/index.md | 37 +++++++++++++++++++++++++++++++++++-- docs/cli/memory.md | 2 ++ docs/cli/update.md | 6 ++++++ 4 files changed, 64 insertions(+), 2 deletions(-) diff --git a/docs/cli/gateway.md b/docs/cli/gateway.md index 1b76f71d5cf..79ac72ed9ea 100644 --- a/docs/cli/gateway.md +++ b/docs/cli/gateway.md @@ -196,6 +196,21 @@ openclaw gateway call status openclaw gateway call logs.tail --params '{"sinceMs": 60000}' ``` +Options: + +- `--params `: JSON object string for params (default `{}`) +- `--url ` +- `--token ` +- `--password ` +- `--timeout ` +- `--expect-final` +- `--json` + +Notes: + +- `--params` must be valid JSON. +- `--expect-final` is mainly for agent-style RPCs that stream intermediate events before a final payload. + ## Manage the Gateway service ```bash @@ -206,6 +221,12 @@ openclaw gateway restart openclaw gateway uninstall ``` +Command options: + +- `gateway status`: `--url`, `--token`, `--password`, `--timeout`, `--no-probe`, `--require-rpc`, `--deep`, `--json` +- `gateway install`: `--port`, `--runtime `, `--token`, `--force`, `--json` +- `gateway uninstall|start|stop|restart`: `--json` + Notes: - `gateway install` supports `--port`, `--runtime`, `--token`, `--force`, `--json`. diff --git a/docs/cli/index.md b/docs/cli/index.md index cc120410df4..b1327b17b0d 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -421,9 +421,10 @@ Most plugin changes require a gateway restart. See [/plugin](/tools/plugin). Vector search over `MEMORY.md` + `memory/*.md`: -- `openclaw memory status` — show index stats. +- `openclaw memory status` — show index stats; use `--deep` for provider probes or `--fix` to repair stale recall/promotion artifacts. - `openclaw memory index` — reindex memory files. - `openclaw memory search ""` (or `--query ""`) — semantic search over memory. +- `openclaw memory promote` — rank short-term recalls and optionally append top entries into `MEMORY.md`. ## Chat slash commands @@ -574,6 +575,38 @@ Notes: - For SecretRef-managed gateway tokens, `dashboard` prints or opens a non-tokenized URL instead of exposing the secret in terminal output or browser launch arguments. +### `update` + +Update the installed CLI. + +Root options: + +- `--json` +- `--no-restart` +- `--dry-run` +- `--channel ` +- `--tag ` +- `--timeout ` +- `--yes` + +Subcommands: + +- `update status` +- `update wizard` + +`update status` options: + +- `--json` +- `--timeout ` + +`update wizard` options: + +- `--timeout ` + +Notes: + +- `openclaw --update` rewrites to `openclaw update`. + ### `backup` Create and verify local backup archives for OpenClaw state. @@ -1273,7 +1306,7 @@ Include `--token` or `--password` explicitly. Missing explicit credentials is an Subcommands: -- `gateway call [--params ]` +- `gateway call [--params ] [--url ] [--token ] [--password ] [--timeout ] [--expect-final] [--json]` - `gateway health` - `gateway status` - `gateway probe` diff --git a/docs/cli/memory.md b/docs/cli/memory.md index ff2600b919d..1908e9ed45a 100644 --- a/docs/cli/memory.md +++ b/docs/cli/memory.md @@ -22,6 +22,7 @@ Related: ```bash openclaw memory status openclaw memory status --deep +openclaw memory status --fix openclaw memory index --force openclaw memory search "meeting notes" openclaw memory search --query "deployment" --max-results 20 @@ -46,6 +47,7 @@ openclaw memory index --agent main --verbose - `--deep`: probe vector + embedding availability. - `--index`: run a reindex if the store is dirty (implies `--deep`). +- `--fix`: repair stale recall locks and normalize promotion metadata. - `--json`: print JSON output. `memory index`: diff --git a/docs/cli/update.md b/docs/cli/update.md index d1c61518b0c..dc19fbafbfa 100644 --- a/docs/cli/update.md +++ b/docs/cli/update.md @@ -24,6 +24,7 @@ openclaw update --tag beta openclaw update --tag main openclaw update --dry-run openclaw update --no-restart +openclaw update --yes openclaw update --json openclaw --update ``` @@ -36,6 +37,7 @@ openclaw --update - `--dry-run`: preview planned update actions (channel/tag/target/restart flow) without writing config, installing, syncing plugins, or restarting. - `--json`: print machine-readable `UpdateRunResult` JSON. - `--timeout `: per-step timeout (default is 1200s). +- `--yes`: skip confirmation prompts (for example downgrade confirmation) Note: downgrades require confirmation because older versions can break configuration. @@ -60,6 +62,10 @@ Interactive flow to pick an update channel and confirm whether to restart the Ga after updating (default is to restart). If you select `dev` without a git checkout, it offers to create one. +Options: + +- `--timeout `: timeout for each update step (default `1200`) + ## What it does When you switch channels explicitly (`--channel ...`), OpenClaw also keeps the