Debugging

Helper di debug per l'output in streaming, soprattutto quando un provider mescola il ragionamento al testo normale.

Override di debug del runtime

Usa /debug in chat per impostare override della configurazione solo runtime (memoria, non disco). /debug è disabilitato per impostazione predefinita; abilitalo con commands.debug: true. È utile quando devi attivare o disattivare impostazioni poco comuni senza modificare openclaw.json.

Esempi:

/debug show/debug set messages.responsePrefix="[openclaw]"/debug unset messages.responsePrefix/debug reset

/debug reset cancella tutti gli override e torna alla configurazione su disco.

Output di trace della sessione

Usa /trace quando vuoi vedere righe di trace/debug di proprietà del plugin in una sessione senza attivare la modalità verbose completa.

Esempi:

/trace/trace on/trace off

Usa /trace per diagnostica dei plugin, come i riepiloghi di debug di Active Memory. Continua a usare /verbose per il normale output verbose di stato/strumenti, e continua a usare /debug per gli override della configurazione solo runtime.

Trace del ciclo di vita dei Plugin

Usa OPENCLAW_PLUGIN_LIFECYCLE_TRACE=1 quando i comandi del ciclo di vita dei plugin sembrano lenti e ti serve una suddivisione integrata per fasi di metadati plugin, discovery, registro, mirror runtime, mutazione della configurazione e lavoro di refresh. Il trace è opt-in e scrive su stderr, quindi l'output JSON dei comandi resta analizzabile.

Esempio:

OPENCLAW_PLUGIN_LIFECYCLE_TRACE=1 openclaw plugins install tokenjuice --force

Output di esempio:

