# Codebase Map Index

> Use this when mapping an unfamiliar repository, creating or updating a project index, or explaining how major modules connect.

- Skill: `yankieldbc2/codebase-map-index` (Agent Skill, multi-file: 5 files)
- Install (CLI): `npx skillmds@latest add yankieldbc2/codebase-map-index`
- Raw SKILL.md: https://api.skillmd.com/api/skills/yankieldbc2/codebase-map-index/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: YankielDBC2 (https://skillmd.com/u/yankieldbc2)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/yankieldbc2/codebase-map-index

---


# 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

1. Identify frameworks, languages, and package managers.
2. Locate app entry points and routing boundaries.
3. Map major folders by responsibility.
4. Identify data flow, API boundaries, and persistence boundaries.
5. Record validation commands and local run commands.
6. Note risky or unclear areas.
7. Create or update `PROJECT_INDEX.md` if 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.