skills.rest
erikstmartin
erikstmartinCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

cartography

Map repositories to codemaps and architecture documentation with per-folder templates.

16|9|Updated Nov 6, 2013
Search Tags:#automation#architecture#codebase#repository#map#codemap#explorer
One-click install
npx skills add https://github.com/erikstmartin/dotfiles --skill cartography-erikstmartin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cartography
Source: https://github.com/erikstmartin/dotfiles/tree/main/skills/global/.agents/skills/cartography
Command: npx skills add https://github.com/erikstmartin/dotfiles --skill cartography-erikstmartin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Repositories are hard to understand at a glance; Cartography provides a structured approach to map codebases, generate codemaps, and document architecture for explorers.

Core Features & Use Cases

  • Initialize and maintain a slim state file (.slim/cartography.json) that captures file and folder hashes to detect changes.
  • Generate empty codemap.md templates for each relevant folder to capture Responsibility, Design, Flow, and Integration points.
  • Delegate per-folder exploration tasks to agents to populate codemaps and build a repository atlas.
  • Use for starting unfamiliar codebases, planning refactors, and documenting software architecture.

Quick Start

Run the cartographer init command to bootstrap mapping for your repository and create initial codemap.md scaffolding.

Frequently Asked Questions about cartography

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

FAQPage Schema
How do I map an unfamiliar codebase to understand its architecture?▼

To map an unfamiliar codebase, initialize a state file and generate codemap.md templates for each folder. Agents then explore each folder to populate codemaps with Responsibility, Design, Flow, and Integration points, building a repository atlas.

What's the best way to document software structure across multi-folder projects?▼

Document multi-folder projects by generating per-folder codemap.md templates and delegating exploration to agents. This creates a repository atlas capturing each folder's Responsibility, Design, Flow, and Integration points.

Can I track changes in my repository architecture over time?▼

Track repository architecture changes using a .slim/cartography.json state file that captures file and folder hashes to detect changes, allowing you to maintain and update codemaps as the codebase evolves.

How do I plan a refactor for a complex repository?▼

Plan a repository refactor by generating codemaps documenting each folder's Responsibility, Design, Flow, and Integration points. This structured architecture documentation identifies dependencies and impact areas before changes.

Can I exclude specific folders when generating a codemap?▼

Exclude specific folders when generating a codemap using include and exclude patterns, focusing mapping and exploration agents only on relevant directories within your codebase.

Related Skills

Explore More Software Engineering Skills→
IndianBoy42IndianBoy42

cartography

Generate hierarchical codemaps and track repository state in .slim/cartography.json.

Community
Intermediate
SaintForeSaintFore

cartography

Map repository files and generate hierarchical codemap.md templates with change tracking.

Community
Intermediate
hadenlabshadenlabs
1

cartography

Map code repositories by computing file hashes and generating per-folder codemaps.

Official
Advanced
EremesNGEremesNG
1

cartography

Hash files and generate per-folder codemaps to detect repository changes.

Community
Advanced