codemap
Generate comprehensive hierarchical codemaps for UNFAMILIAR repositories. Expensive operation - only use when explicitly asked for codebase documentation or initial repository mapping
Best for New team membersWorks with GitHub
⌘source
- author
@alvinunreal- language
- TypeScript
★3.2kstars
237forks
Apr 21, 2026
✦overview.md
Key Features
- ·Generates hierarchical codemaps for unfamiliar repositories
- ·Checks for existing state files to avoid redundant operations
- ·Excludes tests, documentation, and build artifacts from maps
- ·Respects .gitignore patterns
Use Cases
- →Starting work on an unfamiliar codebase
- →Creating initial documentation for a repository
- →Mapping repository structure for onboarding
Best for
- ✓New team members
- ✓Repository documentation projects
Not ideal for
- !Familiar repositories
- !One-time repository checks
FAQs
name
codemap
description
Generate comprehensive hierarchical codemaps for UNFAMILIAR repositories. Expensive operation - only use when explicitly asked for codebase documentation or initial repository mapping
Codemap Skill
You help users understand and map repositories by creating hierarchical codemaps.
When to Use
- User asks to understand/map a repository
- User wants codebase documentation
- Starting work on an unfamiliar codebase
Workflow
Step 1: Check for Existing State
First, check if .slim/codemap.json exists in the repo root.
If it does not exist, check for legacy state at .slim/cartography.json.
If legacy state exists: move .slim/cartography.json to .slim/codemap.json, then continue with change detection.
If .slim/codemap.json exists: Skip to Step 3 (Detect Changes) - no need to re-initialize.
If neither file exists: Continue to Step 2 (Initialize).
Step 2: Initialize (Only if no state exists)
- Analyze the repository structure - List files, understand directories
- Infer patterns for core code/config files ONLY to include:
- Include:
src/**/*.ts,package.json, etc. - Exclude (MANDATORY): Do NOT include tests, documentation, or translations.
- Tests:
**/*.test.ts,**/*.spec.ts,tests/**,__tests__/** - Docs:
docs/**,*.md(except rootREADME.mdif needed),LICENSE
- Tests:
- Include:
$install
1-click copynpx skills add alvinunreal/oh-my-opencode-slim --skill codemapSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
4/ 5
very goodClear and well structured, with only minor parts that might need a second read.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
4/ 5
highMostly actionable with clear steps; only a few small gaps remain.