调试
本页介绍用于流式输出的调试辅助工具,特别是当提供商将推理混入正常文本时。
运行时调试覆盖
Section titled “运行时调试覆盖”在聊天中使用 /debug 设置仅运行时配置覆盖(内存中,不写入磁盘)。
/debug 默认禁用;通过 commands.debug: true 启用。
当你需要切换不常用的设置而不编辑 coderclaw.json 时,这非常方便。
示例:
/debug show/debug set messages.responsePrefix="[coderclaw]"/debug unset messages.responsePrefix/debug reset/debug reset 清除所有覆盖并返回到磁盘上的配置。
Gateway 网关监视模式
Section titled “Gateway 网关监视模式”为了快速迭代,在文件监视器下运行 Gateway 网关:
pnpm gateway:watch --force这映射到:
tsx watch src/entry.ts gateway --force在 gateway:watch 后添加任何 Gateway 网关 CLI 标志,它们将在每次重启时传递。
Dev 配置文件 + dev Gateway 网关(—dev)
Section titled “Dev 配置文件 + dev Gateway 网关(—dev)”使用 dev 配置文件来隔离状态,并启动一个安全、可丢弃的调试设置。有两个 --dev 标志:
- 全局
--dev(配置文件): 将状态隔离到~/.coderclaw-dev下,并将 Gateway 网关端口默认为19001(派生端口随之移动)。 gateway --dev:告诉 Gateway 网关在缺失时自动创建默认配置 + 工作区(并跳过 BOOTSTRAP.md)。
推荐流程(dev 配置文件 + dev 引导):
pnpm gateway:devCODERCLAW_PROFILE=dev coderclaw tui如果你还没有全局安装,请通过 pnpm coderclaw ... 运行 CLI。
这会执行:
-
配置文件隔离(全局
--dev)CODERCLAW_PROFILE=devCODERCLAW_STATE_DIR=~/.coderclaw-devCODERCLAW_CONFIG_PATH=~/.coderclaw-dev/coderclaw.jsonCODERCLAW_GATEWAY_PORT=19001(浏览器/画布相应移动)
-
Dev 引导(
gateway --dev)- 如果缺失则写入最小配置(
gateway.mode=local,绑定 loopback)。 - 将
agent.workspace设置为 dev 工作区。 - 设置
agent.skipBootstrap=true(无 BOOTSTRAP.md)。 - 如果缺失则填充工作区文件:
AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md。 - 默认身份:C3‑PO(礼仪机器人)。
- 在 dev 模式下跳过渠道提供商(
CODERCLAW_SKIP_CHANNELS=1)。
- 如果缺失则写入最小配置(
重置流程(全新开始):
pnpm gateway:dev:reset注意:--dev 是全局配置文件标志,会被某些运行器吞掉。
如果你需要明确拼写,请使用环境变量形式:
CODERCLAW_PROFILE=dev coderclaw gateway --dev --reset--reset 清除配置、凭证、会话和 dev 工作区(使用 trash,而非 rm),然后重新创建默认的 dev 设置。
提示:如果非 dev Gateway 网关已在运行(launchd/systemd),请先停止它:
coderclaw gateway stop原始流日志(CoderClaw)
Section titled “原始流日志(CoderClaw)”CoderClaw 可以在任何过滤/格式化之前记录原始助手流。 这是查看推理是否作为纯文本增量到达(或作为单独的思考块)的最佳方式。
通过 CLI 启用:
pnpm gateway:watch --force --raw-stream可选路径覆盖:
pnpm gateway:watch --force --raw-stream --raw-stream-path ~/.coderclaw/logs/raw-stream.jsonl等效环境变量:
CODERCLAW_RAW_STREAM=1CODERCLAW_RAW_STREAM_PATH=~/.coderclaw/logs/raw-stream.jsonl默认文件:
~/.coderclaw/logs/raw-stream.jsonl
原始块日志(pi-mono)
Section titled “原始块日志(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提供商的进程发出。
安全注意事项
Section titled “安全注意事项”- 原始流日志可能包含完整提示、工具输出和用户数据。
- 保持日志在本地并在调试后删除它们。
- 如果你分享日志,请先清除密钥和个人身份信息。