Codebase Map Index
Goal
Create a useful map of a repository without reading every file unnecessarily.
When to use
Use for onboarding, architecture discovery, project indexing, module mapping, and planning future changes.
When not to use
Do not use when the user asks for a small targeted code change and the relevant files are obvious.
Inputs
Inspect README, package manifests, routing entry points, app entry points, config files, major folders, and existing docs.
Workflow
- Identify frameworks, languages, and package managers.
- Locate app entry points and routing boundaries.
- Map major folders by responsibility.
- Identify data flow, API boundaries, and persistence boundaries.
- Record validation commands and local run commands.
- Note risky or unclear areas.
- Create or update
PROJECT_INDEX.mdif requested.
Quality bar
A good map helps a future agent make targeted changes without scanning the entire repo.
Validation
Run lightweight commands such as package scripts listing, tests, typecheck, or build only when useful and safe.
Final response
Report the map, important files, commands discovered, and recommended next inspection targets.