codebase-summary
OfficialTurn codebases into structured, readable docs.
System Documentation
What problem does it solve?
The SOP analyzes a codebase and generates comprehensive documentation including structured metadata files that describe the system architecture, components, interfaces, and workflows. It can create targeted documentation files like AGENTS.md (README for AI agents), README.md, CONTRIBUTING.md, or generate a complete documentation ecosystem. The documentation is organized to make it easy for AI assistants to understand the system and help with development tasks.
Core Features & Use Cases
- Automated analysis of a codebase to produce architecture, components, interfaces, and workflows documentation.
- Generate targeted docs like AGENTS.md, README.md, CONTRIBUTING.md, or a complete documentation ecosystem.
- Supports configurable parameters such as output_dir, consolidate, consolidate_target, consolidate_prompt, check_consistency, check_completeness, update_mode, and codebase_path to control analysis and updates.
Quick Start
Use the codebase-summary tool to analyze the repository and generate documentation in the default output directory. Example: codebase-summary --codebase_path . --output_dir .sop/summary
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: codebase-summary Download link: https://github.com/Happyverse-Team/video-content-generator/archive/main.zip#codebase-summary Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.