Start here
Fehlerbehebung
Debugging-Hilfen für Streaming-Ausgabe, Gateway-Iteration und Startprofilierung.
Laufzeit-Debug-Überschreibungen
/debug legt Konfigurationsüberschreibungen nur für die Laufzeit fest (im Arbeitsspeicher, nicht auf dem Datenträger). Standardmäßig deaktiviert; aktivieren Sie sie mit commands.debug: true.
/debug show/debug set channels.whatsapp.responsePrefix="[openclaw]"/debug unset channels.whatsapp.responsePrefix/debug reset/debug reset löscht alle Überschreibungen und kehrt zur Konfiguration auf dem Datenträger zurück.
Ausgabe der Sitzungsablaufverfolgung
/trace zeigt Plugin-eigene Ablaufverfolgungs-/Debug-Zeilen für eine Sitzung an, ohne den vollständigen ausführlichen Modus zu aktivieren. Verwenden Sie dies für Plugin-Diagnosen wie Active-Memory-Debug-Zusammenfassungen; verwenden Sie /verbose für normale Status-/Werkzeugausgaben.
/trace/trace on/trace offAblaufverfolgung des Plugin-Lebenszyklus
Setzen Sie OPENCLAW_PLUGIN_LIFECYCLE_TRACE=1, um eine phasenweise Aufschlüsselung der Arbeiten an Plugin-Metadaten, Erkennung, Registry, Laufzeitspiegelung, Konfigurationsänderung und Aktualisierung zu erhalten. Die Ausgabe erfolgt nach stderr, sodass die JSON-Befehlsausgabe weiterhin analysierbar bleibt.
Fehler beim Laden von Plugins enthalten ihren Stacktrace, solange diese Ablaufverfolgung aktiviert ist.
OPENCLAW_PLUGIN_LIFECYCLE_TRACE=1 openclaw plugins install tokenjuice --force[plugins:lifecycle] phase="config read" ms=6.83 status=ok command="install"[plugins:lifecycle] phase="slot selection" ms=94.31 status=ok command="install" pluginId="tokenjuice"[plugins:lifecycle] phase="registry refresh" ms=51.56 status=ok command="install" reason="source-changed"Verwenden Sie dies, bevor Sie zu einem CPU-Profiler greifen. Messen Sie aus einem Quellcode-Checkout die gebaute Laufzeit mit node dist/entry.js ... nach pnpm build; pnpm openclaw ... misst zusätzlich den Overhead des Quellcode-Runners.
Verwenden Sie für Zeitmessungen beim synchronen Laden von Modulen die gemeinsame Diagnoseoberfläche statt eines separaten, ausschließlich für Plugins vorgesehenen Umgebungsschalters:
OPENCLAW_DIAGNOSTICS=plugin.load-profile openclaw plugins listProfilierung des CLI-Starts und der Befehle
Eingecheckte Start-Benchmarks:
pnpm test:startup:bench:smokepnpm tsx scripts/bench-cli-startup.ts --preset real --case status --runs 3pnpm tsx scripts/bench-cli-startup.ts --preset real --cpu-prof-dir .artifacts/cli-cpuSetzen Sie für eine einmalige Profilierung über den normalen Quellcode-Runner OPENCLAW_RUN_NODE_CPU_PROF_DIR:
OPENCLAW_RUN_NODE_CPU_PROF_DIR=.artifacts/cli-cpu pnpm openclaw statusDer Quellcode-Runner fügt Node-CPU-Profil-Flags hinzu und schreibt für den Befehl eine .cpuprofile. Verwenden Sie dies, bevor Sie dem Befehlscode eine temporäre Instrumentierung hinzufügen.
Fügen Sie bei Startblockaden, die nach synchroner Dateisystem- oder Modulladerarbeit aussehen, das Node-Flag zur Ablaufverfolgung synchroner E/A über den Quellcode-Runner hinzu:
OPENCLAW_TRACE_SYNC_IO=1 pnpm openclaw gateway --forcepnpm gateway:watch lässt dieses Flag für den überwachten Gateway-Unterprozess standardmäßig deaktiviert; setzen Sie OPENCLAW_TRACE_SYNC_IO=1, wenn Sie die Ausgabe der synchronen E/A-Ablaufverfolgung auch im Überwachungsmodus wünschen.
Gateway-Überwachungsmodus
pnpm gateway:watchStandardmäßig startet oder startet dies eine tmux-Sitzung namens openclaw-gateway-watch-<profile> neu (zum Beispiel openclaw-gateway-watch-main), wobei ein Portsuffix wie openclaw-gateway-watch-dev-19001 nur hinzugefügt wird, wenn OPENCLAW_GATEWAY_PORT vom Standardport 18789 abweicht. Von interaktiven Terminals wird die Sitzung automatisch angehängt; nicht interaktive Shells, CI- und Agent-Ausführungsaufrufe bleiben getrennt und geben stattdessen Anweisungen zum Anhängen aus:
tmux attach -t openclaw-gateway-watch-main# Letzte Ausgabe ohne Anhängen lesentmux capture-pane -ep -t openclaw-gateway-watch-main -S -200Der Bereich verwendet tmux remain-on-exit, sodass Startfehler zum Anhängen oder Erfassen verfügbar bleiben, statt die Sitzung zu löschen. Eine erneute Ausführung von pnpm gateway:watch startet diesen Bereich neu.
Im tmux-Bereich wird der unverarbeitete Watcher ausgeführt:
node scripts/watch-node.mjs gateway --forceVor der Überwachung des konfigurierten/standardmäßigen Ports stoppt der tmux-Wrapper den installierten Gateway-Dienst des aktiven Profils. Dadurch wird der Port an den Quellcode-Watcher übergeben, ohne dass launchd, systemd oder eine geplante Aufgabe den Dienst neu startet und ersetzt. Der Dienst bleibt installiert; stellen Sie ihn nach der Überwachungssitzung wieder her mit:
pnpm openclaw gateway startWenn ein explizites --port oder OPENCLAW_GATEWAY_PORT vom effektiven Port des installierten Dienstes abweicht, lässt der Wrapper den Dienst weiterlaufen, sodass beide Gateways parallel ausgeführt werden können.
Vordergrundmodus ohne tmux:
pnpm gateway:watch:raw# oderOPENCLAW_GATEWAY_WATCH_TMUX=0 pnpm gateway:watchDer unverarbeitete Modus verwaltet den installierten Dienst nicht. Führen Sie zuerst pnpm openclaw gateway stop aus, wenn dieser denselben Port verwendet.
Behalten Sie die tmux-Verwaltung bei, deaktivieren Sie jedoch das automatische Anhängen:
OPENCLAW_GATEWAY_WATCH_ATTACH=0 pnpm gateway:watchProfilieren Sie die CPU-Zeit des überwachten Gateways, wenn Sie Engpässe beim Start oder zur Laufzeit debuggen:
pnpm gateway:watch --benchmarkDer Überwachungs-Wrapper verarbeitet --benchmark, bevor er das Gateway aufruft, und schreibt bei jedem Beenden eines Gateway-Unterprozesses ein V8-.cpuprofile unter .artifacts/gateway-watch-profiles/. Stoppen oder starten Sie das überwachte Gateway neu, um das aktuelle Profil zu schreiben, und öffnen Sie es anschließend mit Chrome DevTools oder Speedscope:
npx speedscope .artifacts/gateway-watch-profiles/*.cpuprofile--benchmark-dir <path>: Profile an einem anderen Ort schreiben.--benchmark-no-force: Die standardmäßige Portbereinigung für--forceüberspringen und sofort fehlschlagen, wenn der Gateway-Port bereits verwendet wird.
Der Benchmark-Modus unterdrückt standardmäßig Meldungen der synchronen E/A-Ablaufverfolgung. Setzen Sie OPENCLAW_TRACE_SYNC_IO=1 zusammen mit --benchmark, um sowohl CPU-Profile als auch Stacktraces synchroner E/A zu erhalten; im Benchmark-Modus werden diese Ablaufverfolgungsblöcke unter gateway-watch-output.log im Benchmark-Verzeichnis gespeichert (und aus dem Terminalbereich herausgefiltert), während normale Gateway-Protokolle sichtbar bleiben.
Der tmux-Wrapper übernimmt gängige, nicht geheime Laufzeitselektoren in den Bereich, darunter OPENCLAW_PROFILE, OPENCLAW_CONFIG_PATH, OPENCLAW_STATE_DIR, OPENCLAW_GATEWAY_PORT und OPENCLAW_SKIP_CHANNELS. Speichern Sie Provider-Anmeldedaten in Ihrem normalen Profil/Ihrer normalen Konfiguration oder verwenden Sie für einmalige flüchtige Geheimnisse den unverarbeiteten Vordergrundmodus.
Wenn das überwachte Gateway während des Starts beendet wird, führt der Watcher einmal openclaw doctor --fix --non-interactive aus und startet den Gateway-Unterprozess neu. Setzen Sie OPENCLAW_GATEWAY_WATCH_AUTO_DOCTOR=0, um den ursprünglichen Startfehler ohne den ausschließlich für die Entwicklung vorgesehenen Reparaturdurchlauf zu sehen.
Der verwaltete tmux-Bereich verwendet standardmäßig farbige Gateway-Protokolle; setzen Sie beim Starten von pnpm gateway:watch die Option FORCE_COLOR=0, um die ANSI-Ausgabe zu deaktivieren.
Der Watcher startet bei buildrelevanten Dateien unter src/, Quelldateien von Erweiterungen, den Metadaten package.json und openclaw.plugin.json von Erweiterungen, tsconfig.json, package.json und tsdown.config.ts neu. Änderungen an Erweiterungsmetadaten starten das Gateway neu, ohne einen Neubau zu erzwingen; bei Änderungen an Quellcode und Konfiguration wird weiterhin zuerst dist neu gebaut.
Fügen Sie Gateway-CLI-Flags nach gateway:watch hinzu; sie werden bei jedem Neustart weitergereicht. Eine erneute Ausführung desselben Überwachungsbefehls startet den benannten tmux-Bereich neu; der unverarbeitete Watcher verwendet eine Sperre für einen einzelnen Watcher, sodass doppelte Watcher-Elternprozesse ersetzt werden, statt sich anzusammeln.
Entwicklungsprofil + Entwicklungs-Gateway (--dev)
Zwei separate --dev-Flags:
- Globales
--dev(Profil): isoliert den Zustand unter~/.openclaw-devund setzt den Gateway-Port standardmäßig auf19001(abgeleitete Ports werden entsprechend verschoben). gateway --dev: weist das Gateway an, bei Bedarf automatisch eine Standardkonfiguration und einen Workspace zu erstellen (und den Bootstrap zu überspringen).
Empfohlener Ablauf (Entwicklungsprofil + Entwicklungs-Bootstrap):
pnpm gateway:devOPENCLAW_PROFILE=dev openclaw tuiFühren Sie die CLI ohne globale Installation über pnpm openclaw ... aus.
Auswirkungen:
-
Profilisolierung (globales
--dev)OPENCLAW_PROFILE=devOPENCLAW_STATE_DIR=~/.openclaw-devOPENCLAW_CONFIG_PATH=~/.openclaw-dev/openclaw.jsonOPENCLAW_GATEWAY_PORT=19001(Browser-/Canvas-Ports werden entsprechend verschoben)
-
Entwicklungs-Bootstrap (
gateway --dev)- Schreibt eine minimale Konfiguration, falls keine vorhanden ist (
gateway.mode=local, Bindung an Loopback). - Setzt
agents.defaults.workspaceauf den Entwicklungs-Workspace undagents.defaults.skipBootstrap=true. - Legt bei Bedarf die Workspace-Dateien an:
AGENTS.md,SOUL.md,TOOLS.md,IDENTITY.md,USER.md. - Standardidentität: C3-PO (Protokolldroide).
pnpm gateway:devsetzt außerdemOPENCLAW_SKIP_CHANNELS=1, um Kanal-Provider zu überspringen.
- Schreibt eine minimale Konfiguration, falls keine vorhanden ist (
Entwicklungs-Gateways ignorieren standardmäßig implizite Auslöser aus Kanal-Umgebungsvariablen, sodass von Ihrer Shell übernommene Anmeldedaten die Entwicklungsinstanz nicht mit echten Kanaldiensten verbinden. Eine explizite channels.<id>-Konfiguration funktioniert weiterhin. Übergeben Sie --dev-ambient-channels zusammen mit --dev, um für diese Ausführung die automatische Kanalkonfiguration aus Umgebungsvariablen wiederherzustellen.
Zurücksetzungsablauf (Neustart mit frischem Zustand):
pnpm gateway:dev:reset--reset löscht Konfiguration, Anmeldedaten, Sitzungen und den Entwicklungs-Workspace (in den Papierkorb verschoben, nicht gelöscht) und erstellt anschließend die standardmäßige Entwicklungsumgebung neu.
Protokollierung des unverarbeiteten Streams
OpenClaw kann den unverarbeiteten Assistenten-Stream vor jeglicher Filterung/Formatierung protokollieren. Dies ist die beste Möglichkeit, um festzustellen, ob Reasoning als Klartext-Deltas (oder als separate Denkblöcke) eintrifft.
Aktivieren Sie dies über die CLI:
pnpm gateway:watch --raw-streamOptionale Pfadüberschreibung:
pnpm gateway:watch --raw-stream --raw-stream-path ~/.openclaw/logs/raw-stream.jsonlEntsprechende Umgebungsvariablen:
OPENCLAW_RAW_STREAM=1OPENCLAW_RAW_STREAM_PATH=~/.openclaw/logs/raw-stream.jsonlStandarddatei: ~/.openclaw/logs/raw-stream.jsonl
Sicherheitshinweise
- Protokolle des unverarbeiteten Streams können vollständige Prompts, Werkzeugausgaben und Benutzerdaten enthalten.
- Bewahren Sie Protokolle lokal auf und löschen Sie sie nach dem Debugging.
- Wenn Sie Protokolle weitergeben, entfernen Sie zuerst Geheimnisse und personenbezogene Daten.
Debugging in VSCode
Source Maps sind erforderlich, da der Build generierte Dateinamen hasht. Die enthaltene launch.json ist auf den Gateway-Dienst ausgerichtet:
- Rebuild and Debug Gateway – löscht
/distund baut mit aktiviertem Debugging neu, bevor das Gateway gestartet wird. - Debug Gateway – debuggt einen vorhandenen Build, ohne
/distzu verändern.
Einrichtung
- Öffnen Sie Run and Debug (Aktivitätsleiste oder
Ctrl+Shift+D). - Wählen Sie Rebuild and Debug Gateway aus und drücken Sie Start Debugging.
So verwalten Sie stattdessen den Build-/Debug-Zyklus manuell:
- Aktivieren Sie Source Maps in einem Terminal:
- Linux/macOS:
export OUTPUT_SOURCE_MAPS=1 - Windows (PowerShell):
$env:OUTPUT_SOURCE_MAPS="1" - Windows (CMD):
set OUTPUT_SOURCE_MAPS=1
- Linux/macOS:
- Neu bauen:
pnpm clean:dist && pnpm build - Wählen Sie Debug Gateway aus und drücken Sie Start Debugging.
Setzen Sie Haltepunkte in den src/-TypeScript-Dateien; der Debugger ordnet sie über Source Maps dem kompilierten JavaScript zu.
Hinweise
- Rebuild and Debug Gateway löscht
/distund führt bei jedem Start einen vollständigenpnpm buildmit Source Maps aus. - Debug Gateway kann gestartet und gestoppt werden, ohne
/distzu beeinflussen; den Build-Zyklus verwalten Sie jedoch in einem separaten Terminal. - Bearbeiten Sie
launch.jsonargs, um andere CLI-Unterbefehle zu debuggen. - Um die gebaute CLI für andere Aufgaben zu verwenden (zum Beispiel
dashboard --no-open, wenn Ihre Debug-Sitzung ein neues Authentifizierungstoken erzeugt), führen Sie sie in einem anderen Terminal aus:node ./openclaw.mjsoder über einen Alias wiealias openclaw-build="node $(pwd)/openclaw.mjs".