Agent Skills
› BitrigApp/XCDocs
› xcdocs
xcdocs
GitHub提供本地 Apple 框架文档查询能力,辅助开发者在编写、调试代码时解决编译错误、查找符号及确认 API 用法。
Trigger Scenarios
Apple 框架代码编译失败
需要查阅 Apple API 文档或新特性
确认符号名称或可用性
Install
npx skills add BitrigApp/XCDocs --skill xcdocs -g -y
SKILL.md
Frontmatter
{
"name": "xcdocs",
"description": "Use when an agent is writing, debugging, or updating code against Apple frameworks and needs local Xcode documentation to resolve compile errors, discover the right symbols, check API shape or availability, confirm usage patterns, or inspect related articles and topics for newly released SDK features."
}
XCDocs
Use xcdocs as a local Apple-framework reference while changing code.
Use It During Implementation
- Ensure
xcdocsis available before relying on the skill. - Reach for it when an Apple API is unfamiliar, newly released, renamed, or failing to compile.
- Start with
search --json --omit-contentto find the likely symbol, article, or topic. - Add repeatable
--frameworkand--kind {article|symbol|topic}filters when the query is broad. - Treat
documents[].urifrom search results as the canonical identifier forget. - Use
get --jsonto inspect the full entry before editing code that depends on it. - Apply what you find to the code: fix symbol names, choose the right overload, adjust availability guards, or switch to the documented API.
Common Uses
- Fix compile failures against Apple frameworks by verifying the actual symbol name and entry point.
- Explore a newly released framework or feature area before wiring it into code.
- Check whether an API is a symbol, a broader topic page, or an article with setup guidance.
- Find adjacent types or concepts after locating one relevant documentation entry.
Reference
- Read references/cli.md for command syntax, JSON shapes, and troubleshooting.
Version History
- bdf36b0 Current 2026-07-24 22:18


