skills.rest
BOHUYESHAN-APB
BOHUYESHAN-APBCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

codemap

Generate hierarchical codemaps and persistent state in .slim/codemap.json.

2|Updated Apr 30, 2026
Search Tags:#automation#codebase#migration#repository#state-management#mapping#codemap
One-click install
npx skills add https://github.com/BOHUYESHAN-APB/openagent-labforge-bio --skill codemap-bohuyeshan-apb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codemap
Source: https://github.com/BOHUYESHAN-APB/openagent-labforge-bio/tree/main/src/skills/codemap
Command: npx skills add https://github.com/BOHUYESHAN-APB/openagent-labforge-bio --skill codemap-bohuyeshan-apb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Codemap automates the process of mapping a codebase by producing a persistent codemap state and per-folder documentation, reducing manual exploration time and enabling faster onboarding.

Core Features & Use Cases

  • Initialize: scan the repository, apply include/exclude patterns, and generate .slim/codemap.json along with empty codemap.md files in discovered folders.
  • Detect changes: compare current files against the saved state to surface added, removed, or modified files and affected folders.
  • Migrate legacy: automatically migrate old cartography.json state to codemap.json for continuity.
  • Update workflow: refresh the codemap.json state after file changes to keep mappings current.

Quick Start

Run the codemap.mjs init command to scan the repository and generate the .slim/codemap.json state plus empty codemap.md files.

Frequently Asked Questions about codemap

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

FAQPage Schema
How do I generate a hierarchical codemap for an unfamiliar repository?▼

To generate a codemap for an unfamiliar repository, run the codemap.mjs init command to scan the codebase, apply include/exclude patterns, and produce a persistent .slim/codemap.json state with per-folder codemap.md files.

What is the best way to document a large codebase for onboarding?▼

Documenting a large codebase for onboarding is best achieved by generating hierarchical codemaps and a persistent state file, which automates repository exploration and reduces manual mapping time for new team members.

How do I detect added, removed, or modified files in a codebase mapping state?▼

To detect added, removed, or modified files in a codebase mapping state, compare current files against the saved .slim/codemap.json state to surface changes and identify affected folders.

Does codemap support incremental updates and legacy state migration?▼

Codemap supports incremental updates by refreshing the .slim/codemap.json state after file changes, and it automatically migrates legacy cartography.json state to codemap.json for continuity.

Can I exclude specific files or folders when mapping an unfamiliar codebase?▼

Yes, you can exclude specific files or folders when mapping an unfamiliar codebase by applying include/exclude patterns during the initialization scan to control what gets mapped and documented.

What are the limitations of using scripts for repository exploration and documentation?▼

Using scripts for repository exploration requires deterministic execution via scripts/codemap.mjs and relies on maintaining a persistent .slim/codemap.json state, meaning manual intervention is needed if state synchronization fails.

Related Skills

Explore More Software Engineering Skills→
erikstmartinerikstmartin
16

cartography

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

Community
Intermediate
thistleknotthistleknot

codemap

Generates hierarchical codemap directories from user-defined file selection rules.

Community
Intermediate
forgefabrikforgefabrik

codemap

Generate hierarchical repository codemaps with hash-based change detection.

Community
Advanced
richardmbaileyrichardmbailey

rb-explain-codebase

Analyze repository structure, control flow, and dependency graphs.

Community
Intermediate