cartographer
Maps and documents the codebase. Generates `docs/CODEBASE_MAP.md` with architecture diagrams, module relationships, and data flow. Use when the user asks to "map the code", "explain the architecture", or "update documentation".
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Cartographer
Purpose
To create a living document (docs/CODEBASE_MAP.md) that serves as the architectural "Source of Truth" for the project.
Workflow
Phase 1: Reconnaissance
-
Tree Scan: Execute a file listing command (e.g.,
find . -maxdepth 2 -not -path '*/.*') to visualize the high-level structure. -
Config Check: Read
package.jsonandtsconfig.jsonto identify the stack.
Phase 2: Iterative Analysis
Exclusion Protocol: You must strictly ignore:
- Folders in
.gitignore(specificallynode_modules/,.next/,dist/,build/). - Lock files (
package-lock.json,yarn.lock). - Public assets (
public/images/).
Loop: For each relevant major directory (e.g., app/, lib/, components/):
- Read the entry point files.
- Apply the Inspection Rubric (
references/inspection-rubric.md). - Store findings in memory.
Phase 3: Synthesis
Create or Overwrite docs/CODEBASE_MAP.md using the strict template in references/map-template.md.
Critical Constraints
- Mermaid Diagrams: You MUST generate a Mermaid graph for the high-level architecture.
- No Fluff: Do not summarize code line-by-line. Focus on intent.
- Linkage: Every mention of a file in the map must be a clickable relative link.
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!