DocClaw

📚 三层文档查询 · 精准安全溯源

为OpenClaw提供实时文档搜索、精准Markdown获取与离线本地文档回退的三层文档查询方案,确保配置查询的准确性与安全性。

收藏
7.9k
安装
1.7k
版本
1.0.2
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

DocClaw 是专为 OpenClaw 设计的文档查询技能,采用三层递进式架构解决技术文档检索需求:

1. 实时搜索层(Primary)

  • 执行 openclaw docs "<query>" 进行在线文档检索
  • 返回 3-7 条带相关性说明的精准链接
  • 直接对接 docs.openclaw.ai 官方文档源

2. 精准获取层(Precision Mode)

  • 索引刷新:python3 {baseDir}/scripts/refresh_docs_index.py
  • Markdown 直取:fetch_doc_markdown.py 支持 slug/关键词查询,如 "cli/models""gateway/configuration"
  • 专为需要精确行为引用的场景设计

3. 离线回退层(Offline Fallback)

  • find_local_docs.py 自动发现本地文档根目录
  • 配合 rg(ripgrep)实现无网环境下的全文检索
  • 保障极端网络条件下的可用性

显著优点

  • 分层容错设计:在线/精准/离线三层互补,网络波动不影响核心功能
  • 安全沙箱机制:v1.0.2 移除本地路径环境变量覆盖,强制 HTTPS 域限制,防范供应链污染
  • 精准引用能力:直接输出 .md 源文件,便于技术文档的精确行为验证
  • 跨平台兼容:原生支持 macOS/Linux,依赖标准化 Python3 生态

潜在局限

  • Windows 支持缺失:文档明确限定 macOS/Linux 平台
  • 网络域白名单限制:仅允许 docs.openclaw.ai,无法扩展至第三方文档源
  • 本地文档需预置:离线模式依赖用户提前部署的本地文档副本
  • 无自动缓存层:频繁查询可能触发速率限制,未提及智能缓存策略

适合人群

  • OpenClaw 运维/开发工程师需频繁查询配置参数与 CLI 行为
  • 编写自动化脚本需精确引用官方文档的技术作者
  • 处于隔离网络环境(air-gapped)的企业部署场景

常规风险

| 风险类型 | 说明 | 缓解措施 |
|---------|------|---------|
| 内容信任风险 | 获取文档与运行时行为可能存在版本漂移 | 强制要求 `--help` 二次验证 |
| 注入风险 | 历史版本曾存在路径覆盖漏洞 | v1.0.2 已移除 env-path override |
| 幻觉风险 | 严禁编造 flags/keys/paths,所有输出需溯源至官方文档 | 输出规则强制约束 |

版本演进

  • v1.0.2(2026-02-18):安全加固版本,移除本地文档环境路径覆盖能力,强化发布流程的供应链安全。

DocClaw 内容

scripts文件夹
手动下载zip · 9.0 kB
fetch_doc_markdown.pytext/plain
请选择文件