简要总结
Debugging
这页说明书是给用 OpenClaw 的叔叔阿姨们看的,当他们的小助手说话有点奇怪,或者想看看小助手“脑子里”在想什么的时候,就可以来这里找工具。就像你想知道玩具火车为什么不动了,需要一些特殊的检查工具一样。这里会告诉你几种不同的“检查”方法。
五岁小孩版解释
这页纸教我们怎么用一些特别的工具,来“检查”和“调试” OpenClaw 小助手。当小助手说的话混在一起,或者你想看看它没说出来之前的想法时,这些工具就很有用啦。
1. 用聊天命令临时改设置
你可以在和小助手聊天时,输入 /debug 这个魔法词来临时改变一些设置,就像给玩具换上一节临时电池,关掉就恢复原样了。不过这个功能一开始是关着的,需要先在 openclaw.json 这个总设置文件里,把 commands.debug 改成 true 才能用。
- 输入
/debug show,可以看看现在有哪些临时设置。 - 输入
/debug set messages.responsePrefix="[openclaw]",可以给小助手说的话前面加上一个“[openclaw]”的小标签。 - 输入
/debug unset messages.responsePrefix,可以把刚才加的小标签去掉。 - 输入
/debug reset,可以把所有临时设置都清空,变回原来的样子。
2. 让“网关”自动刷新 “网关”就像小助手家的大门。有时候我们改了家里的布置(代码),希望大门能立刻知道。我们可以用一个“监视”模式来启动它。
- 要做什么:启动一个会自动刷新的网关。
- 怎么做:在终端里输入
pnpm gateway:watch这个命令。这样,当你改了src等文件夹里的文件后,网关会自动重启,不用你手动操作。 - 你还可以在这个命令后面加上其他给网关的指令,它们每次重启时都会用上。
3. 创建一个安全的“游乐场”来调试
如果你想在一个完全独立、不怕弄乱的地方试试新东西,可以用“开发模式”。这就像在家里单独划出一个“游戏角”,所有的玩具和规则都在这个角里,不会影响其他地方。这里有两个叫 --dev 的开关,作用不一样哦。
- 第一个开关(全局的):它会告诉系统:“请把所有的东西都放在
~/.openclaw-dev这个特别的文件夹里”。它还会把小助手“家门”(网关)的号码改成19001。 - 第二个开关(给网关的):它会告诉网关:“如果缺了配置文件,就自动创建一个最简单的;并且跳过那个长长的引导文件(BOOTSTRAP.md)”。 推荐你这样一起用它们,创建一个干净的调试环境:
- 先在一个终端窗口输入
pnpm gateway:dev,启动开发模式的网关。 - 再在另一个终端窗口输入
OPENCLAW_PROFILE=dev openclaw tui,启动开发模式的小助手界面。 如果还没安装好,可以用pnpm openclaw ...来运行命令。 这个“游乐场”会自动准备好一些基础文件,比如AGENTS.md,并且让小助手暂时假扮成 C-3PO(星球大战里的金色机器人)来陪你玩。 想彻底清空“游乐场”重新开始?就输入pnpm gateway:dev:reset。 要小心:如果你的电脑上已经有一个普通的小助手网关在运行了(比如它自己开机启动了),你需要先用openclaw gateway stop这个命令让它停下来,再启动开发模式的,不然它们会“撞门”。
4. 查看小助手的“原始想法流” 有时候,小助手会把它的“思考过程”和“要说的话”混在一起发出来。我们可以用一个工具,把这些最原始、还没整理过的信息都记录下来,存到一个文件里,这样就能看清楚啦。
- 要做什么:记录小助手最原始的想法流。
- 怎么做:启动网关时加上
--raw-stream这个标志,比如输入pnpm gateway:watch --raw-stream。 - 这些记录默认会保存在
~/.openclaw/logs/raw-stream.jsonl这个文件里。你也可以用--raw-stream-path指定别的保存位置。
5. 查看更底层的“数据块”
还有一个更厉害的工具,可以记录小助手和它的“大脑”(比如 OpenAI)之间传递的、最最原始的数据块。这需要另一个叫 pi-mono 的部件来帮忙。
- 要做什么:记录最原始的、像乐高块一样的数据。
- 怎么做:在运行命令前,先设置一个环境变量
PI_RAW_STREAM=1。 - 这些记录默认会保存在
~/.pi-mono/logs/raw-openai-completions.jsonl这个文件里。
重要的事情要记住!
- 上面第4和第5步生成的记录文件,里面可能包含你和小助手说的所有话、小助手用的工具结果,甚至你的个人信息。
- 这些文件一定要保存在你自己的电脑上,调试完就记得删除它们。
- 如果你需要把记录文件发给别人帮忙看,一定要先仔细检查,把密码、地址、电话这些秘密信息都删掉或涂掉。