docs: refresh gateway update and memory refs

This commit is contained in:
Peter Steinberger
2026-04-04 08:52:33 +01:00
parent 4c450ede65
commit 470898b5e1
4 changed files with 64 additions and 2 deletions

View File

@@ -196,6 +196,21 @@ openclaw gateway call status
openclaw gateway call logs.tail --params '{"sinceMs": 60000}'
```
Options:
- `--params <json>`: JSON object string for params (default `{}`)
- `--url <url>`
- `--token <token>`
- `--password <password>`
- `--timeout <ms>`
- `--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 <node|bun>`, `--token`, `--force`, `--json`
- `gateway uninstall|start|stop|restart`: `--json`
Notes:
- `gateway install` supports `--port`, `--runtime`, `--token`, `--force`, `--json`.

View File

@@ -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 "<query>"` (or `--query "<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 <stable|beta|dev>`
- `--tag <dist-tag|version|spec>`
- `--timeout <seconds>`
- `--yes`
Subcommands:
- `update status`
- `update wizard`
`update status` options:
- `--json`
- `--timeout <seconds>`
`update wizard` options:
- `--timeout <seconds>`
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 <method> [--params <json>]`
- `gateway call <method> [--params <json>] [--url <url>] [--token <token>] [--password <password>] [--timeout <ms>] [--expect-final] [--json]`
- `gateway health`
- `gateway status`
- `gateway probe`

View File

@@ -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`:

View File

@@ -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 <seconds>`: 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 <seconds>`: timeout for each update step (default `1200`)
## What it does
When you switch channels explicitly (`--channel ...`), OpenClaw also keeps the