About analyze-codebase
A codebase-analysis skill for developers who need onboarding, architecture documentation, or project health reviews. It guides discovery through recommendations and writes a structured report to `.agents/memory/codebase-analysis.md`.
Key features
- 01Project structure and file counts
- 02Module, entry point, and API mapping
- 03Pattern, security, and dependency review
- 04Structured analysis report
- 05Quick analysis mode
Use cases
- 01Onboarding developers to a codebase
- 02Documenting project architecture
- 03Assessing project health before refactoring
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ shipshitdev/ skills --skill analyze-codebaseAfter installing, type/analyze-codebasein Claude Code to confirm it loaded.
Bundled filesplugin.json
Details
From the project READMEAnalyze Codebase
When to Use
- Onboarding new developers
- Architecture documentation
- Project health assessment
- Before major refactoring
- Understanding system complexity
Analysis Process
Step 1: Discovery
# Project structure
tree -L 3 -I 'node_modules|.next|dist|build|coverage'
# File counts
find . -type f -name "*.ts" | wc -l
find . -type f -name "*.tsx" | wc -l
Step 2: Architecture Analysis
- Identify modules, entry points, API structure
- Map frontend components and routing
- Document service patterns and conventions
Step 3: Patterns and Standards
- Check for established patterns in docs/examples
- Analyze type system organization
- Review security patterns (auth, multi-tenancy, soft delete)
Step 4: Dependencies
- Catalog external services and libraries
- Check version currency
- Identify critical dependencies
Step 5: Generate Report
Write to .agents/memory/codebase-analysis.md with these sections:
- Executive Summary — 3-5 sentence overview
- Project Overview — Tech stack, purpose, architecture style
- Directory Structure — Module layout and organization
- Architecture Patterns — Backend and frontend patterns
- Security Analysis — Auth, data isolation, validation
- Performance Insights — Database, caching, background jobs
- Code Quality — Strengths, improvements, tech debt
- Dependencies — Critical packages and version matrix
- Testing Strategy — Coverage, patterns, gaps
- Recommendations — Immediate, short-term, long-term
Quick Mode
For faster analysis (skip detailed metrics):
tree -L 3 -I 'node_modules|.next|dist'
echo "TypeScript: $(find . -name '*.ts' -o -name '*.tsx' | wc -l)"
echo "Controllers: $(find . -name '*.controller.ts' | wc -l)"
echo "Services: $(find . -name '*.service.ts' | wc -l)"
Comments
Markdown supported