generating-swift-package-docs — Claude Code skill: setup & overview
generating-swift-package-docs generates on-demand Swift package documentation from DerivedData when inspecting unfamiliar module imports.
MIT ★ 233 updated 2026-01-18
/plugin marketplace add johnrogers/claude-swift-engineering
/plugin install swift-engineering@claude-swift-engineeringWhat generating-swift-package-docs does
This skill inspects unfamiliar Swift dependencies within Xcode projects. When an unknown import appears in source files or you need to inspect an external library, the assistant retrieves symbol details instead of guessing function signatures from context.
The workflow executes ./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>". It relies on the interfazzle CLI to pull symbol declarations directly from compiled modules, caches the documentation file, and reads the summary.
Execution fails if the project was never compiled: the script requires an existing DerivedData folder alongside an installed interfazzle binary.
What it helps with
- inspect unfamiliar Swift imports in an active project
- extract module symbols from compiled binaries without searching the web
- generate local API documentation for third-party Swift packages
Example prompts for the agent
- What does
import SnapKitdo in this project? - Inspect the API of the
Kingfisherdependency forApp.xcodeproj - Show documentation for public interfaces in the
Loggingpackage
How to install generating-swift-package-docs
1Plugin marketplace
/plugin marketplace add johnrogers/claude-swift-engineering/plugin install swift-engineering@claude-swift-engineeringThis installs the whole swift-engineering plugin with all its skills
2Skills CLI (Vercel)
npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a claude-code3Manually: put the files in place
~/.claude/skills/generating-swift-package-docs/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/generating-swift-package-docs/
1Skills CLI (Vercel)
npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a codex2Manually: put the files in place
.agents/skills/generating-swift-package-docs/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a cursor2Manually: put the files in place
.cursor/skills/generating-swift-package-docs/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install johnrogers/claude-swift-engineering plugins/swift-engineering/skills/generating-swift-package-docs2Manually: put the files in place
.github/skills/generating-swift-package-docs/SKILL.md1Skills CLI (Vercel)
npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a gemini-cli2Platform CLI
gemini skills install https://github.com/johnrogers/claude-swift-engineering --path plugins/swift-engineering/skills/generating-swift-package-docsManually: put the files in place
.devin/skills/generating-swift-package-docs/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about generating-swift-package-docs
How to install generating-swift-package-docs in Claude Code?
Run npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a claude-code in your terminal, or register the repository with /plugin marketplace add johnrogers/claude-swift-engineering and install the plugin using /plugin install swift-engineering@claude-swift-engineering.
What does generating-swift-package-docs do?
It inspects compiled module symbols to produce local API documentation for Swift dependencies upon request.
What are the prerequisites for this skill?
You must install the interfazzle CLI and build your Xcode project at least once so DerivedData contains the compiled symbols.
Source text
SKILL.md · MIT
--- name: generating-swift-package-docs description: Use when encountering unfamiliar import statements, exploring dependency APIs, or when user asks "what's import X" or "what does X do". Generates on-demand API documentation for Swift package dependencies. --- # Swift Package Documentation Generator Generates API documentation for Swift package dependencies on-demand, extracting symbol information from Xcode's DerivedData to answer "what does this library do?" ## Overview When exploring unfamiliar dependencies, generate their documentation automatically instead of guessing from code. This tool uses `interfazzle` to extract symbol information from compiled modules. ## How to Use When asked about an unfamiliar Swift module import: 1. Run: `./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>"` 2. Script outputs path to cached documentation file 3. Read the file and provide relevant information Prerequisites: Project must be built once (DerivedData exists), `interfazzle` CLI installed. See [reference.md](reference.md) for error handling and details.
© John Rogers (@johnrogers) · MIT · johnrogers/claude-swift-engineering