diff --git a/docs/cli/agent.md b/docs/cli/agent.md index 5975b94ab2c..98a65f7b071 100644 --- a/docs/cli/agent.md +++ b/docs/cli/agent.md @@ -55,3 +55,8 @@ openclaw agent --agent ops --message "Run locally" --local - `--channel`, `--reply-channel`, and `--reply-account` affect reply delivery, not session routing. - When this command triggers `models.json` regeneration, SecretRef-managed provider credentials are persisted as non-secret markers (for example env var names, `secretref-env:ENV_VAR_NAME`, or `secretref-managed`), not resolved secret plaintext. - Marker writes are source-authoritative: OpenClaw persists markers from the active source config snapshot, not from resolved runtime secret values. + +## Related + +- [CLI reference](/cli) +- [Agent runtime](/concepts/agent) diff --git a/docs/cli/agents.md b/docs/cli/agents.md index c58d4d6b140..c58e074f619 100644 --- a/docs/cli/agents.md +++ b/docs/cli/agents.md @@ -218,3 +218,9 @@ Config sample: }, } ``` + +## Related + +- [CLI reference](/cli) +- [Multi-agent routing](/concepts/multi-agent) +- [Agent workspace](/concepts/agent-workspace) diff --git a/docs/cli/approvals.md b/docs/cli/approvals.md index 6be5f55573b..2ca14ea3b9b 100644 --- a/docs/cli/approvals.md +++ b/docs/cli/approvals.md @@ -183,3 +183,8 @@ Targeting notes: - `--agent` defaults to `"*"`, which applies to all agents. - The node host must advertise `system.execApprovals.get/set` (macOS app or headless node host). - Approvals files are stored per host at `~/.openclaw/exec-approvals.json`. + +## Related + +- [CLI reference](/cli) +- [Exec approvals](/tools/exec-approvals) diff --git a/docs/cli/channels.md b/docs/cli/channels.md index d361102d0d5..2eb834d542a 100644 --- a/docs/cli/channels.md +++ b/docs/cli/channels.md @@ -129,3 +129,8 @@ Notes: - Use `--kind user|group|auto` to force the target type. - Resolution prefers active matches when multiple entries share the same name. - `channels resolve` is read-only. If a selected account is configured via SecretRef but that credential is unavailable in the current command path, the command returns degraded unresolved results with notes instead of aborting the entire run. + +## Related + +- [CLI reference](/cli) +- [Channels overview](/channels) diff --git a/docs/cli/config.md b/docs/cli/config.md index 280116d79dc..08569260377 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -428,3 +428,8 @@ Typical repair loop: - Apply targeted edits with `openclaw config set` or `openclaw configure`. - Rerun `openclaw config validate` after each change. - If validation passes but the runtime is still unhealthy, run `openclaw doctor` or `openclaw doctor --fix` for migration and repair help. + +## Related + +- [CLI reference](/cli) +- [Configuration](/gateway/configuration) diff --git a/docs/cli/hooks.md b/docs/cli/hooks.md index 7d07dcefe85..8ddb5002bba 100644 --- a/docs/cli/hooks.md +++ b/docs/cli/hooks.md @@ -336,3 +336,8 @@ openclaw hooks enable boot-md ``` **See:** [boot-md documentation](/automation/hooks#boot-md) + +## Related + +- [CLI reference](/cli) +- [Automation hooks](/automation/hooks) diff --git a/docs/cli/infer.md b/docs/cli/infer.md index e2c8de8344b..be1a460ccd4 100644 --- a/docs/cli/infer.md +++ b/docs/cli/infer.md @@ -279,3 +279,8 @@ openclaw infer audio transcribe --file ./memo.m4a --model openai/whisper-1 --jso ## Notes - `openclaw capability ...` is an alias for `openclaw infer ...`. + +## Related + +- [CLI reference](/cli) +- [Models](/concepts/models) diff --git a/docs/cli/mcp.md b/docs/cli/mcp.md index 9dfa018d723..2256616a4e0 100644 --- a/docs/cli/mcp.md +++ b/docs/cli/mcp.md @@ -516,3 +516,8 @@ Current limits: - HTTP/SSE/streamable-http transport connects to a single remote server; no multiplexed upstream yet - `permissions_list_open` only includes approvals observed while the bridge is connected + +## Related + +- [CLI reference](/cli) +- [Plugins](/cli/plugins) diff --git a/docs/cli/models.md b/docs/cli/models.md index b9906327323..0a1f7a66ed5 100644 --- a/docs/cli/models.md +++ b/docs/cli/models.md @@ -142,3 +142,9 @@ Notes: relative duration such as `365d` or `12h`. - Anthropic note: Anthropic staff told us OpenClaw-style Claude CLI usage is allowed again, so OpenClaw treats Claude CLI reuse and `claude -p` usage as sanctioned for this integration unless Anthropic publishes a new policy. - Anthropic `setup-token` / `paste-token` remain available as a supported OpenClaw token path, but OpenClaw now prefers Claude CLI reuse and `claude -p` when available. + +## Related + +- [CLI reference](/cli) +- [Model selection](/concepts/model-providers) +- [Model failover](/concepts/model-failover) diff --git a/docs/cli/nodes.md b/docs/cli/nodes.md index f345196c36d..df23c6ffc2e 100644 --- a/docs/cli/nodes.md +++ b/docs/cli/nodes.md @@ -64,3 +64,8 @@ Invoke flags: For shell execution on a node, use the `exec` tool with `host=node` instead of `openclaw nodes run`. The `nodes` CLI is now capability-focused: direct RPC via `nodes invoke`, plus pairing, camera, screen, location, canvas, and notifications. + +## Related + +- [CLI reference](/cli) +- [Nodes](/nodes) diff --git a/docs/cli/pairing.md b/docs/cli/pairing.md index 467c947eb03..9a6d00b8340 100644 --- a/docs/cli/pairing.md +++ b/docs/cli/pairing.md @@ -63,3 +63,8 @@ Options: - `pairing list` supports `--account ` for multi-account channels. - `pairing approve` supports `--account ` and `--notify`. - If only one pairing-capable channel is configured, `pairing approve ` is allowed. + +## Related + +- [CLI reference](/cli) +- [Channel pairing](/channels/pairing) diff --git a/docs/cli/plugins.md b/docs/cli/plugins.md index fd84f54538a..d36241c8a7d 100644 --- a/docs/cli/plugins.md +++ b/docs/cli/plugins.md @@ -327,3 +327,9 @@ Marketplace list accepts a local marketplace path, a `marketplace.json` path, a GitHub shorthand like `owner/repo`, a GitHub repo URL, or a git URL. `--json` prints the resolved source label plus the parsed marketplace manifest and plugin entries. + +## Related + +- [CLI reference](/cli) +- [Building plugins](/plugins/building-plugins) +- [Community plugins](/plugins/community) diff --git a/docs/cli/sandbox.md b/docs/cli/sandbox.md index a183692bc41..2cc2656c9af 100644 --- a/docs/cli/sandbox.md +++ b/docs/cli/sandbox.md @@ -193,3 +193,8 @@ Sandbox settings live in `~/.openclaw/openclaw.json` under `agents.defaults.sand - [Sandbox Documentation](/gateway/sandboxing) - [Agent Configuration](/concepts/agent-workspace) - [Doctor Command](/gateway/doctor) - Check sandbox setup + +## Related + +- [CLI reference](/cli) +- [Sandboxing](/gateway/sandboxing) diff --git a/docs/cli/sessions.md b/docs/cli/sessions.md index f381a9e5d28..fd13c033efa 100644 --- a/docs/cli/sessions.md +++ b/docs/cli/sessions.md @@ -111,3 +111,8 @@ openclaw sessions cleanup --json Related: - Session config: [Configuration reference](/gateway/configuration-reference#session) + +## Related + +- [CLI reference](/cli) +- [Session management](/concepts/session) diff --git a/docs/cli/skills.md b/docs/cli/skills.md index c86e068beb3..88ba29bfa94 100644 --- a/docs/cli/skills.md +++ b/docs/cli/skills.md @@ -57,3 +57,8 @@ Notes: - `list`, `info`, and `check` write their rendered output to stdout. With `--json`, that means the machine-readable payload stays on stdout for pipes and scripts. + +## Related + +- [CLI reference](/cli) +- [Skills](/tools/skills) diff --git a/docs/cli/status.md b/docs/cli/status.md index 2b842283ac3..e493528acba 100644 --- a/docs/cli/status.md +++ b/docs/cli/status.md @@ -34,3 +34,8 @@ Notes: - If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as “configured token unavailable in this command path”, and JSON output includes `secretDiagnostics`. - When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient “secret unavailable” channel markers from the final output. - `status --all` includes a Secrets overview row and a diagnosis section that summarizes secret diagnostics (truncated for readability) without stopping report generation. + +## Related + +- [CLI reference](/cli) +- [Doctor](/gateway/doctor) diff --git a/docs/gateway/authentication.md b/docs/gateway/authentication.md index 0fd1f941032..60ba4f6a13b 100644 --- a/docs/gateway/authentication.md +++ b/docs/gateway/authentication.md @@ -202,3 +202,9 @@ openclaw models status Run `openclaw models status` to confirm which profile is expiring. If an Anthropic token profile is missing or expired, refresh that setup via setup-token or migrate to an Anthropic API key. + +## Related + +- [Secrets management](/gateway/secrets) +- [Remote access](/gateway/remote) +- [Auth storage](/concepts/oauth) diff --git a/docs/gateway/configuration-examples.md b/docs/gateway/configuration-examples.md index 5cfc45db90a..4899b3fe521 100644 --- a/docs/gateway/configuration-examples.md +++ b/docs/gateway/configuration-examples.md @@ -627,3 +627,8 @@ Only enable direct mutable name/email/nick matching with each channel's `dangero - Provider IDs differ (phone numbers, user IDs, channel IDs). Use the provider docs to confirm the format. - Optional sections to add later: `web`, `browser`, `ui`, `discovery`, `canvasHost`, `talk`, `signal`, `imessage`. - See [Providers](/providers) and [Troubleshooting](/gateway/troubleshooting) for deeper setup notes. + +## Related + +- [Configuration reference](/gateway/configuration-reference) +- [Configuration](/gateway/configuration) diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index 5a5811c148a..4b038712a0f 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -3913,3 +3913,8 @@ Split config into multiple files: --- _Related: [Configuration](/gateway/configuration) · [Configuration Examples](/gateway/configuration-examples) · [Doctor](/gateway/doctor)_ + +## Related + +- [Configuration](/gateway/configuration) +- [Configuration examples](/gateway/configuration-examples) diff --git a/docs/gateway/configuration.md b/docs/gateway/configuration.md index ae4fdb94cf4..afa60e1e37a 100644 --- a/docs/gateway/configuration.md +++ b/docs/gateway/configuration.md @@ -685,3 +685,9 @@ For the complete field-by-field reference, see **[Configuration Reference](/gate --- _Related: [Configuration Examples](/gateway/configuration-examples) · [Configuration Reference](/gateway/configuration-reference) · [Doctor](/gateway/doctor)_ + +## Related + +- [Configuration reference](/gateway/configuration-reference) +- [Configuration examples](/gateway/configuration-examples) +- [Gateway runbook](/gateway) diff --git a/docs/gateway/discovery.md b/docs/gateway/discovery.md index 45673b594cf..100a60b3b3c 100644 --- a/docs/gateway/discovery.md +++ b/docs/gateway/discovery.md @@ -139,3 +139,9 @@ The gateway is the source of truth for node/client admission. - **Gateway**: advertises discovery beacons, owns pairing decisions, and hosts the WS endpoint. - **macOS app**: helps you pick a gateway, shows pairing prompts, and uses SSH only as a fallback. - **iOS/Android nodes**: browse Bonjour as a convenience and connect to the paired Gateway WS. + +## Related + +- [Remote access](/gateway/remote) +- [Tailscale](/gateway/tailscale) +- [Bonjour discovery](/gateway/bonjour) diff --git a/docs/gateway/doctor.md b/docs/gateway/doctor.md index ba518317555..456826cad79 100644 --- a/docs/gateway/doctor.md +++ b/docs/gateway/doctor.md @@ -573,3 +573,8 @@ if the workspace is not already under git. See [/concepts/agent-workspace](/concepts/agent-workspace) for a full guide to workspace structure and git backup (recommended private GitHub or GitLab). + +## Related + +- [Gateway troubleshooting](/gateway/troubleshooting) +- [Gateway runbook](/gateway) diff --git a/docs/gateway/health.md b/docs/gateway/health.md index d7aabcbf8ca..37a9e803442 100644 --- a/docs/gateway/health.md +++ b/docs/gateway/health.md @@ -61,3 +61,9 @@ Options: - `--debug`: alias for `--verbose` The health snapshot includes: `ok` (boolean), `ts` (timestamp), `durationMs` (probe time), per-channel status, agent availability, and session-store summary. + +## Related + +- [Gateway runbook](/gateway) +- [Diagnostics export](/gateway/diagnostics) +- [Gateway troubleshooting](/gateway/troubleshooting) diff --git a/docs/gateway/index.md b/docs/gateway/index.md index 6d4b2db80c5..f561bacd0b2 100644 --- a/docs/gateway/index.md +++ b/docs/gateway/index.md @@ -356,3 +356,10 @@ Related: - [Health](/gateway/health) - [Doctor](/gateway/doctor) - [Authentication](/gateway/authentication) + +## Related + +- [Configuration](/gateway/configuration) +- [Gateway troubleshooting](/gateway/troubleshooting) +- [Remote access](/gateway/remote) +- [Secrets management](/gateway/secrets) diff --git a/docs/gateway/local-models.md b/docs/gateway/local-models.md index 00152f73028..0b023a8743a 100644 --- a/docs/gateway/local-models.md +++ b/docs/gateway/local-models.md @@ -185,3 +185,8 @@ Compatibility notes for stricter OpenAI-compatible backends: `compat.supportsTools: false`, then retest. If the server still crashes only on larger OpenClaw prompts, treat it as an upstream server/model limitation. - Safety: local models skip provider-side filters; keep agents narrow and compaction on to limit prompt injection blast radius. + +## Related + +- [Configuration reference](/gateway/configuration-reference) +- [Model failover](/concepts/model-failover) diff --git a/docs/gateway/multiple-gateways.md b/docs/gateway/multiple-gateways.md index 4c8948509ae..8572a9d3c2f 100644 --- a/docs/gateway/multiple-gateways.md +++ b/docs/gateway/multiple-gateways.md @@ -172,3 +172,9 @@ Interpretation: - `gateway status --deep` helps catch stale launchd/systemd/schtasks services from older installs. - `gateway probe` warning text such as `multiple reachable gateways detected` is expected only when you intentionally run more than one isolated gateway. + +## Related + +- [Gateway runbook](/gateway) +- [Gateway lock](/gateway/gateway-lock) +- [Configuration](/gateway/configuration) diff --git a/docs/gateway/network-model.md b/docs/gateway/network-model.md index 775fb293631..7d3f28d1386 100644 --- a/docs/gateway/network-model.md +++ b/docs/gateway/network-model.md @@ -21,3 +21,9 @@ process that owns channel connections and the WebSocket control plane. - `/__openclaw__/a2ui/` When `gateway.auth` is configured and the Gateway binds beyond loopback, these routes are protected by Gateway auth. Node clients use node-scoped capability URLs tied to their active WS session. See [Gateway configuration](/gateway/configuration) (`canvasHost`, `gateway`). - Remote use is typically SSH tunnel or tailnet VPN. See [Remote access](/gateway/remote) and [Discovery](/gateway/discovery). + +## Related + +- [Remote access](/gateway/remote) +- [Trusted proxy auth](/gateway/trusted-proxy-auth) +- [Gateway protocol](/gateway/protocol) diff --git a/docs/gateway/pairing.md b/docs/gateway/pairing.md index d34ad0eca9e..fa1e32598f5 100644 --- a/docs/gateway/pairing.md +++ b/docs/gateway/pairing.md @@ -166,3 +166,9 @@ Security notes: - The transport is **stateless**; it does not store membership. - If the Gateway is offline or pairing is disabled, nodes cannot pair. - If the Gateway is in remote mode, pairing still happens against the remote Gateway’s store. + +## Related + +- [Channel pairing](/channels/pairing) +- [Nodes](/nodes) +- [Devices CLI](/cli/devices) diff --git a/docs/gateway/protocol.md b/docs/gateway/protocol.md index 991537243c0..0932342ebb4 100644 --- a/docs/gateway/protocol.md +++ b/docs/gateway/protocol.md @@ -615,3 +615,8 @@ Migration target: This protocol exposes the **full gateway API** (status, channels, models, chat, agent, sessions, nodes, approvals, etc.). The exact surface is defined by the TypeBox schemas in `src/gateway/protocol/schema.ts`. + +## Related + +- [Bridge protocol](/gateway/bridge-protocol) +- [Gateway runbook](/gateway) diff --git a/docs/gateway/remote.md b/docs/gateway/remote.md index 486d642f850..c43fd735aa7 100644 --- a/docs/gateway/remote.md +++ b/docs/gateway/remote.md @@ -249,3 +249,9 @@ launchctl bootout gui/$UID/ai.openclaw.ssh-tunnel | `ssh -N` | SSH without executing remote commands (port-forwarding only) | | `KeepAlive` | Automatically restarts the tunnel if it crashes | | `RunAtLoad` | Starts the tunnel when the LaunchAgent loads at login | + +## Related + +- [Tailscale](/gateway/tailscale) +- [Authentication](/gateway/authentication) +- [Remote gateway setup](/gateway/remote-gateway-readme) diff --git a/docs/gateway/tailscale.md b/docs/gateway/tailscale.md index 25c74cad92a..98c241fc0f1 100644 --- a/docs/gateway/tailscale.md +++ b/docs/gateway/tailscale.md @@ -134,3 +134,9 @@ Avoid Funnel for browser control; treat node pairing like operator access. - `tailscale serve` command: [https://tailscale.com/kb/1242/tailscale-serve](https://tailscale.com/kb/1242/tailscale-serve) - Tailscale Funnel overview: [https://tailscale.com/kb/1223/tailscale-funnel](https://tailscale.com/kb/1223/tailscale-funnel) - `tailscale funnel` command: [https://tailscale.com/kb/1311/tailscale-funnel](https://tailscale.com/kb/1311/tailscale-funnel) + +## Related + +- [Remote access](/gateway/remote) +- [Discovery](/gateway/discovery) +- [Authentication](/gateway/authentication) diff --git a/docs/gateway/troubleshooting.md b/docs/gateway/troubleshooting.md index 820f769afbd..3c46255bfeb 100644 --- a/docs/gateway/troubleshooting.md +++ b/docs/gateway/troubleshooting.md @@ -564,3 +564,9 @@ Related: - [/gateway/pairing](/gateway/pairing) - [/gateway/authentication](/gateway/authentication) - [/gateway/background-process](/gateway/background-process) + +## Related + +- [Gateway runbook](/gateway) +- [Doctor](/gateway/doctor) +- [FAQ](/help/faq) diff --git a/docs/platforms/android.md b/docs/platforms/android.md index c375357c1dc..da5123b1367 100644 --- a/docs/platforms/android.md +++ b/docs/platforms/android.md @@ -240,3 +240,9 @@ Example configuration: Notification forwarding requires the Android Notification Listener permission. The app prompts for this during setup. + +## Related + +- [iOS app](/platforms/ios) +- [Nodes](/nodes) +- [Android node troubleshooting](/nodes/troubleshooting) diff --git a/docs/platforms/index.md b/docs/platforms/index.md index 7787f915efa..063816214b0 100644 --- a/docs/platforms/index.md +++ b/docs/platforms/index.md @@ -52,3 +52,9 @@ The service target depends on OS: - macOS: LaunchAgent (`ai.openclaw.gateway` or `ai.openclaw.`; legacy `com.openclaw.*`) - Linux/WSL2: systemd user service (`openclaw-gateway[-].service`) - Native Windows: Scheduled Task (`OpenClaw Gateway` or `OpenClaw Gateway ()`), with a per-user Startup-folder login item fallback if task creation is denied + +## Related + +- [Install overview](/install) +- [macOS app](/platforms/macos) +- [iOS app](/platforms/ios) diff --git a/docs/platforms/linux.md b/docs/platforms/linux.md index 93e26054694..d98674cfc2e 100644 --- a/docs/platforms/linux.md +++ b/docs/platforms/linux.md @@ -133,3 +133,9 @@ its normal score, usually `0`. This does not replace normal memory tuning. If a VPS or container repeatedly kills children, increase the memory limit, reduce concurrency, or add stronger resource controls such as systemd `MemoryMax=` or container-level memory limits. + +## Related + +- [Install overview](/install) +- [Linux server](/vps) +- [Raspberry Pi](/platforms/raspberry-pi) diff --git a/docs/platforms/windows.md b/docs/platforms/windows.md index 3a10fabfdff..cba75a5f1a7 100644 --- a/docs/platforms/windows.md +++ b/docs/platforms/windows.md @@ -247,3 +247,8 @@ Full guide: [Getting Started](/start/getting-started) We do not have a Windows companion app yet. Contributions are welcome if you want contributions to make it happen. + +## Related + +- [Install overview](/install) +- [Platforms](/platforms)