Skip to main content
skill CX Codex

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

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add johnrogers/claude-swift-engineering
/plugin install swift-engineering@claude-swift-engineering
Open on GitHub

What 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 SnapKit do in this project?
  • Inspect the API of the Kingfisher dependency for App.xcodeproj
  • Show documentation for public interfaces in the Logging package

How to install generating-swift-package-docs

1Plugin marketplace

/plugin marketplace add johnrogers/claude-swift-engineering
/plugin install swift-engineering@claude-swift-engineering

This 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-code

3Manually: put the files in place

~/.claude/skills/generating-swift-package-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/generating-swift-package-docs/

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

Similar skills

All skills for Mobile →

From the same set33

The whole set →
swift-style swift-style — a skill for Claude Code, Codex, Cursor and other AI coding platforms that enforces Swift code style: naming, spacing, section order, guard patterns. Applied automatically when working with .swift files. CX Codex +1 1,500installs restore-snapshot The restore-snapshot command uses .claude/snapshot.md to recap prior work and ask what to tackle next. Run it when you want to carry context into a new session. CX Codex +1 ★ 233repo stars snapshot Captures what you've accomplished and writes a summary to .claude/snapshot.md. Use it to quickly restore context in the next session via the resume-snapshot command. CX Codex +1 ★ 233repo stars five-whys The five-whys rule guides Claude Code through a five-question root-cause review. Use it when a visible failure needs a deeper process or system explanation. CX Codex +1 ★ 233repo stars swift-test-creator swift-test-creator writes unit and integration tests with Swift Testing — @Test, #expect, #require. Meant to run once the feature code is in place. CX Codex ★ 233repo stars swift-documenter swift-documenter is a Claude Code subagent that creates and updates README files and Swift doc comments after a feature is finished or during package documentation revisions. CX Codex ★ 233repo stars swift-modernizer The swift-modernizer subagent updates legacy Swift code toward async/await, modern APIs, and SwiftUI. Use it to plan and verify incremental migrations in an existing project. CX Codex ★ 233repo stars reflect reflect is a Claude Code command that reviews chat context and project settings, then suggests changes to instructions, commands, and configuration. CX Codex +1 ★ 233repo stars

Project sponsors

Companies that keep this analytics open