调试
本节介绍用于调试流式输出的助手工具,特别是当提供商将推理内容混入普通文本时如何排查问题。
运行时调试覆盖
在聊天中使用 /debug 命令可以设置仅运行时的配置覆盖(存储在内存中,不写入磁盘)。/debug 默认禁用,需通过 commands.debug: true 启用。当你需要切换一些不常用的设置而不想编辑 openclaw.json 时,这非常方便。
示例:
/debug show
/debug set messages.responsePrefix="[openclaw]"
/debug unset messages.responsePrefix
/debug reset
/debug reset 会清除所有覆盖并恢复到磁盘上的配置。
网关监视模式
为了实现快速迭代,可以在文件监视器下运行网关:
pnpm gateway:watch
这实际上执行的是:
node --watch-path src --watch-path tsconfig.json --watch-path package.json --watch-preserve-output scripts/run-node.mjs gateway --force
在 gateway:watch 后添加任何网关 CLI 标志,它们会在每次重启时被传递进去。
开发配置文件 + 开发网关 (--dev)
使用开发配置文件可以隔离状态,并启动一个安全、可丢弃的调试环境。这里有两个 --dev 标志:
- 全局
--dev(配置文件):将状态隔离在~/.openclaw-dev下,并将网关端口默认设为19001(相关端口会随之偏移)。 gateway --dev:告诉网关在配置和工作区缺失时自动创建默认配置和工作区(并跳过 BOOTSTRAP.md)。
推荐流程(开发配置文件 + 开发引导):
pnpm gateway:dev
OPENCLAW_PROFILE=dev openclaw tui
如果还没有全局安装,可以通过 pnpm openclaw ... 运行。这会做以下事情:
-
配置文件隔离(全局
--dev)OPENCLAW_PROFILE=devOPENCLAW_STATE_DIR=~/.openclaw-devOPENCLAW_CONFIG_PATH=~/.openclaw-dev/openclaw.jsonOPENCLAW_GATEWAY_PORT=19001(浏览器/画布端口相应偏移)
-
开发引导(
gateway --dev)- 如果配置缺失,写入最小配置(
gateway.mode=local,绑定环回地址) - 将
agent.workspace设为开发工作区 - 设置
agent.skipBootstrap=true(不执行 BOOTSTRAP.md) - 如果缺失,初始化工作区文件:
AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md - 默认身份:C3‑PO(礼仪机器人)
- 开发模式下跳过频道提供商(
OPENCLAW_SKIP_CHANNELS=1)
- 如果配置缺失,写入最小配置(
重置流程(全新开始):
pnpm gateway:dev:reset
注意:--dev 是一个全局配置文件标志,会被某些运行器"吞掉"。如果需要明确指定,请使用环境变量形式:
OPENCLAW_PROFILE=dev openclaw gateway --dev --reset
--reset 会清除配置、凭据、会话和开发工作区(使用 trash 而非 rm),然后重新创建默认的开发设置。
提示:如果非开发网关已在运行(通过 launchd/systemd),请先停止它:
openclaw gateway stop
原始流日志记录 (OpenClaw)
OpenClaw 可以在任何过滤或格式化之前记录原始助手流。这是查看推理内容是以纯文本增量还是独立思考块形式到达的最佳方式。通过 CLI 启用:
pnpm gateway:watch --raw-stream
可选路径覆盖:
pnpm gateway:watch --raw-stream --raw-stream-path ~/.openclaw/logs/raw-stream.jsonl
等效的环境变量:
OPENCLAW_RAW_STREAM=1
OPENCLAW_RAW_STREAM_PATH=~/.openclaw/logs/raw-stream.jsonl
默认文件:~/.openclaw/logs/raw-stream.jsonl
原始块日志记录 (pi-mono)
为了在解析成块之前捕获原始的 OpenAI 兼容块,pi-mono 提供了单独的日志器:
PI_RAW_STREAM=1
可选路径:
PI_RAW_STREAM_PATH=~/.pi-mono/logs/raw-openai-completions.jsonl
默认文件:~/.pi-mono/logs/raw-openai-completions.jsonl
注意:这仅由使用 pi-mono 的
openai-completions提供商的进程发出。
安全须知
- 原始流日志可能包含完整的提示词、工具输出和用户数据。
- 请将日志保存在本地,调试后及时删除。
- 如需分享日志,请先清理其中的敏感信息和个人身份信息(PII)。