CLI commands
Gateway
The Gateway ist der WebSocket-Server von OpenClaw (Kanäle, Nodes, Sitzungen, Hooks). Die Unterbefehle auf dieser Seite befinden sich unter openclaw gateway ….
Lokale mDNS- + Wide-Area-DNS-SD-Einrichtung.
Wie OpenClaw Gateways ankündigt und findet.
Gateway-Konfigurationsschlüssel auf oberster Ebene.
Gateway ausführen
Führen Sie einen lokalen Gateway-Prozess aus:
openclaw gatewayVordergrund-Alias:
openclaw gateway runStartverhalten
- Standardmäßig verweigert der Gateway den Start, sofern
gateway.mode=localnicht in~/.openclaw/openclaw.jsongesetzt ist. Verwenden Sie--allow-unconfiguredfür Ad-hoc-/Entwicklungsläufe. - Von
openclaw onboard --mode localundopenclaw setupwird erwartet, dass siegateway.mode=localschreiben. Wenn die Datei existiert, abergateway.modefehlt, behandeln Sie dies als beschädigte oder überschriebene Konfiguration und reparieren Sie sie, statt implizit den lokalen Modus anzunehmen. - Wenn die Datei existiert und
gateway.modefehlt, behandelt der Gateway dies als verdächtige Konfigurationsbeschädigung und verweigert es, für Sie „lokal zu raten“. - Binden über Loopback hinaus ohne Authentifizierung wird blockiert (Sicherheitsleitplanke).
lan,tailnetundcustomwerden derzeit über reine IPv4-BYOH-Pfade aufgelöst.- Reines IPv6-BYOH wird auf diesem Pfad heute nicht nativ unterstützt. Verwenden Sie einen IPv4-Sidecar oder -Proxy, wenn der Host selbst nur IPv6 unterstützt.
SIGUSR1löst bei Autorisierung einen prozessinternen Neustart aus (commands.restartist standardmäßig aktiviert; setzen Siecommands.restart: false, um manuelle Neustarts zu blockieren, während Anwenden/Aktualisieren von Gateway-Tool/-Konfiguration weiterhin erlaubt bleibt).SIGINT-/SIGTERM-Handler stoppen den Gateway-Prozess, stellen aber keinen benutzerdefinierten Terminalzustand wieder her. Wenn Sie die CLI mit einer TUI oder Raw-Mode-Eingabe umschließen, stellen Sie das Terminal vor dem Beenden wieder her.
Optionen
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA
" type="number">
WebSocket-Port (Standardwert kommt aus Konfiguration/Umgebung; normalerweise 18789).
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tYmluZCA8bG9vcGJhY2t8bGFufHRhaWxuZXR8YXV0b3xjdXN0b20
" type="string">
Listener-Bind-Modus. lan, tailnet und custom werden derzeit über reine IPv4-Pfade aufgelöst.
"--authOPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdG9rZW4gPHRva2Vu
" type="string">
Token-Überschreibung (setzt außerdem OPENCLAW_GATEWAY_TOKEN für den Prozess).
"--password"--tailscale--tailscale-reset-on-exitbooleanTailscale-Serve-/Funnel-Konfiguration beim Herunterfahren zurücksetzen.
--bind custom + gateway.customBindHoststringErwartet heute eine IPv4-Adresse. Für reines IPv6-BYOH platzieren Sie einen IPv4-Sidecar oder -Proxy vor dem Gateway und richten OpenClaw auf diesen IPv4-Endpunkt aus.
--allow-unconfiguredbooleanGateway-Start ohne gateway.mode=local in der Konfiguration erlauben. Umgeht die Startschutzprüfung nur für Ad-hoc-/Entwicklungs-Bootstrap; schreibt oder repariert die Konfigurationsdatei nicht.
--devbooleanEntwicklungskonfiguration + Workspace erstellen, falls fehlend (überspringt BOOTSTRAP.md).
--resetbooleanEntwicklungskonfiguration + Anmeldedaten + Sitzungen + Workspace zurücksetzen (erfordert --dev).
--forcebooleanVor dem Start jeden vorhandenen Listener auf dem ausgewählten Port beenden.
--verbosebooleanAusführliche Logs.
--cli-backend-logsbooleanNur CLI-Backend-Logs in der Konsole anzeigen (und stdout/stderr aktivieren).
"--ws-log--compactbooleanAlias für --ws-log compact.
--raw-streambooleanRohe Modellstream-Ereignisse nach jsonl loggen.
Gateway neu starten
openclaw gateway restartopenclaw gateway restart --safeopenclaw gateway restart --safe --skip-deferralopenclaw gateway restart --forceopenclaw gateway restart --safe fordert den laufenden Gateway auf, aktive Arbeit vorab zu prüfen und einen zusammengefassten Neustart zu planen, nachdem aktive Arbeit abgeflossen ist. Der standardmäßige sichere Neustart wartet bis zum konfigurierten gateway.reload.deferralTimeoutMs (Standard 5 Minuten) auf aktive Arbeit; wenn dieses Budget abläuft, wird der Neustart erzwungen. Setzen Sie gateway.reload.deferralTimeoutMs auf 0, um unbegrenzt sicher zu warten, ohne jemals zu erzwingen. Einfaches restart behält das vorhandene Service-Manager-Verhalten bei; --force bleibt der sofortige Überschreibungspfad.
openclaw gateway restart --safe --skip-deferral führt denselben OpenClaw-bewussten koordinierten Neustart wie --safe aus, umgeht aber die Verzögerungssperre für aktive Arbeit, sodass der Gateway den Neustart sofort ausgibt, auch wenn Blocker gemeldet werden. Verwenden Sie es als Operator-Ausweg, wenn eine Verzögerung durch einen hängengebliebenen Aufgabenlauf festgehalten wurde und --safe allein durch gateway.reload.deferralTimeoutMs begrenzt sein kann. --skip-deferral erfordert --safe.
Gateway-Profiling
- Setzen Sie
OPENCLAW_GATEWAY_STARTUP_TRACE=1, um Phasenzeiten während des Gateway-Starts zu loggen, einschließlicheventLoopMax-Verzögerung pro Phase und Plugin-Lookup-Table-Zeiten für Installed-Index, Manifest-Registry, Startplanung und Owner-Map-Arbeit. - Setzen Sie
OPENCLAW_GATEWAY_RESTART_TRACE=1, um neustartbezogenerestart trace:-Zeilen für Neustartsignalbehandlung, Abfluss aktiver Arbeit, Herunterfahrphasen, nächsten Start, Ready-Timing und Speichermetriken zu loggen. - Setzen Sie
OPENCLAW_DIAGNOSTICS=timelinemitOPENCLAW_DIAGNOSTICS_TIMELINE_PATH=<path>, um eine Best-Effort-JSONL-Startdiagnose-Timeline für externe QA-Harnesses zu schreiben. Sie können das Flag auch mitdiagnostics.flags: ["timeline"]in der Konfiguration aktivieren; der Pfad wird weiterhin per env bereitgestellt. Fügen SieOPENCLAW_DIAGNOSTICS_EVENT_LOOP=1hinzu, um Event-Loop-Samples einzubeziehen. - Führen Sie zuerst
pnpm buildaus, dannpnpm test:startup:gateway -- --runs 5 --warmup 1, um den Gateway-Start gegen den gebauten CLI-Einstieg zu benchmarken. Der Benchmark erfasst die erste Prozessausgabe,/healthz,/readyz, Start-Trace-Zeiten, Event-Loop-Verzögerung und Timing-Details der Plugin-Lookup-Tables. - Führen Sie zuerst
pnpm buildaus, dannpnpm test:restart:gateway -- --case skipChannels --runs 1 --restarts 5, um den prozessinternen Gateway-Neustart gegen den gebauten CLI-Einstieg auf macOS oder Linux zu benchmarken. Der Neustart-Benchmark verwendet SIGUSR1, aktiviert sowohl Start- als auch Neustart-Traces im Child-Prozess und erfasst das nächste/healthz, das nächste/readyz, Ausfallzeit, Ready-Timing, CPU, RSS und Neustart-Trace-Metriken. - Behandeln Sie
/healthzals Liveness und/readyzals nutzbare Readiness. Trace-Zeilen und Benchmark-Ausgabe dienen der Owner-Zuordnung; behandeln Sie keinen einzelnen Trace-Span oder einzelnen Sample als vollständiges Performance-Fazit.
Laufenden Gateway abfragen
Alle Abfragebefehle verwenden WebSocket-RPC.
Ausgabemodi
- Standard: menschenlesbar (farbig in TTY).
--json: maschinenlesbares JSON (ohne Styling/Spinner).--no-color(oderNO_COLOR=1): ANSI deaktivieren, während das menschenlesbare Layout beibehalten wird.
Gemeinsame Optionen
--url <url>: Gateway-WebSocket-URL.--token <token>: Gateway-Token.--password <password>: Gateway-Passwort.--timeout <ms>: Timeout/Budget (variiert je nach Befehl).--expect-final: auf eine „final“-Antwort warten (Agent-Aufrufe).
gateway health
openclaw gateway health --url ws://127.0.0.1:18789openclaw gateway health --port 18789Der HTTP-Endpunkt /healthz ist eine Liveness-Probe: Er antwortet, sobald der Server HTTP beantworten kann. Der HTTP-Endpunkt /readyz ist strenger und bleibt rot, während Start-Plugin-Sidecars, Kanäle oder konfigurierte Hooks noch stabilisieren. Lokale oder authentifizierte detaillierte Readiness-Antworten enthalten einen eventLoop-Diagnoseblock mit Event-Loop-Verzögerung, Event-Loop-Auslastung, CPU-Kern-Verhältnis und einem degraded-Flag.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA
" type="number">
Einen lokalen local loopback Gateway auf diesem Port ansprechen. Dies überschreibt OPENCLAW_GATEWAY_URL und OPENCLAW_GATEWAY_PORT für den Health-Aufruf.
gateway usage-cost
Nutzungskosten-Zusammenfassungen aus Sitzungslogs abrufen.
openclaw gateway usage-costopenclaw gateway usage-cost --days 7openclaw gateway usage-cost --agent work --jsonopenclaw gateway usage-cost --all-agentsopenclaw gateway usage-cost --json"--days"--agent--all-agentsbooleanKostenzusammenfassung über alle konfigurierten Agents aggregieren. Kann nicht mit --agent kombiniert werden.
gateway stability
Den aktuellen Diagnose-Stabilitätsrecorder von einem laufenden Gateway abrufen.
openclaw gateway stabilityopenclaw gateway stability --type payload.largeopenclaw gateway stability --bundle latestopenclaw gateway stability --bundle latest --exportopenclaw gateway stability --jsonOPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tbGltaXQgPGxpbWl0
" type="number" default="25">
Maximale Anzahl aktueller Ereignisse, die einbezogen werden sollen (max. 1000).
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdHlwZSA8dHlwZQ
" type="string">
Nach Diagnoseereignistyp filtern, z. B. payload.large oder diagnostic.memory.pressure.
"--since-seq--bundle [path]stringEin persistiertes Stabilitäts-Bundle lesen, statt den laufenden Gateway aufzurufen. Verwenden Sie --bundle latest (oder nur --bundle) für das neueste Bundle unter dem State-Verzeichnis, oder übergeben Sie direkt einen Bundle-JSON-Pfad.
--exportbooleanEine teilbare Support-Diagnose-ZIP schreiben, statt Stabilitätsdetails auszugeben.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tb3V0cHV0IDxwYXRo
" type="string">
Ausgabepfad für --export.
Datenschutz und Bundle-Verhalten
- Aufzeichnungen behalten operative Metadaten: Ereignisnamen, Zählwerte, Byte-Größen, Speichermesswerte, Queue-/Sitzungsstatus, Genehmigungs-IDs, Kanal-/Plugin-Namen und geschwärzte Sitzungszusammenfassungen. Sie behalten keine Chattexte, Webhook-Bodies, Tool-Ausgaben, rohen Request- oder Response-Bodies, Tokens, Cookies, Geheimwerte, Hostnamen oder rohen Sitzungs-IDs. Setzen Sie
diagnostics.enabled: false, um den Recorder vollständig zu deaktivieren. - Bei fatalen Gateway-Beendigungen, Shutdown-Timeouts und Neustart-Startfehlern schreibt OpenClaw denselben Diagnose-Snapshot nach
~/.openclaw/logs/stability/openclaw-stability-*.json, wenn der Recorder Ereignisse hat. Prüfen Sie das neueste Bundle mitopenclaw gateway stability --bundle latest;--limit,--typeund--since-seqgelten ebenfalls für Bundle-Ausgaben.
gateway diagnostics export
Schreibt eine lokale Diagnose-ZIP, die zum Anhängen an Fehlerberichte gedacht ist. Informationen zum Datenschutzmodell und zu Bundle-Inhalten finden Sie unter Diagnoseexport.
openclaw gateway diagnostics exportopenclaw gateway diagnostics export --output openclaw-diagnostics.zipopenclaw gateway diagnostics export --json"--log-lines"--log-bytes"--url"--token"--password"--timeout--no-stability-bundlebooleanSuche nach persistiertem Stabilitäts-Bundle überspringen.
--jsonbooleanGeschriebenen Pfad, Größe und Manifest als JSON ausgeben.
Der Export enthält ein Manifest, eine Markdown-Zusammenfassung, die Config-Form, bereinigte Config-Details, bereinigte Logzusammenfassungen, bereinigte Gateway-Status-/Health-Snapshots und das neueste Stabilitäts-Bundle, sofern eines vorhanden ist.
Er ist zum Teilen vorgesehen. Er behält Betriebsdetails bei, die beim Debugging helfen, zum Beispiel sichere OpenClaw-Logfelder, Subsystemnamen, Statuscodes, Laufzeiten, konfigurierte Modi, Ports, Plugin-IDs, Provider-IDs, nicht geheime Feature-Einstellungen und geschwärzte Betriebslogmeldungen. Er lässt Chattext, Webhook-Bodys, Tool-Ausgaben, Zugangsdaten, Cookies, Konto-/Nachrichtenkennungen, Prompt-/Anweisungstext, Hostnamen und geheime Werte aus oder schwärzt sie. Wenn eine LogTape-artige Meldung wie Nutzungs-, Chat- oder Tool-Payload-Text aussieht, behält der Export nur bei, dass eine Meldung ausgelassen wurde, sowie deren Byteanzahl.
gateway status
gateway status zeigt den Gateway-Dienst (launchd/systemd/schtasks) sowie optional eine Prüfung der Konnektivitäts-/Auth-Fähigkeit.
openclaw gateway statusopenclaw gateway status --jsonopenclaw gateway status --require-rpc"--url"--token"--password"--timeout--no-probebooleanKonnektivitätsprüfung überspringen (nur Dienstansicht).
--deepbooleanAuch Dienste auf Systemebene scannen.
--require-rpcbooleanDie standardmäßige Konnektivitätsprüfung zu einer Leseprüfung hochstufen und mit einem Nicht-Null-Code beenden, wenn diese Leseprüfung fehlschlägt. Kann nicht mit --no-probe kombiniert werden.
Statussemantik
gateway statusbleibt für Diagnosen verfügbar, selbst wenn die lokale CLI-Config fehlt oder ungültig ist.- Das standardmäßige
gateway statusweist Dienststatus, WebSocket-Verbindung und die zum Handshake-Zeitpunkt sichtbare Auth-Fähigkeit nach. Es weist keine Lese-/Schreib-/Admin-Operationen nach. - Diagnoseprüfungen verändern bei erstmaliger Geräte-Auth nichts: Sie verwenden ein vorhandenes gecachtes Geräte-Token wieder, wenn eines existiert, erstellen aber keine neue CLI-Geräteidentität und keinen schreibgeschützten Geräte-Pairing-Eintrag nur zur Statusprüfung.
gateway statuslöst konfigurierte Auth-SecretRefs für Prüf-Auth auf, wenn möglich.- Wenn ein erforderlicher Auth-SecretRef in diesem Befehlspfad nicht aufgelöst ist, meldet
gateway status --jsonrpc.authWarning, wenn Prüf-Konnektivität/Auth fehlschlägt; übergeben Sie--token/--passwordexplizit oder lösen Sie zuerst die Secret-Quelle auf. - Wenn die Prüfung erfolgreich ist, werden Warnungen zu nicht aufgelösten Auth-Refs unterdrückt, um Fehlalarme zu vermeiden.
- Wenn Prüfungen aktiviert sind, enthält die JSON-Ausgabe
gateway.version, wenn der laufende Gateway sie meldet;--require-rpckann auf den RPC-Payloadstatus.runtimeVersionzurückfallen, wenn die nachfolgende Handshake-Prüfung keine Versionsmetadaten bereitstellen kann. - Verwenden Sie
--require-rpcin Skripten und Automatisierung, wenn ein lauschender Dienst nicht ausreicht und auch RPC-Aufrufe mit Lese-Scope funktionieren müssen. --deepfügt einen Best-Effort-Scan nach zusätzlichen launchd-/systemd-/schtasks-Installationen hinzu. Wenn mehrere Gateway-ähnliche Dienste erkannt werden, gibt die menschenlesbare Ausgabe Bereinigungshinweise aus und warnt, dass die meisten Setups einen Gateway pro Maschine ausführen sollten.--deepmeldet außerdem eine kürzliche Übergabe eines Gateway-Supervisor-Neustarts, wenn der Dienstprozess sauber für einen externen Supervisor-Neustart beendet wurde.--deepführt Config-Validierung im Plugin-bewussten Modus (pluginValidation: "full") aus und zeigt Warnungen aus konfigurierten Plugin-Manifesten an (zum Beispiel fehlende Metadaten zur Channel-Config), damit Installations- und Update-Smoke-Checks sie erfassen. Das standardmäßigegateway statusbehält den schnellen schreibgeschützten Pfad bei, der Plugin-Validierung überspringt.- Die menschenlesbare Ausgabe enthält den aufgelösten Datei-Logpfad sowie einen Snapshot der CLI-gegen-Dienst-Config-Pfade/-Gültigkeit, um Drift bei Profilen oder State-Verzeichnissen zu diagnostizieren.
Linux-systemd-Auth-Drift-Prüfungen
- Bei Linux-systemd-Installationen lesen Dienst-Auth-Drift-Prüfungen sowohl
Environment=- als auchEnvironmentFile=-Werte aus der Unit (einschließlich%h, zitierter Pfade, mehrerer Dateien und optionaler--Dateien). - Drift-Prüfungen lösen
gateway.auth.token-SecretRefs mithilfe zusammengeführter Runtime-Env auf (zuerst Dienstbefehls-Env, dann Prozess-Env als Fallback). - Wenn Token-Auth nicht effektiv aktiv ist (expliziter
gateway.auth.modevonpassword/none/trusted-proxyoder nicht gesetzter Modus, bei dem Passwort gewinnen kann und kein Token-Kandidat gewinnen kann), überspringen Token-Drift-Prüfungen die Auflösung des Config-Tokens.
gateway probe
gateway probe ist der Befehl zum „alles debuggen“. Er prüft immer:
- Ihren konfigurierten Remote-Gateway (falls gesetzt) und
- localhost (local loopback) selbst wenn Remote konfiguriert ist.
Wenn Sie --url übergeben, wird dieses explizite Ziel vor beiden hinzugefügt. Die menschenlesbare Ausgabe beschriftet die Ziele als:
URL (explicit)Remote (configured)oderRemote (configured, inactive)Local loopback
openclaw gateway probeopenclaw gateway probe --jsonopenclaw gateway probe --port 18789OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA
" type="number">
Diesen Port für das lokale local loopback-Prüfziel und den Remote-Port des SSH-Tunnels verwenden. Ohne --url wählt dies das lokale local loopback-Ziel statt der konfigurierten Gateway-Environment-URL, des Environment-Ports oder Remote-Ziele aus.
Interpretation
Reachable: yesbedeutet, dass mindestens ein Ziel eine WebSocket-Verbindung akzeptiert hat.Capability: read-only|write-capable|admin-capable|pairing-pending|connect-onlymeldet, was die Prüfung über Auth nachweisen konnte. Dies ist von der Erreichbarkeit getrennt.Read probe: okbedeutet, dass Detail-RPC-Aufrufe mit Lese-Scope (health/status/system-presence/config.get) ebenfalls erfolgreich waren.Read probe: limited - missing scope: operator.readbedeutet, dass die Verbindung erfolgreich war, aber der Lese-Scope-RPC eingeschränkt ist. Dies wird als eingeschränkte Erreichbarkeit gemeldet, nicht als vollständiger Fehler.Read probe: failednachConnect: okbedeutet, dass der Gateway die WebSocket-Verbindung akzeptiert hat, nachfolgende Lesediagnosen jedoch einen Timeout hatten oder fehlgeschlagen sind. Auch dies ist eingeschränkte Erreichbarkeit, kein unerreichbarer Gateway.- Wie
gateway statusverwendet probe vorhandene gecachte Geräte-Auth wieder, erstellt aber keine erstmalige Geräteidentität oder Pairing-State. - Der Exit-Code ist nur dann ungleich null, wenn kein geprüftes Ziel erreichbar ist.
JSON-Ausgabe
Oberste Ebene:
ok: Mindestens ein Ziel ist erreichbar.degraded: Mindestens ein Ziel hat eine Verbindung akzeptiert, aber keine vollständigen Detail-RPC-Diagnosen abgeschlossen.capability: beste Fähigkeit über erreichbare Ziele hinweg (read_only,write_capable,admin_capable,pairing_pending,connected_no_operator_scopeoderunknown).primaryTargetId: bestes Ziel, das in dieser Reihenfolge als aktiver Gewinner behandelt werden soll: explizite URL, SSH-Tunnel, konfigurierte Remote-Verbindung, dann local loopback.warnings[]: Best-Effort-Warndatensätze mitcode,messageund optionalentargetIds.network: local loopback-/tailnet-URL-Hinweise, abgeleitet aus aktueller Config und Host-Netzwerk.discovery.timeoutMsunddiscovery.count: das tatsächliche Discovery-Budget bzw. die Ergebnisanzahl, die für diesen Prüf-Durchlauf verwendet wurden.
Pro Ziel (targets[].connect):
ok: Erreichbarkeit nach Verbindung plus eingeschränkte Klassifizierung.rpcOk: vollständiger Detail-RPC-Erfolg.scopeLimited: Detail-RPC ist wegen fehlendem Operator-Scope fehlgeschlagen.
Pro Ziel (targets[].auth):
role: inhello-okgemeldete Auth-Rolle, wenn verfügbar.scopes: inhello-okgemeldete gewährte Scopes, wenn verfügbar.capability: die für dieses Ziel angezeigte Auth-Fähigkeitsklassifizierung.
Häufige Warncodes
ssh_tunnel_failed: Einrichtung des SSH-Tunnels fehlgeschlagen; der Befehl ist auf direkte Prüfungen zurückgefallen.multiple_gateways: unterschiedliche Gateway-Identitäten waren erreichbar, oder OpenClaw konnte nicht nachweisen, dass erreichbare Ziele derselbe Gateway sind. Ein SSH-Tunnel, eine Proxy-URL oder eine konfigurierte Remote-URL zum selben Gateway löst diese Warnung nicht aus.auth_secretref_unresolved: Ein konfigurierter Auth-SecretRef konnte für ein fehlgeschlagenes Ziel nicht aufgelöst werden.probe_scope_limited: WebSocket-Verbindung war erfolgreich, aber die Leseprüfung wurde durch fehlendesoperator.readeingeschränkt.
Remote über SSH (Parität zur Mac-App)
Der macOS-App-Modus „Remote over SSH“ verwendet eine lokale Portweiterleitung, sodass der Remote-Gateway (der möglicherweise nur an Loopback gebunden ist) unter ws://127.0.0.1:<port> erreichbar wird.
CLI-Äquivalent:
openclaw gateway probe --ssh user@gateway-hostOPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc3NoIDx0YXJnZXQ
" type="string">
user@host oder user@host:port (Port ist standardmäßig 22).
--ssh-autobooleanDen ersten erkannten Gateway-Host als SSH-Ziel aus dem aufgelösten Discovery-Endpunkt auswählen (local. plus die konfigurierte Wide-Area-Domain, falls vorhanden). Nur-TXT-Hinweise werden ignoriert.
Config (optional, als Standardwerte verwendet):
gateway.remote.sshTargetgateway.remote.sshIdentity
gateway call <method>
Low-Level-RPC-Helfer.
openclaw gateway call statusopenclaw gateway call logs.tail --params '{"sinceMs": 60000}'"--params"--url"--token"--password"--timeout--expect-finalbooleanHauptsächlich für Agent-artige RPCs, die Zwischenereignisse vor einem finalen Payload streamen.
--jsonbooleanMaschinenlesbare JSON-Ausgabe.
Gateway-Dienst verwalten
openclaw gateway installopenclaw gateway startopenclaw gateway stopopenclaw gateway restartopenclaw gateway uninstallMit einem Wrapper installieren
Verwenden Sie --wrapper, wenn der verwaltete Dienst über eine andere ausführbare Datei gestartet werden muss, zum Beispiel über einen
Secrets-Manager-Shim oder einen Run-as-Helfer. Der Wrapper erhält die normalen Gateway-Argumente und ist
dafür verantwortlich, schließlich openclaw oder Node mit diesen Argumenten per exec auszuführen.
cat > ~/.local/bin/openclaw-doppler <<'EOF'#!/usr/bin/env bashset -euo pipefailexec doppler run --project my-project --config production -- openclaw "$@"EOFchmod +x ~/.local/bin/openclaw-doppler openclaw gateway install --wrapper ~/.local/bin/openclaw-doppler --forceopenclaw gateway restartSie können den Wrapper auch über die Umgebung festlegen. gateway install prüft, ob der Pfad eine
ausführbare Datei ist, schreibt den Wrapper in die Dienst-ProgramArguments und speichert
OPENCLAW_WRAPPER in der Dienstumgebung für spätere erzwungene Neuinstallationen, Updates und Doctor-
Reparaturen.
OPENCLAW_WRAPPER="$HOME/.local/bin/openclaw-doppler" openclaw gateway install --forceopenclaw doctorUm einen gespeicherten Wrapper zu entfernen, leeren Sie OPENCLAW_WRAPPER während der Neuinstallation:
OPENCLAW_WRAPPER= openclaw gateway install --forceopenclaw gateway restartBefehlsoptionen
gateway status:--url,--token,--password,--timeout,--no-probe,--require-rpc,--deep,--jsongateway install:--port,--runtime <node|bun>,--token,--wrapper <path>,--force,--jsongateway restart:--safe,--skip-deferral,--force,--wait <duration>,--jsongateway uninstall|start:--jsongateway stop:--disable,--json
Lifecycle-Verhalten
- Verwenden Sie
gateway restart, um einen verwalteten Dienst neu zu starten. Verketten Siegateway stopundgateway startnicht als Ersatz für einen Neustart. - Unter macOS verwendet
gateway stopstandardmäßiglaunchctl bootout, wodurch der LaunchAgent aus der aktuellen Boot-Sitzung entfernt wird, ohne eine Deaktivierung dauerhaft zu speichern — die automatische KeepAlive-Wiederherstellung bleibt für künftige Abstürze aktiv, undgateway startaktiviert sauber wieder, ohne ein manuelleslaunchctl enable. Übergeben Sie--disable, um KeepAlive und RunAtLoad dauerhaft zu unterdrücken, damit der Gateway bis zum nächsten ausdrücklichengateway startnicht erneut startet; verwenden Sie dies, wenn ein manueller Stopp Neustarts des Systems überdauern soll. gateway restart --safebittet den laufenden Gateway, aktive Arbeit vorab zu prüfen und einen zusammengefassten Neustart zu planen, nachdem aktive Arbeit abgearbeitet ist. Der standardmäßige sichere Neustart wartet bis zum konfiguriertengateway.reload.deferralTimeoutMs(Standard: 5 Minuten) auf aktive Arbeit; wenn dieses Budget abläuft, wird der Neustart erzwungen. Setzen Siegateway.reload.deferralTimeoutMsauf0, um unbegrenzt sicher zu warten, ohne jemals zu erzwingen.--safekann nicht mit--forceoder--waitkombiniert werden.gateway restart --wait 30süberschreibt das konfigurierte Neustart-Drain-Budget für diesen Neustart. Bloße Zahlen sind Millisekunden; Einheiten wies,mundhwerden akzeptiert.--wait 0wartet unbegrenzt.gateway restart --safe --skip-deferralführt den OpenClaw-bewussten sicheren Neustart aus, umgeht aber die Aufschubprüfung, sodass der Gateway den Neustart sofort ausgibt, selbst wenn Blocker gemeldet werden. Operator-Notausstieg für Aufschübe durch festhängende Task-Ausführungen; erfordert--safe.gateway restart --forceüberspringt das Abarbeiten aktiver Arbeit und startet sofort neu. Verwenden Sie dies, wenn ein Operator die aufgelisteten Task-Blocker bereits geprüft hat und den Gateway jetzt wieder verfügbar haben möchte.- Lifecycle-Befehle akzeptieren
--jsonfür Skripting.
Auth und SecretRefs zur Installationszeit
- Wenn Token-Auth ein Token erfordert und
gateway.auth.tokenSecretRef-verwaltet ist, prüftgateway install, ob die SecretRef auflösbar ist, speichert das aufgelöste Token aber nicht in den Dienstumgebungsmetadaten. - Wenn Token-Auth ein Token erfordert und die konfigurierte Token-SecretRef nicht aufgelöst werden kann, schlägt die Installation fail-closed fehl, statt Fallback-Klartext zu speichern.
- Für Passwort-Auth bei
gateway runbevorzugen SieOPENCLAW_GATEWAY_PASSWORD,--password-fileoder ein SecretRef-gestütztesgateway.auth.passwordgegenüber inline--password. - Im abgeleiteten Auth-Modus lockert ein nur in der Shell gesetztes
OPENCLAW_GATEWAY_PASSWORDdie Token-Anforderungen für die Installation nicht; verwenden Sie dauerhafte Konfiguration (gateway.auth.passwordoder configenv), wenn Sie einen verwalteten Dienst installieren. - Wenn sowohl
gateway.auth.tokenals auchgateway.auth.passwordkonfiguriert sind undgateway.auth.modenicht gesetzt ist, wird die Installation blockiert, bis der Modus ausdrücklich gesetzt wird.
Gateways entdecken (Bonjour)
gateway discover sucht nach Gateway-Beacons (_openclaw-gw._tcp).
- Multicast-DNS-SD:
local. - Unicast-DNS-SD (Wide-Area Bonjour): Wählen Sie eine Domain (Beispiel:
openclaw.internal.) und richten Sie Split-DNS + einen DNS-Server ein; siehe Bonjour.
Nur Gateways mit aktivierter Bonjour-Erkennung (Standard) kündigen den Beacon an.
Wide-Area-Erkennungsdatensätze können diese TXT-Hinweise enthalten:
role(Hinweis auf die Gateway-Rolle)transport(Transporthinweis, z. B.gateway)gatewayPort(WebSocket-Port, normalerweise18789)sshPort(nur im vollständigen Erkennungsmodus; Clients setzen SSH-Ziele standardmäßig auf22, wenn er fehlt)tailnetDns(MagicDNS-Hostname, wenn verfügbar)gatewayTls/gatewayTlsSha256(TLS aktiviert + Zertifikatsfingerabdruck)cliPath(nur im vollständigen Erkennungsmodus)
gateway discover
openclaw gateway discover"--timeout--jsonbooleanMaschinenlesbare Ausgabe (deaktiviert auch Styling/Spinner).
Beispiele:
openclaw gateway discover --timeout 4000openclaw gateway discover --json | jq '.beacons[].wsUrl'