codebase-summary
Analyze a codebase and generate comprehensive documentation including architecture, components, interfaces, workflows, and dependencies. Creates an AI-optimized knowledge base (index.md) and can consolidate into AGENTS.md, README.md, or CONTRIBUTING.md. Use when the user wants to document a codebase, create AGENTS.md, understand system architecture, generate developer documentation, or asks to "summarize the codebase".
Installation
SKILL.md
Generate comprehensive codebase documentation optimized for AI assistants and developers.
| codebasepath | Current directory | Path to analyze | | outputdir | .sop/summary | Documentation output directory | | consolidate | false | Create consolidated file at codebase root | | consolidatetarget | AGENTS.md | Target: AGENTS.md, README.md, or CONTRIBUTING.md | | checkconsistency | true | Check for cross-document inconsistencies |
| checkcompleteness | true | Identify documentation gaps | | updatemode | false | Update existing docs based on git changes |
Analyze a codebase and generate comprehensive documentation including architecture, components, interfaces, workflows, and dependencies. Creates an AI-optimized knowledge base (index.md) and can consolidate into AGENTS.md, README.md, or CONTRIBUTING.md. Use when the user wants to document a codebase, create AGENTS.md, understand system architecture, generate developer documentation, or asks to "summarize the codebase". Source: m31uk3/ai-skills.
Facts (cite-ready)
Stable fields and commands for AI/search citations.
- Install command
npx skills add https://github.com/m31uk3/ai-skills --skill codebase-summary- Source
- m31uk3/ai-skills
- Category
- ""Writing
- Verified
- —
- First Seen
- 2026-02-01
- Updated
- 2026-02-18
Quick answers
What is codebase-summary?
Analyze a codebase and generate comprehensive documentation including architecture, components, interfaces, workflows, and dependencies. Creates an AI-optimized knowledge base (index.md) and can consolidate into AGENTS.md, README.md, or CONTRIBUTING.md. Use when the user wants to document a codebase, create AGENTS.md, understand system architecture, generate developer documentation, or asks to "summarize the codebase". Source: m31uk3/ai-skills.
How do I install codebase-summary?
Open your terminal or command line tool (Terminal, iTerm, Windows Terminal, etc.) Copy and run this command: npx skills add https://github.com/m31uk3/ai-skills --skill codebase-summary Once installed, the skill will be automatically configured in your AI coding environment and ready to use in Claude Code or Cursor
Where is the source repository?
https://github.com/m31uk3/ai-skills
Details
- Category
- ""Writing
- Source
- user
- First Seen
- 2026-02-01