apple-docs:离线文档搜索与 MCP 工具

26次阅读
没有评论
apple-docs 免费下载|离线文档搜索与 MCP 工具
获取下载链
微信关注「软件教程管家」公众号,回复 apple-docs
官方渠道:GitHub 仓库

30秒速读

查 Apple 开发文档时,最烦的是在好几个站点之间来回跳,还没法让 AI 编程工具直接引用查到的内容。apple-docs 的做法是把 Apple 开发资料整套搬到本机,做成可离线检索的本地语料库:终端能搜、浏览器能看、AI 工具能通过 MCP 查。据项目说明,代价是初始下载约 1.16 GB 的归档、磁盘占用数 GB 起,磁盘紧张或没法接受大体积初始下载的人要先掂量一下。

前往 GitHub 查看 apple-docs

GitHub 国内访问较慢,如打不开可多刷新几次

软件信息表

项目 内容
名称 apple-docs
定位 面向 Apple 开发者的离线文档搜索与 MCP 工具
技术栈 JavaScript、Bun 1.1 或更高版本
三个入口 命令行搜索、MCP 服务器、本地网站(含静态站点生成)
语料范围 API 参考、设计指南、评审指南、Swift 资料、WWDC 转录、示例代码、SF Symbols、Apple 字体等
初始下载 约 1.16 GB 归档,安装时构建本地语义索引
磁盘占用 数 GB 级,提供紧凑、默认、快速读取三档存储配置
离线能力 安装完成后主要 workflow 不依赖云端服务或 API 密钥
MCP 特性 只读工具,分页响应,控制上下文消耗
MCP 兼容客户端 Claude、Codex、Cursor 及其他 MCP 客户端

上手指南

  1. 先装 Bun:确认 Bun 版本不低于 1.1,这是运行 apple-docs 的前置条件,版本不够时先升级 Bun 再往下走。
  2. 跑 setup 建索引:按项目文档运行 setup,下载约 1.16 GB 的归档并完成本地语义索引构建,这一步耗时和磁盘占用都值得提前预留。
  3. 选一档存储配置:在紧凑、默认、快速读取三档里按场景取舍,笔记本省空间选紧凑,追求读取速度选快速档,拿不准先默认。
  4. 三种入口各试一次:终端里做一次精确符号查询和一次自然语言查询,浏览器里打开本地网站验证全文搜索,再把 MCP 接进常用的 AI 客户端验证搜索与读取是否通畅。
  5. 需要共享时生成静态站:个人用本地网站就够,团队共享或内部建站时再生成静态站点发布,不要一上来就把本地服务往外暴露。

装完必改设置

  1. 存储档位定下来:三档存储配置对应不同的磁盘占用与读取速度,装完先按自己的机器和使用场景定一档,中途切换要重新验证搜索与发布结果。
  2. MCP 接入范围:把 MCP 接进 Claude、Codex、Cursor 等客户端时,先确认只读工具的返回结构符合预期,分页响应能有效控制上下文消耗,再当成日常 workflow。
  3. 静态站发布配置:要对外提供文档站时,配好 Markdown 文档地址、robots.txt、API 目录和 MCP server card 这类发现接口,让人和 AI 工具都能找到入口。
  4. 快照更新节奏:语料快照由 CI 周期性重建,装完就把更新流程跑通一次,知道新快照来了怎么更新、更新后怎么验证,而不是等到查不到新资料才想起这件事。

注意事项与常见问题

  • 磁盘先留够数 GB:不同存储配置都要占用数 GB 空间,而且项目文档给出的容量是测量下限,实际占用要自己重新验证,磁盘紧张的机器先清理再安装。
  • HTTP 模式没有内置认证:远程暴露时千万别裸奔,没有内置身份认证的服务直接公开等于把内网文档站敞开,必须由反向代理或隧道承担访问控制。
  • 快照不保证最新:文档内容靠 CI 周期性重建快照,不能据此保证任意时刻都包含 Apple 的最新资料,对时效性要求高的内容要去官方渠道二次确认。
  • 公开实例没有服务等级承诺:项目提供的公开实例不承诺可用性,生产用途应当评估自托管方案和自己要承担的运维责任。
  • 升级后要重新验证:升级 Bun、切换存储配置或改用网站自托管后,搜索、MCP 接口和静态发布结果都要重新验证一遍再投入使用。

三个入口怎么选

入口 适合谁
命令行搜索 日常在终端查 Swift、SwiftUI 与 API 文档的开发者,精确符号与自然语言查询都支持
MCP 服务器 希望 AI 编程工具直接引用本地文档的 workflow, Claude、Codex、Cursor 均可接入
本地网站与静态站 喜欢浏览器浏览全文搜索的人,以及需要给团队提供内部文档站的场景

推荐:个人日常以命令行加 MCP 为主,需要共享时再生成静态站;三个入口共用同一套语料,不用重复建库。

适合谁,不适合谁

适合:需要在本地检索 Apple 开发资料的 Swift、SwiftUI、macOS、iOS 开发者;希望 AI 编程工具通过 MCP 查询可引用文档的个人或团队;离线环境下也要查 WWDC 转录、示例代码、SF Symbols 与字体资料的人。

不适合:磁盘空间紧张、没有 Bun 运行环境、接受不了约 1.16 GB 初始下载的人;需要远程访问却不想额外配置反向代理与认证的人;对资料时效性要求极高、不能接受快照更新节奏的人。

一句话取舍:本机有空间、有 Bun 环境、又想把 Apple 文档变成 AI 也能查的本地知识库时,它很对路;否则直接用在线文档更省事。

推广apple-docs 免费下载|离线文档搜索与 MCP 工具

关注「软件教程管家」

回复软件名即取即下:网盘下载链接 + 提取码,一步直达,不用再跳转。

版权与使用提示

本站资源仅供个人学习交流,请勿用于商业用途。软件与资料版权归原作者所有;如有侵权,请通过公众号「软件教程管家」联系我们,我们将在 24 小时内下架处理。查看免责声明 ›

上次编辑至今:11小时 · 内容还比较新鲜

公告

契机库网站正式上线!

了解更多
正文完
 0
评论(没有评论)