| name | repo-architecture-reader |
| description | Quickly understand and document a repository's architecture, structure, and design patterns |
| license | MIT |
Repository Architecture Reader
When to Use
- Starting work on a new repository
- Analyzing codebase for the first time
- Creating architecture documentation
- Planning major refactoring
Steps
1. Initial Exploration
- Identify the project type (web app, library, CLI, etc.)
- Locate configuration files (package.json, tsconfig.json, etc.)
- Identify the main entry point(s)
- Map the top-level directory structure
2. Dependency Analysis
- Parse package.json / requirements.txt / Cargo.toml
- Categorize dependencies (production, dev, peer)
- Identify the tech stack (framework, build tools, testing)
3. Code Organization
- Identify source code directories
- Map module structure (core, shared, domain-specific)
- Identify architectural patterns (MVC, layered, microservices)
4. Data Flow Analysis
- Trace main data flows
- Identify state management
- Map API boundaries
5. Testing Structure
- Locate test files
- Identify test types (unit, integration, E2E)
- Document test utilities
Output Format
# Repository Architecture: [Project Name]
## Overview
[Brief description]
## Tech Stack
- **Language**: [Primary language]
- **Framework**: [Main framework]
- **Build Tool**: [Build tool]
- **Testing**: [Testing framework]
## Directory Structure
[Directory tree]
## Key Modules
### [Module Name]
- **Purpose**: [What this module does]
- **Dependencies**: [What it depends on]
- **Key Files**: [Important files]