anydocs

📚 极速文档索引与智能搜索

🥥52总安装量 17评分人数 21
100% 的用户推荐

OpenClaw文档索引工具支持SPA抓取和本地缓存,让开发者终端秒查API,告别浏览器切换,提升研发效率。

A

基本安全,请在特定环境下使用

  • 来自社区或个人来源,建议先隔离验证
  • ✅ 代码安全规范:未使用 eval/exec/subprocess 等危险函数,无动态代码加载或代码注入风险
  • ✅ 依赖管理严格:所有依赖版本完全锁定(requirements.txt),使用知名开源库无已知严重 CVE
  • ✅ 输入验证完善:URL、配置参数均有严格校验,缓存键使用 SHA256 哈希防止路径遍历攻击
  • ⚠️ 外部访问风险:会主动访问用户配置的文档站点,需确保仅索引可信来源,避免配置恶意 URL
  • ⚠️ 凭证管理:浏览器渲染模式需 OpenClaw Gateway Token,应通过环境变量配置并妥善保管

使用说明

anydocs 是一款由 OpenClaw Community 开发的通用文档索引与搜索工具,旨在解决开发者频繁在浏览器与编辑器之间切换查询文档的痛点。该工具通过"配置-索引-搜索"的三步工作流,允许用户将任意文档站点(包括 Vue.js、Discord 等 SPA 应用)转化为可本地极速检索的知识库。

核心用法极为直观:首先通过 anydocs config 配置文档站点的 base_url 与 sitemap_url,建立独立 profile;随后执行 anydocs index 构建本地搜索索引,系统会自动抓取站点地图中的所有页面并提取文本内容;最后通过 anydocs search 进行关键词、混合语义或正则表达式搜索,结果按 BM25 算法排序。除 CLI 外,还提供 Python API 供开发者集成到自动化脚本或 AI Agent 中。

显著优点包括极致的通用性与灵活性。不同于专用文档工具,anydocs 支持任意符合标准的文档站点,通过可选的 Playwright 浏览器渲染能力,甚至能处理重度依赖 JavaScript 的 SPA 文档。其智能缓存机制(7 天 TTL)确保二次搜索毫秒级响应,同时减少对外部站点的重复请求。多 profile 管理功能让开发者可同时维护多个文档库,并通过统一的接口快速切换。

潜在缺点方面,首次索引构建通常需要 2-10 分钟,对于大型文档站点可能耗时较长;功能依赖外部站点的可访问性与 sitemap 的规范性,若目标站点结构异常可能需要手动干预;浏览器渲染模式虽强大,但需额外安装体积较大的 Playwright 及其 Chromium 依赖,对资源受限环境不够友好。

适合的目标群体包括高频查阅技术文档的软件开发者、需要为内部知识库提供搜索能力的 DevOps 工程师,以及构建需要实时引用外部文档的 AI Agent 的开发者。对于技术写作者和开源维护者,它也是验证文档结构完整性的实用工具。

使用风险主要来自网络依赖与配置安全。工具需访问用户指定的外部 URL,若配置恶意站点可能存在钓鱼风险,建议仅索引可信的官方文档源。启用浏览器渲染功能时需要 OpenClaw Gateway Token,用户应通过环境变量传递而非硬编码,防止凭证泄露。此外,长期运行可能积累大量缓存文件,需定期清理以避免磁盘空间占用过高。

anydocs 内容

文件夹图标examples文件夹
文件夹图标lib文件夹
手动下载zip · 33.8 kB
custom-config.jsonapplication/json
请选择文件