OC
OpenClaw 中文解释版

给五岁小朋友也能看懂的说明书

简要总结

secrets

这页是教你用 OpenClaw 管理“秘密”的。什么是“秘密”呢?就像你藏起来的糖果,不想让别人看到,比如密码、钥匙。这个工具能帮你把电脑里的“秘密”藏好,检查它们有没有被乱放,还能帮你安全地换掉旧的“秘密”。当你需要设置或检查你的密码安全时,就可以看看这页。

五岁小孩版解释

这个工具就像一个“秘密小管家”,帮你管好那些不能让别人知道的密码和钥匙。它有几个不同的命令,每个命令做不同的事情。

  1. openclaw secrets reload 这个命令是“重新加载秘密”。就像你换了一盒新积木,要告诉你的玩具城堡用新的。它会安全地检查所有“秘密”是不是都准备好了,如果都准备好了,就一下子全部换成新的。如果检查没通过,城堡就还用原来的旧积木,不会出错。

  2. openclaw secrets audit 这个命令是“检查秘密”。就像妈妈检查你的房间,看看有没有玩具乱放。它会帮你检查电脑里有没有把“秘密”写在了不该写的地方(这叫“明文”),有没有找不到的“秘密”(这叫“未解析的引用”),或者有没有旧的“秘密”垃圾没清理。

    • 你可以加 --check 来检查,如果发现有问题,它会“生气地”退出(退出码是1),这样你就能知道需要处理了。
    • 如果发现有“秘密”根本找不到(未解析的引用),它会“更生气地”退出(退出码是2)。
  3. openclaw secrets configure 这个命令是“设置秘密”。它会像一个耐心的老师,一步一步问你问题,帮你把“秘密”藏好。你需要在一个能打字的窗口(TTY)里运行它。

    • 它会先问你把“秘密”藏在哪里(设置“提供者”,就像选择是藏在抽屉里还是保险箱里)。
    • 然后问你要把哪些“秘密”藏起来(把密码、钥匙这些字段,和藏的地方对应起来)。
    • 最后它会先试一试能不能成功(这叫“预检”),再问你要不要真的藏起来(应用)。
    • 你可以用 --providers-only 只设置藏的地方,或者用 --skip-provider-setup 跳过设置藏的地方,直接用已经有的。
    • 要小心:藏好之后,原来的“秘密”就会被擦掉,就像用橡皮擦掉铅笔字,一般找不回来了。
  4. openclaw secrets apply 这个命令是“执行计划”。如果你用 configure 做了一个“藏秘密计划”并保存了下来,就可以用这个命令来执行这个计划。

    • 你可以先加 --dry-run 试试看,就像演习一样,不会真的去藏。
    • 不加 --dry-run 就会真的去执行计划,把“秘密”藏好,并把原来乱放的“秘密”擦干净。

一个常用的好顺序: 你可以像下面这样,一步一步来管理你的“秘密”:

  1. 先检查:openclaw secrets audit --check
  2. 再设置:openclaw secrets configure
  3. 试一试:openclaw secrets apply --from 你的计划文件.json --dry-run
  4. 真的做:openclaw secrets apply --from 你的计划文件.json
  5. 再检查:openclaw secrets audit --check
  6. 换新的:openclaw secrets reload

重要提醒:

  • 这个工具不会自动帮你把旧的“秘密”备份起来,因为它设计得很安全,会先仔细检查,再一下子换好,如果中间出错它会自己尽力恢复。
  • 在设置“提供者”(藏秘密的地方)时,如果是在苹果电脑上用 Homebrew 安装的,可能会遇到一些路径问题。除非你非常确定路径是安全的,否则不要轻易设置 allowSymlinkCommand: truetrustedDirs
  • 在 Windows 电脑上,如果它检查不了某个路径的安全性,它会为了安全而停止。如果你完全信任那个路径,可以给那个“提供者”设置 allowInsecurePath: true 来跳过检查。