mirror of
https://github.com/openclaw/openclaw.git
synced 2026-09-28 05:54:09 +08:00
Alex NaidisandAyaan Zaidi
b810a28a4a
## What Problem This Solves Gateway and daemon install help omitted that installation starts the service and that forced reinstallation may restart a running Gateway. Operators could activate the service before finishing offline configuration or runtime repairs. ## Why This Change Was Made State those effects in the shared install help, Gateway CLI index, and daemon reference. Tell operators to finish offline configuration and runtime repairs before installation. Service behavior, public options, and the private updater handoff stay unchanged. This retains @TheCrazyLex's activation-help contribution and commit ancestry. The separate Doctor, user-bus, and systemd drop-in diagnosis changes remain outside this repair; [PR #137647](https://github.com/openclaw/openclaw/pull/137647) owns that work. ## User Impact Operators reading install help or the updated reference pages can see the activation risk before running the command. The linked Gateway service guide remains unchanged, so direct visitors to that page can still miss the index notice. ## Evidence - Actual `pnpm openclaw gateway install --help` and `pnpm openclaw daemon install --help` on pinned main omit startup and restart effects. Both commands on `4d802b78fb94344d2dac839663d94053cad348d5` display the corrected descriptions and preserve the existing public options. - The official Mintlify preview renders the Gateway index, daemon reference, and linked service guide on baseline and candidate. Inspected before/after screenshots, full article text and HTML, and browser results confirm the new visible warnings on the two updated pages. No browser errors were recorded. - The 36 focused registration tests remain valid for unchanged test and implementation inputs. Fresh formatting, syntax lint, both changed pages' MDX checks, and the 13,190-link audit pass. Independent source and behavior reviews agree within the stated scope. - Native launchd, systemd, and Scheduled Task owners were source-audited. Proof executed help and documentation preview only; no Gateway service installation or lifecycle action was run. The preview retains its existing missing ClawHub-mirror and inactive-search warnings. Mobile layout, search, expanded service-guide panels, and published-site deployment are outside this proof. The screenshot links require authenticated GitHub access in the verified retrieval path; anonymous requests returned 404. All four authenticated downloads matched the original inspected PNG bytes. Complete local images are retained for independent review. <details> <summary>Gateway documentation preview</summary> | Before | After | | --- | --- | |  |  | </details> <details> <summary>Daemon documentation preview</summary> | Before | After | | --- | --- | |  |  | </details> Co-authored-by: Ayaan Zaidi <hi@obviy.us>
11 KiB
11 KiB
summary, read_when, title, sidebarTitle
| summary | read_when | title | sidebarTitle | ||||
|---|---|---|---|---|---|---|---|
| OpenClaw Gateway CLI (`openclaw gateway`) — run, query, and discover gateways |
|
Gateway | Gateway |
The Gateway is OpenClaw's WebSocket server (channels, nodes, sessions, hooks). All subcommands on the pages listed here live under openclaw gateway ....
openclaw daemon ... is a legacy alias for the service-control subcommands; see openclaw daemon.
Gateway CLI pages
This page is an index. Five pages document openclaw gateway, one per reader
job. Open the page that matches your task.
| Page | Read it when |
|---|---|
| Run the Gateway | You are starting the Gateway, tuning its run options, or reading its shared token. |
| Restart and supervision | You are restarting the Gateway, or an external supervisor owns its lifecycle. |
| Query a running Gateway | You want health, status, stability, diagnostics, or a direct RPC call. |
| Manage the Gateway service | You are installing, starting, stopping, or repairing the native service. |
| Discover gateways (Bonjour) | You are looking for gateways over mDNS or wide-area DNS-SD. |
openclaw gateway install installs and starts the service. --force reinstalls an existing install and may restart a running Gateway. Finish offline configuration and runtime repairs before installation.
Where each section moved
Every anchor from the previous single-page version still resolves here, so an
existing link such as /cli/gateway#manage-the-gateway-service keeps working.
Each entry points at the page that now holds the content.
- Run the Gateway
- Options
- Reveal the configured token
- Restart the Gateway
- Install identity
- External supervisors
- Gateway profiling
- Query a running Gateway
gateway healthgateway usage-costgateway stabilitygateway diagnostics exportgateway statusgateway probe- Remote over SSH (Mac app parity)
gateway call <method>gateway suspendgateway resume <suspensionId>- Manage the Gateway service
- Recover an unreadable native service definition
- Lifecycle requests from Gateway chat
- Install with a wrapper
- Discover gateways (Bonjour)
gateway discover- Remote over SSH (Mac app parity)
gateway call <method>gateway resume <suspensionId>- Discover gateways (Bonjour)
Option, tab, and panel anchors:
- Startup behavior
--port--bind--token--auth--password--tailscale--allow-unconfigured--dev--ambient-channels--dev-ambient-channels--reset--force--verbose--cli-backend-logs--ws-log--compact--raw-stream- Output modes
- Shared options
--port--days--agent--all-agents--limit--type--since-seq--bundle--export- Privacy and bundle behavior
--log-lines--log-bytes--url--token--password--timeout--no-stability-bundle--json--url--port--token--password--timeout--no-probe--deep--require-rpc- Status semantics
- Linux systemd auth-drift checks
--port- Interpretation
- JSON output
- Common warning codes
--ssh--ssh-auto--params--url--port--token--password--timeout--expect-final--json- Command options
- Service runtime
- Lifecycle behavior
- Managed Gateway heap sizing
- Auth and SecretRefs at install time
--timeout--json