CLI commands
Gateway
Der Gateway ist der WebSocket-Server von OpenClaw (Kanäle, Nodes, Sitzungen, Hooks). Alle nachfolgenden Unterbefehle befinden sich unter openclaw gateway ....
Einrichtung von lokalem mDNS und Wide-Area-DNS-SD.
Wie OpenClaw Gateways ankündigt und findet.
Gateway-Konfigurationsschlüssel auf oberster Ebene.
Gateway ausführen
openclaw gatewayopenclaw gateway run # äquivalente, explizite FormStartverhalten
- Der Start wird verweigert, sofern
gateway.mode=localnicht in~/.openclaw/openclaw.jsonfestgelegt ist. Verwenden Sie--allow-unconfiguredfür Ad-hoc-/Entwicklungsläufe; damit wird die Prüfung umgangen, ohne die Konfiguration zu schreiben oder zu reparieren. - Wenn beim Start eine reparierbare ungültige Konfiguration gefunden wird, bietet ein interaktives Terminal an,
openclaw doctor --fixauszuführen, und versucht den Start nach Zustimmung einmal erneut. Nicht interaktive Läufe reparieren niemals automatisch; stattdessen geben sie den Befehl aus. Ist die reparierte Konfiguration weiterhin ungültig, bleibt der Startvorgang angehalten. openclaw onboard --mode localundopenclaw setupschreibengateway.mode=local. Wenn die Konfigurationsdatei vorhanden ist, abergateway.modefehlt, wird dies als beschädigte/überschriebene Konfiguration behandelt, und der Gateway weigert sich,localfür Sie zu erraten — führen Sie das Onboarding erneut aus, legen Sie den Schlüssel manuell fest oder übergeben Sie--allow-unconfigured.- Eine Bindung über die Loopback-Schnittstelle hinaus wird ohne Authentifizierung blockiert.
- Die
--bind-Wertelan,tailnetundcustomwerden derzeit ausschließlich über IPv4-Pfade aufgelöst; reine IPv6-Setups mit eigenem Host benötigen einen IPv4-Sidecar oder -Proxy vor dem Gateway. SIGUSR1löst bei entsprechender Autorisierung einen prozessinternen Neustart aus.commands.restart(Standard: aktiviert) steuert extern gesendeteSIGUSR1; setzen Sie den Wert auffalse, um manuelle Neustarts durch Betriebssystemsignale zu blockieren. Das agentenseitige Werkzeuggatewayist schreibgeschützt; Agenten fordern einen Neustart über das von Menschen genehmigte Delegationswerkzeugopenclawan.SIGINT/SIGTERMbeenden den Prozess, stellen jedoch keinen benutzerdefinierten Terminalzustand wieder her — wenn Sie die CLI in eine TUI oder eine Eingabe im Raw-Modus einbetten, stellen Sie das Terminal vor dem Beenden selbst wieder her.
Optionen
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA
" type="number">
WebSocket-Port (Standard aus Konfiguration/Umgebung; üblicherweise 18789).
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tYmluZCA8bW9kZQ
" type="string">
Bindungsmodus: loopback (Standard), lan, tailnet, auto, custom.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdG9rZW4gPHRva2Vu
" type="string">
Gemeinsames Token für connect.params.auth.token. Verwendet standardmäßig OPENCLAW_GATEWAY_TOKEN, sofern festgelegt.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tYXV0aCA8bW9kZQ
" type="string">
Authentifizierungsmodus: none, token, password, trusted-proxy.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcGFzc3dvcmQgPHBhc3N3b3Jk
" type="string">
Passwort für --auth password.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdGFpbHNjYWxlIDxtb2Rl
" type="string">
Tailscale-Freigabe: off, serve, funnel.
--tailscale-reset-on-exitbooleanTailscale-Serve-/Funnel-Konfiguration beim Herunterfahren zurücksetzen.
--allow-unconfiguredbooleanStarten, ohne gateway.mode=local zu erzwingen. Nur für Ad-hoc-/Entwicklungs-Bootstrapping; die Konfiguration wird weder dauerhaft gespeichert noch repariert.
--devbooleanBei Bedarf eine Entwicklungskonfiguration und einen Arbeitsbereich erstellen (überspringt BOOTSTRAP.md).
--dev-ambient-channelsbooleanEinem Entwicklungs-Gateway erlauben, Kanäle automatisch anhand vorhandener Umgebungsvariablen zu konfigurieren. Erfordert --dev.
--resetbooleanEntwicklungskonfiguration, Anmeldedaten, Sitzungen und Arbeitsbereich zurücksetzen. Erfordert --dev.
--forcebooleanVor dem Start alle vorhandenen Listener am Zielport beenden. In einer nicht interaktiven Shell wird das Beenden eines verifizierten Gateway-Listeners verweigert; verwenden Sie stattdessen --dev oder ein isoliertes --profile mit einem freien Port.
--verbosebooleanAusführliche Protokollierung an stdout/stderr.
--cli-backend-logsbooleanNur CLI-Backend-Protokolle in der Konsole anzeigen (aktiviert ebenfalls stdout/stderr).
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0td3MtbG9nIDxzdHlsZQ
" type="string" default="auto">
WebSocket-Protokollstil: auto, full, compact.
--compactbooleanAlias für --ws-log compact.
--raw-streambooleanUnverarbeitete Modellstream-Ereignisse in JSONL protokollieren.
--claude-cli-logs ist ein veralteter Alias für --cli-backend-logs.
Legen Sie für --bind custom gateway.customBindHost auf eine IPv4-Adresse fest. Jede andere Adresse als 127.0.0.1 oder 0.0.0.0 erfordert außerdem 127.0.0.1 am selben Port für Clients auf demselben Host; der Start schlägt fehl, wenn einer der Listener keine Bindung herstellen kann. Der Platzhalter 0.0.0.0 fügt keinen separaten erforderlichen Alias hinzu. Reine IPv6-Setups mit eigenem Host benötigen einen IPv4-Sidecar oder -Proxy vor dem Gateway.
Gateway neu starten
openclaw gateway restartopenclaw gateway restart --safeopenclaw gateway restart --safe --skip-deferralopenclaw gateway restart --forceopenclaw gateway restart --wait 30s--safe fordert den laufenden Gateway auf, aktive Arbeiten vorab zu prüfen und einen zusammengefassten Neustart zu planen, nachdem diese Arbeiten abgeschlossen sind. Die Wartezeit ist auf 5 Minuten begrenzt; nach Ablauf des Zeitbudgets wird der Neustart erzwungen. --safe kann nicht mit --force oder --wait kombiniert werden.
--skip-deferral umgeht bei einem sicheren Neustart die Zurückstellungsprüfung für aktive Arbeiten, sodass der Gateway trotz gemeldeter Blockaden sofort neu startet. Dies erfordert --safe — verwenden Sie diese Option, wenn eine Zurückstellung wegen einer außer Kontrolle geratenen Aufgabe festhängt.
--wait <duration> überschreibt das Zeitbudget für das Leeren bei einem einfachen (nicht sicheren) Neustart. Akzeptiert Millisekunden ohne Einheit oder die Einheitensuffixe ms, s, m, h, d (z. B. 30s, 5m, 1h30m); --wait 0 wartet unbegrenzt. Nicht mit --force oder --safe kompatibel.
--force überspringt das Leeren aktiver Arbeiten und startet sofort neu. Ein einfaches restart (ohne Flags) behält das bestehende Neustartverhalten des Dienstmanagers bei.
Externe Supervisoren
Legen Sie OPENCLAW_SUPERVISOR_MODE=external nur fest, wenn ein anderer Prozessmanager den Lebenszyklus des Gateways verwaltet. In diesem Modus gilt:
openclaw gateway restartbehält das bestehende sichere, erzwungene und zeitlich begrenzte Warteverhalten bei, richtet sich jedoch an den verifizierten laufenden Gateway statt an launchd, systemd oder Task Scheduler.- Native Vorgänge zum Installieren, Starten, Stoppen und Deinstallieren des Dienstes werden mit einem Hinweis auf die Verwendung des externen Supervisors verweigert.
- Die Selbstaktualisierung von OpenClaw wird verweigert, damit der Supervisor den Gateway stoppen, die Laufzeitumgebung ersetzen und fertigstellen sowie sie sicher neu starten kann.
- Bei einem Neustart mit einem neuen Prozess wird vor dem ordnungsgemäßen Beenden eine zeitlich begrenzte SQLite-Übergabe geschrieben. Schlägt die Persistierung fehl, führt der Gateway stattdessen einen prozessinternen Neustart durch, anstatt ohne nutzbare Übergabe zu beenden.
OPENCLAW_SERVICE_REPAIR_POLICY=external bleibt eine separate Reparaturrichtlinie des Doctors. Sie legt nicht die Laufzeitzuständigkeit fest; Supervisoren, die beide Verhaltensweisen benötigen, sollten beide Variablen festlegen.
Externe Supervisoren können Neustartübergaben über den verborgenen Maschinenvertrag aushandeln und verarbeiten:
openclaw gateway restart-handoff capabilities --jsonopenclaw gateway restart-handoff consume --expected-pid <pid> --jsonProtokollversion 1 unterstützt den Vorgang consume. Bei der Verarbeitung werden die erwartete PID und die begrenzten Übergabefelder innerhalb einer einzigen sofortigen SQLite-Transaktion validiert. Eine akzeptierte Übergabe wird gelöscht, bevor der Erfolg zurückgegeben wird, sodass parallele oder wiederholte Consumer sie nicht beide akzeptieren können. Eine nicht übereinstimmende PID bleibt für den passenden Besitzer erhalten; fehlende, abgelaufene und ungültige Zeilen autorisieren keinen Neustart.
Gültige Maschinenanfragen geben JSON mit Exit-Code 0 zurück, einschließlich Ergebnissen ohne Neustart. Ungültige Argumente geben reason: "invalid-expected-pid" mit Exit-Code 2 zurück; Fehler des Zustandsspeichers geben reason: "store-unavailable" mit Exit-Code 1 zurück. Supervisoren sollten capabilities mit exakt der Laufzeitumgebung oder dem Launcher prüfen, die bzw. den sie verwenden werden, statt die Unterstützung aus einer OpenClaw-Versionszeichenfolge abzuleiten oder das private SQLite-Schema direkt zu lesen.
Gateway-Profiling
OPENCLAW_GATEWAY_STARTUP_TRACE=1protokolliert während des Starts die Zeitmessungen der Phasen, einschließlich dereventLoopMax-Verzögerung pro Phase und der Zeitmessungen für Plugin-Nachschlagetabellen (installierter Index, Manifestregistrierung, Startplanung, Arbeit an der Besitzerzuordnung).OPENCLAW_GATEWAY_RESTART_TRACE=1protokolliert auf den Neustart beschränkterestart trace:-Zeilen: Signalverarbeitung, Leeren aktiver Arbeiten, Herunterfahrphasen, nächster Start, Bereitschaftszeit und Speicherkennzahlen.OPENCLAW_DIAGNOSTICS=timelinemitOPENCLAW_DIAGNOSTICS_TIMELINE_PATH=<path>schreibt nach bestem Bemühen eine JSONL-Zeitleiste der Startdiagnose für externe QA-Testumgebungen (entspricht der Konfigurationdiagnostics.flags: ["timeline"]; der Pfad kann weiterhin nur über die Umgebung festgelegt werden). Fügen SieOPENCLAW_DIAGNOSTICS_EVENT_LOOP=1hinzu, um Ereignisschleifen-Stichproben einzubeziehen.pnpm buildund anschließendpnpm test:startup:gateway -- --runs 5 --warmup 1misst den Gateway-Start anhand des erstellten CLI-Einstiegspunkts: erste Prozessausgabe,/healthz,/readyz, Zeitmessungen der Startablaufverfolgung, Ereignisschleifenverzögerung und Zeitmessung der Plugin-Nachschlagetabelle.pnpm buildund anschließendpnpm test:restart:gateway -- --case skipChannels --runs 1 --restarts 5misst den prozessinternen Neustart unter macOS oder Linux (unter Windows nicht unterstützt; der Neustart erfordertSIGUSR1). VerwendetSIGUSR1, aktiviert beide Ablaufverfolgungen im untergeordneten Prozess und zeichnet den nächsten/healthz, den nächsten/readyz, die Ausfallzeit, die Bereitschaftszeit, CPU, RSS und Metriken der Neustartablaufverfolgung auf./healthzbezeichnet die Erreichbarkeit;/readyzbezeichnet die nutzbare Bereitschaft. Behandeln Sie Ablaufverfolgungszeilen und Benchmark-Ausgaben als Signal für die Zuordnung zum Verantwortlichen, nicht als vollständige Leistungsbewertung anhand einer einzelnen Zeitspanne oder Stichprobe.
Laufenden Gateway abfragen
Alle Abfragebefehle verwenden WebSocket-RPC.
Ausgabemodi
- Standard: menschenlesbar (im TTY farbig).
--json: maschinenlesbares JSON (ohne Gestaltung/Aktivitätsanzeige).--no-color(oderNO_COLOR=1): ANSI deaktivieren und das menschenlesbare Layout beibehalten.
Gemeinsame Optionen
--url <url>: WebSocket-URL des Gateways.--token <token>: Gateway-Token.--password <password>: Gateway-Passwort.--timeout <ms>: Zeitüberschreitung/Zeitbudget (der Standard variiert je nach Befehl; siehe die einzelnen Befehle unten).--expect-final: auf eine „endgültige“ Antwort warten (Agentenaufrufe).
gateway health
openclaw gateway health --url ws://127.0.0.1:18789openclaw gateway health --port 18789/healthz ist eine Liveness-Probe: Sie kehrt zurück, sobald der Server HTTP-Anfragen beantworten kann. /readyz ist strenger und bleibt rot, solange beim Start Plugin-Sidecars, Kanäle oder konfigurierte Hooks noch nicht vollständig bereit sind. Lokale oder authentifizierte ausführliche /readyz-Antworten enthalten einen eventLoop-Diagnoseblock (Verzögerung, Auslastung, CPU-Kern-Verhältnis, degraded-Flag).
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA
" type="number">
Verwendet ein lokales Loopback-Gateway an diesem Port als Ziel. Überschreibt für diesen Aufruf OPENCLAW_GATEWAY_URL und OPENCLAW_GATEWAY_PORT.
gateway usage-cost
Ruft Zusammenfassungen der Nutzungskosten aus Sitzungsprotokollen ab.
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-agentsbooleanAggregiert über alle konfigurierten Agenten hinweg. Kann nicht mit --agent kombiniert werden.
gateway stability
Ruft den aktuellen Diagnose-Stabilitätsrekorder von einem laufenden Gateway ab.
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 einzubeziehender aktueller Ereignisse (maximal 1000).
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdHlwZSA8dHlwZQ
" type="string">
Filtert nach Diagnoseereignistyp, z. B. payload.large oder diagnostic.memory.pressure.
"--since-seq--bundle [path]stringLiest ein persistiertes Stabilitätspaket, statt das laufende Gateway aufzurufen. --bundle latest (oder nur --bundle) wählt das neueste Paket im Zustandsverzeichnis aus; alternativ können Sie direkt einen JSON-Pfad zu einem Paket übergeben.
--exportbooleanSchreibt eine teilbare ZIP-Datei mit Supportdiagnosen, statt Stabilitätsdetails auszugeben.
OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tb3V0cHV0IDxwYXRo
" type="string">
Ausgabepfad für --export.
Datenschutz und Paketverhalten
- Datensätze enthalten betriebliche Metadaten: Ereignisnamen, Zähler, Bytegrößen, Speicherwerte, Warteschlangen-/Sitzungsstatus, Genehmigungs-IDs, Kanal-/Plugin-Namen und redigierte Sitzungszusammenfassungen. Sie schließen Chattext, Webhook-Inhalte, Tool-Ausgaben, unverarbeitete Anfrage-/Antwortinhalte, Tokens, Cookies, geheime Werte, Hostnamen und unverarbeitete Sitzungs-IDs aus. Setzen Sie
diagnostics.enabled: false, um den Rekorder vollständig zu deaktivieren. - Bei schwerwiegenden Gateway-Abbrüchen, Zeitüberschreitungen beim Herunterfahren und Startfehlern nach einem Neustart wird derselbe Diagnoseschnappschuss nach
~/.openclaw/logs/stability/openclaw-stability-*.jsongeschrieben, sofern der Rekorder Ereignisse enthält. Prüfen Sie das neueste Paket mitopenclaw gateway stability --bundle latest;--limit,--typeund--since-seqgelten auch für die Paketausgabe.
gateway diagnostics export
Schreibt eine lokale Diagnose-ZIP-Datei für Fehlerberichte. Informationen zum Datenschutzmodell und Paketinhalt 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-bundlebooleanÜberspringt die Suche nach einem persistierten Stabilitätspaket.
--jsonbooleanGibt den geschriebenen Pfad, die Größe und das Manifest als JSON aus.
Der Export bündelt: manifest.json (Dateiinventar), summary.md (Markdown-Zusammenfassung), diagnostics.json (übergeordnete Zusammenfassung von Konfiguration/Protokollen/Erkennung/Stabilität/Status/Zustand), config/sanitized.json, status/gateway-status.json, health/gateway-health.json, logs/openclaw-sanitized.jsonl und stability/latest.json, sofern ein Paket vorhanden ist.
Er ist für die Weitergabe vorgesehen. Er behält betriebliche Details bei, die für die Fehlerdiagnose nützlich sind – sichere Protokollfelder, Subsystemnamen, Statuscodes, Zeitdauern, konfigurierte Modi, Ports, Plugin-/Provider-IDs, nicht geheime Funktionseinstellungen und redigierte betriebliche Protokollmeldungen – und lässt Chattext, Webhook-Inhalte, Tool-Ausgaben, Anmeldedaten, Cookies, Konto-/Nachrichtenkennungen, Prompt-/Anweisungstext, Hostnamen und geheime Werte weg oder redigiert sie. Wenn eine Protokollmeldung wie Text aus einer Benutzer-, Chat- oder Tool-Nutzlast aussieht (z. B. „Benutzer sagte“, „Chattext“, „Tool-Ausgabe“, „Webhook-Inhalt“), enthält der Export nur den Hinweis, dass eine Nachricht ausgelassen wurde, sowie ihre Byteanzahl.
gateway status
Zeigt den Gateway-Dienst (launchd/systemd/schtasks) sowie optional eine Verbindungs-/Authentifizierungsprobe an.
openclaw gateway statusopenclaw gateway status --jsonopenclaw gateway status --require-rpc"--url"--token"--password"--timeout--no-probebooleanÜberspringt die Verbindungsprobe (reine Dienstansicht).
--deepbooleanDurchsucht auch Dienste auf Systemebene.
--require-rpcbooleanErweitert die Verbindungsprobe zu einer Leseprobe und beendet den Prozess bei einem Fehlschlag mit einem von null verschiedenen Statuscode. Kann nicht mit --no-probe kombiniert werden.
Statussemantik
- Bleibt für Diagnosen verfügbar, selbst wenn die lokale CLI-Konfiguration fehlt oder ungültig ist.
- Die Standardausgabe weist den Dienststatus, die WebSocket-Verbindung und die beim Handshake sichtbare Authentifizierungsfähigkeit nach – nicht Lese-, Schreib- oder Administratorvorgänge.
- Proben verändern bei der erstmaligen Geräteauthentifizierung nichts: Sie verwenden ein vorhandenes zwischengespeichertes Geräte-Token erneut, erstellen jedoch niemals nur zur Statusprüfung eine neue CLI-Geräteidentität oder einen schreibgeschützten Kopplungsdatensatz.
- Löst konfigurierte SecretRefs für die Probeauthentifizierung nach Möglichkeit auf. Wenn eine erforderliche SecretRef nicht aufgelöst ist, meldet
--jsonbei einem Fehlschlag der Probekonnektivität/-authentifizierungrpc.authWarning; übergeben Sie--token/--passwordexplizit oder korrigieren Sie die Quelle des Geheimnisses. Warnungen zu nicht aufgelöster Authentifizierung werden unterdrückt, sobald die Probe erfolgreich ist. - Die JSON-Ausgabe enthält
gateway.version, wenn das laufende Gateway dies meldet;--require-rpckann auf diestatus.runtimeVersion-RPC-Nutzlast zurückgreifen, wenn die Handshake-Probe keine Versionsmetadaten liefern kann. - Verwenden Sie
--require-rpcin Skripten/Automatisierungen, wenn ein lauschender Dienst nicht ausreicht und auch RPC mit Leseberechtigung fehlerfrei funktionieren muss. --deepsucht nach zusätzlichen launchd-/systemd-/schtasks-Installationen; wenn mehrere Gateway-ähnliche Dienste gefunden werden, gibt die menschenlesbare Ausgabe Bereinigungshinweise aus (üblicherweise sollte pro Rechner ein Gateway ausgeführt werden) und meldet gegebenenfalls eine kürzlich erfolgte Neustartübergabe durch den Supervisor.--deepführt außerdem die Konfigurationsvalidierung im Plugin-fähigen Modus (pluginValidation: "full") aus und zeigt Warnungen zum Plugin-Manifest an (z. B. fehlende Metadaten zur Kanalkonfiguration). Das standardmäßigegateway statusbehält den schnellen, schreibgeschützten Pfad bei, der die Plugin-Validierung überspringt.- Die menschenlesbare Ausgabe enthält den aufgelösten Dateipfad des Protokolls sowie die Konfigurationspfade und deren Gültigkeit für CLI und Dienst, um Abweichungen bei Profilen oder Zustandsverzeichnissen leichter zu diagnostizieren.
- Die menschenlesbare Ausgabe enthält
Gateway heap:mit dem angewendeten Grenzwert und seiner adaptiven Herleitung. Die JSON-Ausgabe stellt denselben Bericht alsservice.gatewayHeapbereit.
Prüfungen auf Authentifizierungsabweichungen unter Linux systemd
- Prüfungen auf Abweichungen bei der Dienstauthentifizierung lesen sowohl
Environment=als auchEnvironmentFile=aus der Unit (einschließlich%h, Pfaden in Anführungszeichen, mehreren Dateien und optionalen--Dateien). - Löst
gateway.auth.token-SecretRefs mithilfe der zusammengeführten Laufzeitumgebung auf (zuerst die Befehlsumgebung des Dienstes, dann ersatzweise die Prozessumgebung). - Prüfungen auf Token-Abweichungen überspringen die Auflösung des Konfigurations-Tokens, wenn die Token-Authentifizierung tatsächlich nicht aktiv ist (
gateway.auth.modeexplizitpassword/none/trusted-proxyoder kein Modus festgelegt ist, sodass das Passwort Vorrang haben kann und kein Token-Kandidat Vorrang erhalten kann).
gateway probe
Der Befehl zum „Debuggen von allem“. Er prüft immer:
- Ihr konfiguriertes entferntes Gateway (sofern festgelegt) und
- localhost (Loopback), selbst wenn ein entferntes Ziel konfiguriert ist.
Durch die Übergabe von --url wird dieses explizite Ziel vor den beiden anderen hinzugefügt. Die menschenlesbare Ausgabe kennzeichnet die Ziele als URL (explicit), Remote (configured) / Remote (configured, inactive) und Local loopback.
openclaw gateway probeopenclaw gateway probe --jsonopenclaw gateway probe --port 18789OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA
" type="number">
Verwendet diesen Port für das lokale Loopback-Probeziel und den entfernten Port des SSH-Tunnels. Ohne --url wird dadurch ausschließlich das lokale Loopback-Ziel ausgewählt statt der konfigurierten Gateway-Umgebungs-URL, des Umgebungsports oder entfernter Ziele.
Interpretation
Reachable: yesbedeutet, dass mindestens ein Ziel eine WebSocket-Verbindung akzeptiert hat.Capability: read-only|write-capable|admin-capable|pairing-pending|connect-onlymeldet unabhängig von der Erreichbarkeit, was die Probe hinsichtlich der Authentifizierung nachweisen konnte.Read probe: okbedeutet, dass auch detaillierte RPC-Aufrufe mit Leseberechtigung (health/status/system-presence/config.get) erfolgreich waren.Read probe: limited - missing scope: operator.readbedeutet, dass die Verbindung erfolgreich war, RPC mit Leseberechtigung jedoch eingeschränkt ist. Dies wird als beeinträchtigte Erreichbarkeit gemeldet, nicht als vollständiger Fehlschlag.Read probe: failednachConnect: okbedeutet, dass die WebSocket-Verbindung hergestellt wurde, nachfolgende Lesediagnosen jedoch eine Zeitüberschreitung erreichten oder fehlschlugen – ebenfalls beeinträchtigt, nicht unerreichbar.- Wie
gateway statusverwendet die Probe vorhandene zwischengespeicherte Geräteauthentifizierung erneut, erstellt jedoch keine erstmalige Geräteidentität oder keinen Kopplungsstatus. - Der Beendigungscode ist nur dann von null verschieden, wenn keines der geprüften Ziele erreichbar ist.
JSON-Ausgabe
Oberste Ebene:
ok: Mindestens ein Ziel ist erreichbar.degraded: Mindestens ein Ziel hat eine Verbindung angenommen, aber die vollständige detaillierte RPC-Diagnose nicht abgeschlossen.capability: Beste für erreichbare Ziele festgestellte Fähigkeit (read_only,write_capable,admin_capable,pairing_pending,connected_no_operator_scopeoderunknown).primaryTargetId: Bestes Ziel, das als aktiver Gewinner behandelt werden soll, in dieser Reihenfolge: explizite URL, SSH-Tunnel, konfigurierte Gegenstelle, lokale Loopback-Schnittstelle.warnings[]: Nach bestem Bemühen erstellte Warnungsdatensätze mitcode,messageund optionaltargetIds.network: Aus der aktuellen Konfiguration und dem Hostnetzwerk abgeleitete URL-Hinweise für lokale Loopback-Schnittstellen bzw. das Tailnet.discovery.timeoutMs/discovery.count: Das für diesen Prüfdurchlauf tatsächlich verwendete Ermittlungsbudget bzw. die tatsächliche Ergebnisanzahl.
Pro Ziel (targets[].connect): ok (Erreichbarkeit und Klassifizierung als eingeschränkt), rpcOk (vollständiger Erfolg des Detail-RPC), scopeLimited (Detail-RPC wegen fehlendem Operator-Berechtigungsumfang fehlgeschlagen).
Pro Ziel (targets[].auth): role und scopes werden, sofern verfügbar, in hello-ok gemeldet, zusammen mit der ausgegebenen Klassifizierung capability.
Häufige Warncodes
ssh_tunnel_failed: Die Einrichtung des SSH-Tunnels ist fehlgeschlagen; der Befehl ist auf direkte Prüfungen ausgewichen.multiple_gateways: Unterschiedliche Gateway-Identitäten waren erreichbar, oder OpenClaw konnte nicht nachweisen, dass die erreichbaren Ziele dasselbe Gateway sind. Ein SSH-Tunnel, eine Proxy-URL oder eine konfigurierte Remote-URL zu demselben Gateway löst dies nicht aus.auth_secretref_unresolved: Eine konfigurierte Authentifizierungs-SecretRef konnte für ein fehlgeschlagenes Ziel nicht aufgelöst werden.probe_scope_limited: Die WebSocket-Verbindung wurde erfolgreich hergestellt, aber die Leseprüfung war durch das fehlendeoperator.readeingeschränkt.local_tls_runtime_unavailable: TLS ist für das lokale Gateway aktiviert, aber OpenClaw konnte den Fingerabdruck des lokalen Zertifikats nicht laden.
Remotezugriff über SSH (Funktionsgleichheit mit der Mac-App)
Der Modus „Remote over SSH“ der macOS-App verwendet eine lokale Portweiterleitung, damit ein ausschließlich über die Loopback-Schnittstelle erreichbares Remote-Gateway unter ws://127.0.0.1:<port> erreichbar wird.
CLI-Entsprechung:
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-autobooleanWählt den ersten ermittelten Gateway-Host vom aufgelösten Ermittlungsendpunkt als SSH-Ziel aus (local. sowie, sofern vorhanden, die konfigurierte Weitbereichsdomäne). Reine TXT-Hinweise werden ignoriert.
Konfigurationsstandardwerte (optional): gateway.remote.sshTarget, gateway.remote.sshIdentity.
gateway call <method>
Niedrigstufiges RPC-Hilfsprogramm.
openclaw gateway call statusopenclaw gateway call logs.tail --params '{"limit": 200}'"--params"--url"--token"--password"--timeout--expect-finalbooleanHauptsächlich für agentenartige RPCs, die vor einer abschließenden Nutzlast Zwischenereignisse streamen.
--jsonbooleanMaschinenlesbare JSON-Ausgabe.
Gateway-Dienst verwalten
openclaw gateway installopenclaw gateway startopenclaw gateway stopopenclaw gateway restartopenclaw gateway uninstallInstallation mit einem Wrapper
Verwenden Sie --wrapper, wenn der verwaltete Dienst über eine andere ausführbare Datei gestartet werden muss, beispielsweise über einen Shim für eine Geheimnisverwaltung oder ein Hilfsprogramm zur Ausführung unter einem anderen Benutzer. Der Wrapper empfängt 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 ProgramArguments des Dienstes und speichert OPENCLAW_WRAPPER in der Dienstumgebung für spätere erzwungene Neuinstallationen, Aktualisierungen und Reparaturen durch Doctor.
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>(Standardwert:node),--token,--wrapper <path>,--force,--jsongateway restart:--safe,--skip-deferral,--force,--wait <duration>,--jsongateway uninstall|start:--jsongateway stop:--disable,--force,--json
Lebenszyklusverhalten
gateway startist idempotent: Wenn der verwaltete Dienst bereits ausgeführt wird, meldet der Befehl den laufenden Prozess und lässt ihn unverändert. Ein geladener, aber angehaltener Dienst wird wie zuvor gestartet.- Verwenden Sie
gateway restart, um einen verwalteten Dienst neu zu starten. Verketten Sie nichtgateway stopundgateway startals Ersatz für einen Neustart. - In einer nicht interaktiven Shell erfordert
gateway stopdie Option--force. Interaktive Terminals behalten das bestehende Verhalten ohne Eingabeaufforderung bei. Für Automatisierung und Tests sollten Siegateway run --devoder ein isoliertes--profilemit einem freien Port bevorzugen. - Unter macOS verwendet
gateway stopstandardmäßiglaunchctl bootout. Dadurch wird der LaunchAgent aus der aktuellen Startsitzung entfernt, ohne eine Deaktivierung dauerhaft zu speichern – die automatische KeepAlive-Wiederherstellung bleibt bei zukünftigen Abstürzen aktiv, undgateway startaktiviert den Dienst ohne ein manuelleslaunchctl enablewieder ordnungsgemäß. Übergeben Sie--disable, um KeepAlive und RunAtLoad dauerhaft zu unterdrücken, sodass das Gateway erst nach dem nächsten explizitengateway starterneut gestartet wird; verwenden Sie dies, wenn ein manuelles Anhalten Neustarts des Systems überdauern soll. - Mutationen am Gateway-Lebenszyklus hängen nach bestem Bemühen Schlüssel-Wert-Prüfdatensätze an
<state-dir>/logs/gateway-restart.logan, darunter CLI-Start-, Stopp- und Neustartvorgänge, Anforderungen für sichere Neustarts, Supervisor-Neustarts und entkoppelte Übergaben. - Lebenszyklusbefehle akzeptieren
--jsonfür Skripting.
Heap-Dimensionierung des verwalteten Gateways
gateway installschreibt für den verwalteten Gateway-Dienst einen ausschließlich den Heap betreffenden Wert fürNODE_OPTIONS. Wenn Node eine Container- oder Dienstbegrenzung meldet, werden 50 % des begrenzten Arbeitsspeichers angestrebt, andernfalls 50 % des physischen Arbeitsspeichers.- Der nominelle Zielbereich beträgt 2048–8192 MiB, mit einer zusätzlichen Obergrenze, die 75 % für nativen Speicher freihält. Auf kleinen Hosts kann diese Obergrenze dazu führen, dass das angewendete Limit unter dem nominellen Mindestwert von 2048 MiB liegt.
- Ein gültiges explizites
--max-old-space-size, das bereits im installierten Dienst gespeichert ist, bleibt bei erzwungenen Neuinstallationen und Reparaturen durch Doctor erhalten. AndereNODE_OPTIONS-Flags werden nicht in den verwalteten Dienst übernommen. - Das aus der Shell-Umgebung stammende
NODE_OPTIONSsetzt diese Richtlinie nicht außer Kraft. Verwenden Siegateway statusoderdoctor, um den installierten Wert zu prüfen; führen Sieopenclaw gateway install --forceaus, um ältere Dienstmetadaten neu zu erzeugen, die keine verwaltete Heap-Einstellung enthalten. - Die Richtlinie gilt nur für den verwalteten Gateway-Dienst. Im Vordergrund ausgeführte
gateway run, Node-Dienste und manuell erstellte Supervisor-Einheiten behalten ihre eigene Laufzeitkonfiguration bei.
Authentifizierung und SecretRefs zum Installationszeitpunkt
- Wenn die Token-Authentifizierung ein Token erfordert und
gateway.auth.tokenüber eine SecretRef verwaltet wird, prüftgateway install, ob die SecretRef aufgelöst werden kann, speichert das aufgelöste Token jedoch nicht in den Umgebungsmetadaten des Dienstes. - Wenn die Token-Authentifizierung ein Token erfordert und die konfigurierte Token-SecretRef nicht aufgelöst werden kann, schlägt die Installation sicher fehl, statt ersatzweise Klartext zu speichern.
- Bevorzugen Sie für die Passwortauthentifizierung auf
gateway runOPENCLAW_GATEWAY_PASSWORD,--password-fileoder ein durch SecretRef gestütztesgateway.auth.passwordgegenüber einem eingebetteten--password. - Im abgeleiteten Authentifizierungsmodus lockert das ausschließlich in der Shell gesetzte
OPENCLAW_GATEWAY_PASSWORDdie Token-Anforderungen der Installation nicht; verwenden Sie bei der Installation eines verwalteten Dienstes eine dauerhafte Konfiguration (gateway.auth.passwordoder die Konfigurationenv). - Wenn sowohl
gateway.auth.tokenals auchgateway.auth.passwordkonfiguriert sind undgateway.auth.modenicht festgelegt ist, wird die Installation blockiert, bis der Modus explizit festgelegt wurde.
Gateways ermitteln (Bonjour)
gateway discover sucht nach Gateway-Beacons (_openclaw-gw._tcp).
- Multicast-DNS-SD:
local. - Unicast-DNS-SD (Weitbereichs-Bonjour): Wählen Sie eine Domäne aus (Beispiel:
openclaw.internal.) und richten Sie Split-DNS sowie einen DNS-Server ein; siehe Bonjour.
Nur Gateways mit aktivierter Bonjour-Ermittlung (Standard) kündigen den Beacon an.
TXT-Hinweise in jedem Beacon: role (Hinweis zur Gateway-Rolle), transport (Transporthinweis, z. B. gateway), gatewayPort (WebSocket-Port, normalerweise 18789), tailnetDns (MagicDNS-Hostname, sofern verfügbar), gatewayTls / gatewayTlsSha256 (TLS aktiviert und Zertifikatfingerabdruck). sshPort und cliPath werden nur im vollständigen Ermittlungsmodus veröffentlicht (discovery.mdns.mode: "full"; Standard ist "minimal", wodurch sie ausgelassen werden – Clients verwenden dann standardmäßig Port 22 für SSH-Ziele).
gateway discover
openclaw gateway discover"--timeout--jsonbooleanMaschinenlesbare Ausgabe (deaktiviert außerdem Formatierung und Aktivitätsanzeige).
Beispiele:
openclaw gateway discover --timeout 4000openclaw gateway discover --json | jq '.beacons[].wsUrl'