Agent skill

Generating Swift Package Docs

by johnrogers in johnrogers/claude-swift-engineering

A skill your agent uses when encountering unfamiliar import statements, exploring dependency APIs, or when user asks "what's import X" or "what does X do".

MITAuto-check passedDevelopment

Install Generating Swift Package Docs

skills CLI
$ npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install johnrogers/claude-swift-engineering generating-swift-package-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/johnrogers/claude-swift-engineering.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/swift-engineering/skills/generating-swift-package-docs .claude/skills/generating-swift-package-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
generating-swift-package-docs
GitHub stars
231
Token cost
~272 tokens
SKILL.md length
100 words
Files
4 (incl. scripts)
Skills in repo
17
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when encountering unfamiliar import statements, exploring dependency APIs, or when user asks "what's import X" or "what does X do".

  • Works in 3 steps: Run: ./scripts/generate_docs.py "" "" → Script outputs path to cached… → Read the file and provide relevant…
  • Encountering unfamiliar import statements
  • SKILL.md covers Overview and How to Use
  • Runs Python scripts from its folder

What it does

Generating Swift Package Docs is an agent skill from johnrogers/claude-swift-engineering. 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.

Its SKILL.md is about 270 tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including scripts (for example `reference.md`, `scripts/generate_docs.py` and `scripts/swift_packages.py`).

It sits in Development, covering Technical documentation. It works with Swift. The repository describes itself as: A collection of agents and skills to aid in the planning, implementation, documentation and testing of Swift/TCA code. The licence is MIT.

When your agent uses it

  • Encountering unfamiliar import statements
  • Exploring dependency APIs
  • User asks whats import X

Example prompts

  • “s import X”
  • “what does X do”
  • “/generating-swift-package-docs”

Requirements

  • Python 3

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. Run: ./scripts/generate_docs.py "" ""
  2. Script outputs path to cached documentation file
  3. Read the file and provide relevant information

What it can do on your machine

Read from SKILL.md and the folder at commit 1dc2cf4. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 2 files in scripts/ (Python), which the agent can run.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Generating Swift Package Docs loads about 272 tokens when it runs. Until then it costs about 59 tokens; SKILL.md has 100 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~59
When it runs · the whole SKILL.md, loaded when a task matches
~272

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from johnrogers/claude-swift-engineering at commit 1dc2cf4, republished under its MIT licence (© johnrogers). 100 words, ~272 tokens.

Download SKILL.mdSave it as .claude/skills/generating-swift-package-docs/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
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 for error handling and details.

© johnrogers, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (scripts) in plugins/swift-engineering/skills/generating-swift-package-docs of johnrogers/claude-swift-engineering.

  • SKILL.md
  • reference.md
  • scripts/generate_docs.py
  • scripts/swift_packages.py

Open the folder on GitHubat commit 1dc2cf4

Compare with similar skills

Generating Swift Package Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Generating Swift Package Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Generating Swift Package Docs this skilljohnrogers/claude-swift-engineering231—~272Automated safety check: PassMIT
Swift DocC Documentationadamayoung/TMDb178—~2.6kAutomated safety check: PassApache-2.0
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT

Similar skills

  • Writes and maintains DocC /// comments for the public API of the TMDb Swift package, following the project's summary patterns and comment structure.

    178 GitHub stars~2.6k tokensUpdated 4 days ago
    DevelopmentAuto-check passed
  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed

More from johnrogers/claude-swift-engineering

All 17 skills in this repo
  • Localization

    johnrogers/claude-swift-engineering

    A skill your agent uses when implementing internationalization (i18n), String Catalogs, pluralization, or right-to-left layout support.

    231 GitHub stars~749 tokensUpdated 8 mo ago
    Auto-check passed
  • Storekit

    johnrogers/claude-swift-engineering

    A skill your agent uses when implementing in-app purchases, StoreKit 2 subscriptions, consumables, non-consumables, or transaction handling.

    231 GitHub stars~799 tokensUpdated 8 mo ago
    Auto-check passed
  • Swift Style

    johnrogers/claude-swift-engineering

    Swift code style conventions for clean, readable code. An agent skill from johnrogers/claude-swift-engineering.

    231 GitHub stars~828 tokensUpdated 8 mo ago
    Auto-check passed
  • Composable Architecture

    johnrogers/claude-swift-engineering

    A skill your agent uses when building features with TCA (The Composable Architecture), structuring reducers, managing state, handling effects, navigation, or testing TCA features.

    231 GitHub stars~982 tokensUpdated 8 mo ago
    Auto-check passed
  • Foundation Models

    johnrogers/claude-swift-engineering

    A skill your agent uses when implementing on-device AI with Apple's Foundation Models framework (iOS 26+), building summarization/extraction/classification features, or using @Generable for…

    231 GitHub stars~869 tokensUpdated 8 mo ago
    Auto-check passed
  • Grdb

    johnrogers/claude-swift-engineering

    A skill your agent uses when writing raw SQL with GRDB, complex joins across 4+ tables, window functions, ValueObservation for reactive queries, or dropping down from SQLiteData for performance.

    231 GitHub stars~719 tokensUpdated 8 mo ago
    Auto-check passed

Works with

Categories

Questions about Generating Swift Package Docs

What does Generating Swift Package Docs do?

A skill your agent uses when encountering unfamiliar import statements, exploring dependency APIs, or when user asks "what's import X" or "what does X do". Generating Swift Package Docs is an agent skill from johnrogers/claude-swift-engineering. Use when encountering unfamiliar import statements, exploring dependency APIs, or when user asks "what's import X" or "what does X do".

When should I use Generating Swift Package Docs?

Generating Swift Package Docs fits situations like: encountering unfamiliar import statements; exploring dependency APIs; user asks whats import X.

How do I install Generating Swift Package Docs in Claude Code?

Run `npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a claude-code`. Or copy the skill folder (plugins/swift-engineering/skills/generating-swift-package-docs in johnrogers/claude-swift-engineering) into .claude/skills/generating-swift-package-docs in your project. Claude Code loads it when a task matches its description.

How do I install Generating Swift Package Docs in Codex?

Run `npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a codex`. Or copy the skill folder (plugins/swift-engineering/skills/generating-swift-package-docs in johnrogers/claude-swift-engineering) into .agents/skills/generating-swift-package-docs in your project. Codex loads it when a task matches its description.

Can I use Generating Swift Package Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/generating-swift-package-docs, .gemini/skills/generating-swift-package-docs, .github/skills/generating-swift-package-docs and .opencode/skills/generating-swift-package-docs in your project.

What does Generating Swift Package Docs need to run?

Going by SKILL.md and its folder, Generating Swift Package Docs needs Python for the scripts in its folder. Our summary lists: Python 3.

Does Generating Swift Package Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Generating Swift Package Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Generating Swift Package Docs use?

Generating Swift Package Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Generating Swift Package Docs use?

About 272 tokens (SKILL.md is roughly 1.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Generating Swift Package Docs?

Skills that share tags, products or a category with Generating Swift Package Docs: Swift DocC Documentation (adamayoung/TMDb, 178 stars), Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars) and Get API Docs with chub (andrewyng/context-hub, 14k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Generating Swift Package Docs?

johnrogers (a GitHub user) maintains it in johnrogers/claude-swift-engineering, which has 231 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on January 18, 2026.

Source: johnrogers/claude-swift-engineering on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.