[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"

Usalo per indagare sul ciclo di vita dei plugin prima di ricorrere a un profiler CPU. Se il comando viene eseguito da un checkout sorgente, preferisci misurare il runtime compilato con node dist/entry.js ... dopo pnpm build; pnpm openclaw ... misura anche l'overhead del runner sorgente.

Avvio CLI e profiling dei comandi

Usa il benchmark di avvio incluso nel repository quando un comando sembra lento:

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-cpu

Per profiling una tantum tramite il normale runner sorgente, imposta OPENCLAW_RUN_NODE_CPU_PROF_DIR:

OPENCLAW_RUN_NODE_CPU_PROF_DIR=.artifacts/cli-cpu pnpm openclaw status

Il runner sorgente aggiunge i flag del profilo CPU di Node e scrive un .cpuprofile per il comando. Usalo prima di aggiungere strumentazione temporanea al codice dei comandi.

Per stalli di avvio che sembrano lavoro sincrono di filesystem o module-loader, aggiungi il flag di trace I/O sincrono di Node tramite il runner sorgente:

OPENCLAW_TRACE_SYNC_IO=1 pnpm openclaw gateway --force

pnpm gateway:watch lascia questo flag disabilitato per impostazione predefinita per il processo figlio Gateway osservato. Imposta OPENCLAW_TRACE_SYNC_IO=1 quando vuoi esplicitamente l'output di trace I/O sincrono di Node in modalità watch.

Modalità watch del Gateway

Per iterazioni rapide, esegui il gateway sotto il file watcher:

pnpm gateway:watch

Per impostazione predefinita, questo avvia o riavvia una sessione tmux chiamata openclaw-gateway-watch-main (o una variante specifica per profilo/porta come openclaw-gateway-watch-dev-19001) e si collega automaticamente dai terminali interattivi. Shell non interattive, CI e chiamate exec degli agenti restano scollegate e stampano invece istruzioni per collegarsi. Collegati manualmente quando serve:

tmux attach -t openclaw-gateway-watch-main

Il riquadro tmux esegue il watcher grezzo:

node scripts/watch-node.mjs gateway --force

Usa la modalità in primo piano quando tmux non è desiderato:

pnpm gateway:watch:raw# orOPENCLAW_GATEWAY_WATCH_TMUX=0 pnpm gateway:watch

Disabilita l'auto-attach mantenendo la gestione tmux:

OPENCLAW_GATEWAY_WATCH_ATTACH=0 pnpm gateway:watch

Esegui il profiling del tempo CPU del Gateway osservato durante il debug di hotspot di avvio/runtime:

pnpm gateway:watch --benchmark

Il wrapper watch consuma --benchmark prima di invocare il Gateway e scrive un .cpuprofile V8 per ogni uscita del processo figlio Gateway sotto .artifacts/gateway-watch-profiles/. Arresta o riavvia il gateway osservato per svuotare il profilo corrente, poi aprilo con Chrome DevTools o Speedscope:

npx speedscope .artifacts/gateway-watch-profiles/*.cpuprofile

Usa --benchmark-dir <path> quando vuoi i profili altrove. Usa --benchmark-no-force quando vuoi che il processo figlio oggetto del benchmark salti la pulizia predefinita della porta --force e fallisca rapidamente se la porta Gateway è già in uso. La modalità benchmark sopprime per impostazione predefinita lo spam di trace sync-I/O. Imposta OPENCLAW_TRACE_SYNC_IO=1 con --benchmark quando vuoi esplicitamente sia i profili CPU sia gli stack trace sync-I/O di Node. In modalità benchmark quei blocchi di trace vengono scritti in gateway-watch-output.log sotto la directory del benchmark e filtrati dal riquadro del terminale; i normali log del Gateway restano visibili.

Il wrapper tmux trasporta nel riquadro i comuni selettori runtime non segreti, come OPENCLAW_PROFILE, OPENCLAW_CONFIG_PATH, OPENCLAW_STATE_DIR, OPENCLAW_GATEWAY_PORT e OPENCLAW_SKIP_CHANNELS. Inserisci le credenziali del provider nel tuo profilo/config normale, oppure usa la modalità grezza in primo piano per segreti effimeri una tantum. Se il Gateway osservato esce durante l'avvio, il watcher esegue openclaw doctor --fix --non-interactive una volta e riavvia il processo figlio Gateway. Usa OPENCLAW_GATEWAY_WATCH_AUTO_DOCTOR=0 quando vuoi il fallimento di avvio originale senza il passaggio di riparazione solo dev. Il riquadro tmux gestito usa anche per impostazione predefinita log Gateway colorati per leggibilità; imposta FORCE_COLOR=0 quando avvii pnpm gateway:watch per disabilitare l'output ANSI.

Il watcher si riavvia su file rilevanti per la build sotto src/, file sorgente delle estensioni, metadati package.json e openclaw.plugin.json delle estensioni, tsconfig.json, package.json e tsdown.config.ts. Le modifiche ai metadati delle estensioni riavviano il gateway senza forzare una ricompilazione tsdown; le modifiche a sorgente e configurazione ricompilano comunque prima dist.

Aggiungi eventuali flag CLI del gateway dopo gateway:watch e verranno passati a ogni riavvio. Rieseguire lo stesso comando watch rigenera il riquadro tmux nominato, e il watcher grezzo mantiene comunque il proprio lock a watcher singolo, quindi i genitori watcher duplicati vengono sostituiti invece di accumularsi.

Profilo dev + Gateway dev (--dev)

Usa il profilo dev per isolare lo stato e avviare una configurazione sicura e usa e getta per il debug. Esistono due flag --dev:

• --dev globale (profilo): isola lo stato sotto ~/.openclaw-dev e imposta per impostazione predefinita la porta del gateway a 19001 (le porte derivate si spostano di conseguenza).
• gateway --dev: dice al Gateway di creare automaticamente una configurazione + workspace predefiniti quando mancanti (e saltare BOOTSTRAP.md).

Flusso consigliato (profilo dev + bootstrap dev):

pnpm gateway:devOPENCLAW_PROFILE=dev openclaw tui

Se non hai ancora un'installazione globale, esegui la CLI tramite pnpm openclaw ....

Cosa fa:

1. Isolamento del profilo (--dev globale)

   • OPENCLAW_PROFILE=dev
   • OPENCLAW_STATE_DIR=~/.openclaw-dev
   • OPENCLAW_CONFIG_PATH=~/.openclaw-dev/openclaw.json
   • OPENCLAW_GATEWAY_PORT=19001 (browser/canvas si spostano di conseguenza)

2. Bootstrap dev (gateway --dev)

   • Scrive una configurazione minima se mancante (gateway.mode=local, bind loopback).
   • Imposta agent.workspace sul workspace dev.
   • Imposta agent.skipBootstrap=true (nessun BOOTSTRAP.md).
   • Popola i file del workspace se mancanti: AGENTS.md, SOUL.md, TOOLS.md, IDENTITY.md, USER.md, HEARTBEAT.md.
   • Identità predefinita: C3-PO (droide di protocollo).
   • Salta i provider di canale in modalità dev (OPENCLAW_SKIP_CHANNELS=1).

Flusso di reset (nuovo avvio):

pnpm gateway:dev:reset

--reset cancella configurazione, credenziali, sessioni e il workspace dev (usando trash, non rm), poi ricrea la configurazione dev predefinita.

Logging dello stream grezzo (OpenClaw)

OpenClaw può registrare lo stream grezzo dell'assistente prima di qualunque filtro/formattazione. Questo è il modo migliore per vedere se il ragionamento arriva come delta di testo semplice (o come blocchi di thinking separati).

Abilitalo via CLI:

pnpm gateway:watch --raw-stream

Override opzionale del percorso:

pnpm gateway:watch --raw-stream --raw-stream-path ~/.openclaw/logs/raw-stream.jsonl

Variabili d'ambiente equivalenti:

OPENCLAW_RAW_STREAM=1OPENCLAW_RAW_STREAM_PATH=~/.openclaw/logs/raw-stream.jsonl

File predefinito:

~/.openclaw/logs/raw-stream.jsonl

Logging dei chunk OpenAI-compatible grezzi

Per catturare i chunk OpenAI-compat grezzi prima che vengano analizzati in blocchi, abilita il logger di trasporto:

OPENCLAW_RAW_STREAM=1

Percorso opzionale:

OPENCLAW_RAW_STREAM_PATH=~/.openclaw/logs/raw-openai-completions.jsonl

File predefinito:

~/.openclaw/logs/raw-openai-completions.jsonl

Note di sicurezza

• I log degli stream grezzi possono includere prompt completi, output degli strumenti e dati utente.
• Mantieni i log locali ed eliminali dopo il debug.
• Se condividi i log, rimuovi prima segreti e PII.

Debug in VSCode

Le source map sono necessarie per abilitare il debug negli IDE basati su VSCode perché molti dei file generati finiscono con nomi hashati come parte del processo di build. Le configurazioni launch.json incluse puntano al servizio Gateway, ma possono essere adattate rapidamente per altri scopi:

1. Ricompila ed esegui il debug del Gateway - Esegue il debug del servizio Gateway dopo aver creato una nuova build
2. Esegui il debug del Gateway - Esegue il debug del servizio Gateway di una build preesistente

Configurazione

La configurazione predefinita Ricompila ed esegui il debug del Gateway è completa, eliminerà automaticamente la cartella /dist e ricompilerà il progetto con il debug abilitato:

1. Apri il pannello Esegui e Debug dalla barra delle attività o premi Ctrl+Shift+D
2. Nell'IDE, assicurati che Ricompila ed esegui il debug del Gateway sia selezionato nel menu a discesa della configurazione, quindi premi il pulsante Avvia debug

In alternativa, se preferisci gestire manualmente i processi di build e debug:

1. Apri un terminale e abilita le source map:
   • Linux/macOS: export OUTPUT_SOURCE_MAPS=1
   • Windows (PowerShell): $env:OUTPUT_SOURCE_MAPS="1"
   • Windows (CMD): set OUTPUT_SOURCE_MAPS=1
2. Nello stesso terminale, ricompila il progetto: pnpm clean:dist && pnpm build
3. Nell'IDE, seleziona l'opzione Esegui il debug del Gateway nel menu a discesa della configurazione Esegui e Debug, quindi premi il pulsante Avvia debug

Ora puoi impostare breakpoint nei tuoi file sorgente TypeScript (directory src/) e il debugger mapperà correttamente i breakpoint al JavaScript compilato tramite source map. Potrai ispezionare variabili, avanzare nel codice ed esaminare gli stack di chiamata come previsto.

Note

• Se usi l'opzione "Ricompila ed esegui il debug del Gateway", ogni volta che il debugger viene avviato eliminerà completamente la cartella /dist ed eseguirà una build completa pnpm build con le source map abilitate prima di avviare il Gateway
• Se usi l'opzione "Esegui il debug del Gateway", le sessioni di debug possono essere avviate e fermate in qualsiasi momento senza influire sulla cartella /dist, ma devi usare un processo terminale separato sia per abilitare il debug sia per gestire il ciclo di build
• Modifica le impostazioni launch.json per args per eseguire il debug di altre sezioni del progetto
• Se devi usare la CLI OpenClaw compilata per altri task (ad esempio dashboard --no-open se la tua sessione di debug genera un nuovo token di autenticazione), puoi eseguirla in un altro terminale come node ./openclaw.mjs oppure creare un alias shell come alias openclaw-build="node $(pwd)/openclaw.mjs"

Correlati

• Risoluzione dei problemi
• FAQ