核心用法
Claw Wiki 是面向 OpenClaw 产品的官方文档本地快照管理工具,主要服务于两类场景:
1. 文档查询:用户询问 OpenClaw 的工作原理、配置方法、CLI 命令用法、网关行为、故障排查等时,工具从本地 openclaw_docs/ 目录读取官方文档快照作答,而非依赖训练记忆
2. 文档刷新:当用户明确要求"更新文档""检查是否过期""同步最新版本"时,执行受控的同步流程,从上游 OpenClaw 文档仓库拉取最新内容并重建本地索引
工作流程遵循严格的路由策略:先判断意图类型,再通过 references/routing-cheatsheet.md 或 references/query-examples.md 定位目标文档目录,使用 rg 进行精准文本搜索,读取最相关的 1-3 个文件后合成答案,并标注引用路径。
显著优点
- 权威性保障:答案严格源自官方文档快照,避免模型幻觉
- 离线可用:本地快照确保无网络环境下仍可查询
- 可追溯性:每个关键声明都标注具体文件路径,便于用户验证
- 版本感知:通过
state/source-lock.json记录快照版本, freshness-sensitive 场景会主动提示文档时效 - 安全边界清晰:明确区分只读查询与受控刷新,禁止执行任意脚本、访问凭证或向外推送内容
潜在局限
- 快照时效性:非实时连接上游,需用户主动触发刷新才能获得最新文档
- 语言限制:仅保证英文文档集的可用性,本地化内容可能不完整
- 搜索依赖:查询质量受限于用户关键词与本地索引精度,模糊问题可能需要多次迭代
- 实验性内容隔离:
experiments/目录内容仅在用户主动询问规划/提案时才会引用
适合人群
- OpenClaw 运维人员与开发者,需要快速查阅配置参考、CLI 手册、故障排查指南
- 离线环境或敏感网络中的用户,无法直接访问上游文档站点
- 需要验证特定版本行为(通过快照版本锁定)的回归测试场景
常规风险
| 风险类别 | 说明 |
|---------|------|
| 信息过时 | 未及时刷新的快照可能包含已废弃的 API 或配置选项 |
| 范围溢出 | 用户可能诱导工具执行文档同步之外的文件操作,需依赖安全契约的硬限制拦截 |
| 示例代码误用 | 文档中的示例 token、密码仅为演示用途,工具不得将其当作真实凭证 |
| 远程拉取风险 | 同步流程仅从固定上游源读取,但若上游被投毒,本地快照将受影响(需配合上游签名验证)|
安全等级 S 来源于其只读为主的架构设计、严格的目录写入限制、以及明确的禁止行为清单(无 credential 访问、无远程写入、无任意代码执行)。