rc-codemap

Generates and incrementally refreshes per-directory codemap.md files summarizing repository structure.

19|1|Updated Jun 27, 2026
One-click install
npx skills add https://github.com/rodolfochicone/rc-project --skill rc-codemap-rodolfochicone
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rc-codemap
Source: https://github.com/rodolfochicone/rc-project/tree/main/skills/promoted/rc-codemap
Command: npx skills add https://github.com/rodolfochicone/rc-project --skill rc-codemap-rodolfochicone

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Exploring a large repository repeatedly burns context because every session re-derives the same structural understanding from raw source files. This Skill maintains a hierarchy of per-directory codemap.md files so exploration-heavy tasks start from a written summary instead of re-scanning code. ## Core Features & Use Cases - Incremental regeneration: A shell script compares the current git state against a recorded baseline SHA and lists only the directories that changed, so rebuilds touch only stale maps. - Hierarchical maps: Each significant directory gets its own codemap.md describing its responsibility, key files, patterns, and connections, with a root codemap.md linking them all. - Fail-open staleness detection: On any git problem the script reports everything as stale, guaranteeing a safe full rebuild instead of silently skipping updates. - Use Case: Before refactoring a module in an unfamiliar monorepo, read the relevant codemap.md files to understand directory roles and wiring in under a minute, falling back to grep only for details the maps do not cover. ## Quick Start Ask the agent to build codemaps for this repository so future exploration tasks start from the generated directory summaries.

Frequently Asked Questions about rc-codemap

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a codebase map for a large repository?▼

Run the stale.sh script to find directories needing maps, then summarize each directory's responsibility, key files, and patterns into a codemap.md file. A root codemap.md links all directory maps, and the script records the current HEAD so future runs only rebuild what changed.

How does incremental codemap regeneration work with git?▼

The script stores the git SHA of the last generation in .rc/codemap/last-commit and diffs committed, staged, unstaged, and untracked changes against it. Only directories containing changed files are regenerated, keeping rebuilds cheap on large repos.

Does codemap generation work outside a git repository?▼

Yes, the staleness script fails open: without git it reports every directory as stale, triggering a full build. The --record step becomes a no-op since there is no commit SHA to store as a baseline.

When should I not use a codemap for code exploration?▼

Do not use codemaps to trace a single bug, since that requires reading actual code paths rather than structural summaries. Also skip mapping vendored dependencies, build output, fixtures, and generated code, as those maps would never be trusted.

What should a good codemap.md file contain?▼

Each map should state the directory's responsibility, its key files and their roles, notable patterns, and how it connects to sibling directories, anchored to real paths. Keep it short enough to grasp in under a minute and never paste large code blocks.