用途
apple-docs 用于查询 Apple 开发者文档、框架、API 以及 WWDC 视频。它面向需要检索 SwiftUI、UIKit、Objective-C、Swift 等 Apple 框架资料的开发者,帮助查找文档、符号、API 关系、平台兼容性、示例项目与 WWDC 会话内容。
主要能力
文档搜索
apple-docs search "query":搜索 Apple 开发者文档。apple-docs symbols "UIView":搜索框架中的类、结构体、协议。apple-docs doc "/path/to/doc":按路径获取详细文档。
API 探索
apple-docs apis "UIViewController":查找继承关系与协议遵循。apple-docs platform "UIScrollView":检查平台/版本兼容性。apple-docs similar "UIPickerView":查找 Apple 推荐的替代方案。
技术浏览
apple-docs tech:按分类列出所有 Apple 技术。apple-docs overview "SwiftUI":获取综合技术指南。apple-docs samples "SwiftUI":浏览 Swift/Objective-C 示例项目。
WWDC 视频
apple-docs wwdc-search "async":搜索 WWDC 会话(2014-2025)。apple-docs wwdc-video 2024-100:获取文字记录、代码示例与资源。apple-docs wwdc-topics:列出 20 个 WWDC 主题分类。apple-docs wwdc-years:列出 WWDC 年份及视频数量。
使用方式
无需安装,开箱即用,基于原生 fetch 工作。
可用选项:
--limit <n>:限制结果数量。--category:按技术分类过滤。--framework:按框架名称过滤。--year:按 WWDC 年份过滤。--no-transcript:跳过 WWDC 视频的文字记录。--no-inheritance:在 apis 命令中跳过继承信息。--no-conformances:在 apis 命令中跳过协议遵循信息。
示例:
- 搜索文档:
apple-docs search "SwiftUI animation" - 查找 UITableView 委托方法:
apple-docs symbols "UITableViewDelegate" - 检查平台兼容性:
apple-docs platform "VNRecognizeTextRequest" - 查找支持 iOS 15+ 的 SwiftUI 视图:
apple-docs search "SwiftUI View iOS 15" - 获取 UIViewController 继承层级:
apple-docs apis "UIViewController" - 查找已弃用 API 的替代方案:
apple-docs similar "UILabel" - 搜索 async/await 会话:
apple-docs wwdc-search "async await" - 获取特定视频详情与文字记录:
apple-docs wwdc-video 2024-100 - 列出所有可用年份:
apple-docs wwdc-years - 列出所有 Apple 技术:
apple-docs tech - 获取 SwiftUI 概览指南:
apple-docs overview "SwiftUI" - 查找 Vision 框架示例:
apple-docs samples "Vision"
工作原理
- 与 Apple 开发者 API 直接集成,无外部依赖或第三方包。
- 文档从 developer.apple.com 实时获取。
- WWDC 数据本地索引(2014-2025 年共 1260+ 场会话),支持快速离线搜索。
- 重建 WWDC 索引:
node build-wwdc-index.js
适用场景
适用于需要查询 Apple 开发者文档、探索框架 API 关系、检查平台版本兼容性、查找示例项目,以及检索 WWDC 视频内容与代码示例的开发场景。
限制
资料未提供关于收费、价格、平台支持范围、性能效果等方面的具体说明。