Claw Wiki

📚 OpenClaw 官方文档本地管家

OpenClaw 官方文档本地快照查询与同步工具,支持离线查阅产品用法、配置、CLI 命令、网关行为等,并可按需从上游刷新文档

收藏
10.6k
安装
2.2k
版本
0.1.2
CLS 安全性认证2026-08-11
点击查看完整报告 >

使用说明

核心用法

Claw Wiki 是面向 OpenClaw 产品的官方文档本地快照管理工具,主要服务于两类场景:

1. 文档查询:用户询问 OpenClaw 的工作原理、配置方法、CLI 命令用法、网关行为、故障排查等时,工具从本地 openclaw_docs/ 目录读取官方文档快照作答,而非依赖训练记忆
2. 文档刷新:当用户明确要求"更新文档""检查是否过期""同步最新版本"时,执行受控的同步流程,从上游 OpenClaw 文档仓库拉取最新内容并重建本地索引

工作流程遵循严格的路由策略:先判断意图类型,再通过 references/routing-cheatsheet.mdreferences/query-examples.md 定位目标文档目录,使用 rg 进行精准文本搜索,读取最相关的 1-3 个文件后合成答案,并标注引用路径。

显著优点

  • 权威性保障:答案严格源自官方文档快照,避免模型幻觉
  • 离线可用:本地快照确保无网络环境下仍可查询
  • 可追溯性:每个关键声明都标注具体文件路径,便于用户验证
  • 版本感知:通过 state/source-lock.json 记录快照版本, freshness-sensitive 场景会主动提示文档时效
  • 安全边界清晰:明确区分只读查询与受控刷新,禁止执行任意脚本、访问凭证或向外推送内容

潜在局限

  • 快照时效性:非实时连接上游,需用户主动触发刷新才能获得最新文档
  • 语言限制:仅保证英文文档集的可用性,本地化内容可能不完整
  • 搜索依赖:查询质量受限于用户关键词与本地索引精度,模糊问题可能需要多次迭代
  • 实验性内容隔离experiments/ 目录内容仅在用户主动询问规划/提案时才会引用

适合人群

  • OpenClaw 运维人员与开发者,需要快速查阅配置参考、CLI 手册、故障排查指南
  • 离线环境或敏感网络中的用户,无法直接访问上游文档站点
  • 需要验证特定版本行为(通过快照版本锁定)的回归测试场景

常规风险

| 风险类别 | 说明 |
|---------|------|
| 信息过时 | 未及时刷新的快照可能包含已废弃的 API 或配置选项 |
| 范围溢出 | 用户可能诱导工具执行文档同步之外的文件操作,需依赖安全契约的硬限制拦截 |
| 示例代码误用 | 文档中的示例 token、密码仅为演示用途,工具不得将其当作真实凭证 |
| 远程拉取风险 | 同步流程仅从固定上游源读取,但若上游被投毒,本地快照将受影响(需配合上游签名验证)|

安全等级 S 来源于其只读为主的架构设计、严格的目录写入限制、以及明确的禁止行为清单(无 credential 访问、无远程写入、无任意代码执行)。

安全解读

核心用法

Claw Wiki 是一款面向 OpenClaw 平台的本地文档查询与维护技能。用户可通过自然语言提问获取产品使用、部署配置、CLI 命令、网关行为等官方文档信息。该技能优先从本地 openclaw_docs/ 快照中检索答案,仅在用户明确要求时触发与上游仓库的同步更新。支持关键词索引快速定位、多文件交叉验证,并在回答中标注具体引用来源路径,确保可追溯性。

显著优点

安全架构严谨:完全基于 Python 标准库构建,零第三方依赖,彻底规避供应链攻击风险。文件操作通过 ensure_within_skill_root() 强制限定在技能目录内,有效防御路径遍历。网络活动唯一来源为经白名单严格校验的 github.com/openclaw/openclaw 官方仓库,拒绝任意用户输入的 URL。

离线优先设计:本地文档快照确保无网络环境下仍可快速响应查询,索引文件(topic-index.jsondocs-manifest.json)加速检索效率,适合企业内部部署或网络受限场景。

透明度与可审计性:所有回答均附带源文件路径,用户可即时核验;状态文件(source-lock.json)明确记录快照版本与时间,避免信息陈旧导致的误判。

潜在缺点与局限性

覆盖范围受限:仅支持 OpenClaw 单一技术栈,无法扩展至其他框架或通用知识库。非 OpenClaw 相关问题将超出技能边界。

同步延迟风险:本地快照可能存在版本滞后,若用户未主动触发刷新,可能基于旧文档给出建议。虽然状态文件提供版本追溯,但缺乏自动过期提醒机制。

功能边界严格:明确拒绝执行文档中的示例命令、不处理真实凭证、不推送代码或创建 PR,这在提升安全性的同时也限制了自动化运维场景的灵活性。

适合的目标群体

  • OpenClaw 平台运维工程师与架构师
  • 需要离线查阅技术文档的开发团队
  • 注重供应链安全、禁止引入第三方依赖的企业环境
  • 技术写作人员与文档维护者

使用风险说明

性能方面:首次构建索引或执行完整文档同步时,大体积仓库的 git clone 操作可能消耗较长时间与磁盘空间,建议配置合理的临时目录清理策略。

依赖方面:虽无外部库依赖,但依赖本地 git 命令行工具可用性,在精简容器环境中需确保基础工具链完整。

来源可信度:维护者为 T3 级个人开发者,建议关注上游仓库更新动态,关键场景下优先采用官方渠道发布的等效工具。

Claw Wiki 内容

openclaw_docs文件夹
.i18n文件夹
assets文件夹
showcase文件夹
sponsors文件夹
automation文件夹
channels文件夹
cli文件夹
concepts文件夹
debug文件夹
design文件夹
diagnostics文件夹
experiments文件夹
plans文件夹
proposals文件夹
research文件夹
gateway文件夹
security文件夹
help文件夹
images文件夹
install文件夹
ja-JP文件夹
start文件夹
nodes文件夹
platforms文件夹
mac文件夹
plugins文件夹
providers文件夹
refactor文件夹
reference文件夹
templates文件夹
security文件夹
start文件夹
tools文件夹
web文件夹
zh-CN文件夹
automation文件夹
channels文件夹
cli文件夹
concepts文件夹
debug文件夹
diagnostics文件夹
experiments文件夹
plans文件夹
proposals文件夹
research文件夹
gateway文件夹
security文件夹
help文件夹
install文件夹
nodes文件夹
platforms文件夹
mac文件夹
plugins文件夹
providers文件夹
refactor文件夹
reference文件夹
templates文件夹
security文件夹
start文件夹
tools文件夹
web文件夹
references文件夹
scripts文件夹
state文件夹
手动下载zip · 2.2 MB
glossary.ja-JP.jsonapplication/json
请选择文件