What problem does it solve?
Codebase-archaeology helps you stop guessing and instead build a dependable understanding of an unfamiliar codebase by following a documentation-first, entry-point-to-data-flow approach that produces an architecture-level mental model.
Core Features & Use Cases
- Documentation-first orientation: Starts with AGENTS.md and README.md to capture intended architecture, constraints, and conventions before opening source files.
- Systematic entry-point mapping: Locates main modules and operational entry points (CLI mains, HTTP routes, etc.) to anchor exploration in the real execution path.
- Data flow and integration tracing: Uses targeted searches to connect input handling to core types to configuration, external integrations, and test infrastructure.
- Output-ready architecture synthesis: Produces a reusable summary you can apply to onboarding, feature work, or debugging without rereading everything later.
Quick Start
Ask the AI: Explore the Nightstream repository to produce a comprehensive technical architecture summary by reading AGENTS.md and README.md first, then tracing entry points and key data flow through the src directory.