核心功能
claw-wiki 是一款面向 OpenClaw 产品的本地化文档检索与维护技能。其核心能力包括:
1. 离线文档查询:基于本地 openclaw_docs/ 目录的 Markdown 源文档,通过结构化索引(docs-manifest.json、topic-index.json)实现快速全文检索,覆盖安装部署、平台适配、运行时模型、CLI 命令、通道配置、安全策略等完整产品知识体系。
2. 智能路由导航:内置 routing-cheatsheet.md 和 query-examples.md,针对模糊意图自动映射到最佳文档路径(如安装问题→start//install/,故障排查→help//diagnostics/)。
3. 文档版本管理:通过 source-lock.json 锁定上游来源、分支、提交哈希及同步时间戳,明确告知用户本地快照的新鲜度;支持通过脚本化工作流(sync_docs.py → validate_docs.py → build_knowledge.py → diff_docs.py)按需拉取上游更新并生成变更摘要 latest-diff.md。
显著优势
- 确定性可重复:本地快照避免了远程文档的实时变动,确保答案的一致性与可追溯性,特别适合 CI/CD 环境或合规场景。
- 低延迟响应:基于本地
rg全文搜索与预建索引,无需网络往返即可秒级定位文档片段。 - 权限边界清晰:严格只读上游(禁止
git push、PR 创建、技能内容回传),降低供应链安全风险。 - 多语言支持基础:保留本地化导航入口扩展能力(虽验证仅保证英文文档集可用)。
潜在局限
- 新鲜度依赖手动刷新:文档非实时同步,用户需主动触发更新流程才能获取上游最新变更;若长期未刷新,可能遗漏关键 Bugfix 或 API 变更说明。
- 英语为唯一验证语言:虽存在多语言导航元数据,但核心内容仅保证英文可用,非英语用户可能体验受限。
- 索引构建依赖脚本:首次使用或文档结构大幅变更后需执行
build_knowledge.py重建索引,存在短暂不可用窗口。 - 模糊查询精度受限:极度口语化或跨领域混合问题可能需多次迭代搜索才能定位,路由表覆盖范围决定上限。
适用人群
- OpenClaw 平台运维工程师与 SRE,需离线或内网环境查阅配置手册
- 开发团队技术负责人,需要锁定特定版本文档进行合规审计
- 集成开发者,频繁查询 CLI 参数、通道行为、网关安全策略等实现细节
- 技术写作者或培训师,需要稳定版本文档作为课程或手册基础
常规风险提示
- 版本漂移风险:回答中需主动声明快照提交哈希及日期,避免用户误将过期文档当作当前权威来源。
- 权限误配置风险:
scripts/目录包含git fetch/clone能力,若运行环境具备写权限,需确保遵循「只读上游」原则,防止意外推送。 - 索引失效风险:手动修改
openclaw_docs/未触发重建脚本时,可能导致搜索结果与文件内容不一致。 - 上游变更冲突:更新流程中若上游文档结构重构(如文件重命名、目录迁移),
diff_docs.py生成的摘要可能需人工介入理解。