About xcdocs
xcdocs is a local Apple-framework reference for developers implementing code against Apple APIs. It searches documentation entries and retrieves their full contents to help verify symbols, usage, and availability.
Key features
- 01Search symbols, articles, and topics
- 02Filter by framework and kind
- 03Retrieve full documentation entries
- 04JSON output
Use cases
- 01Verify API names behind compile failures
- 02Explore newly released framework features
- 03Identify the type of a documentation entry
- 04Find related types and concepts
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/xcdocsin Claude Code to confirm it loaded.
Bundled filesagents/openai.yamlreferences/cli.md
Details
From the project READMEXCDocs
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.
Comments
Markdown supported