Best for
- Onboard new developers to understand the codebase quickly
- Plan new features with full context of existing patterns
- Understand code conventions before making changes
jellydn/my-ai-tools/skills/codemap/SKILL.md
Map codebase structure with parallel analysis — produces 7 documents about architecture, concerns, and conventions
Decision brief
Map codebase structure with parallel analysis — produces 7 documents about architecture, concerns, and conventions
Compatibility matrix
| Platform | Status | Evidence | What to check |
|---|---|---|---|
| Codex | Declared | Source record | Install path and trigger |
| Claude Code | Not declared | No explicit evidence | Portability before use |
| Cursor | Declared | Source record | Install path and trigger |
| Gemini CLI | Not declared | No explicit evidence | Portability before use |
Installation
The source command is displayed only when detected. A safe inspection prompt is always available so your agent can explain every action before execution.
npx skills add https://github.com/jellydn/my-ai-tools --skill "skills/codemap"Inspect the Agent Skill "codemap" from https://github.com/jellydn/my-ai-tools/blob/0cf52fb7db261a8bc798395043b833909a1d68df/skills/codemap/SKILL.md at commit 0cf52fb7db261a8bc798395043b833909a1d68df. List every install step, command, network request, credential, file read/write, external action, and rollback step. Explain whether it fits my task. Do not install or execute anything until I approve.
Workflow
If .planning/codebase/ already exists, prompt:
If .planning/codebase/ already exists, prompt:
Create the output directory:
Use the Task tool with agenttype="explore" and runinbackground=true for parallel execution.
Check that all documents were created:
Permission review
The documentation asks the agent to create, modify, or delete local files.
Refresh - Delete existing and remap codebaseThe documentation asks the agent to create, modify, or delete local files.
Create the output directory:The documentation asks the agent to run terminal commands or scripts.
git add .planning/codebase/*.mdThe documentation asks the agent to run terminal commands or scripts.
git commit -m "docs: map existing codebaseEvidence record
| Signal | Value | Evidence type | Meaning |
|---|---|---|---|
| Quality score | 91/100 | Computed | Documentation, specificity, maintenance, and trust rules |
| Repository stars | 118 | Source | Repository attention, not individual Skill quality |
| Compatibility | 2 platforms | Source | Declared in the catalog source record |
| Usage guide | automated source guide | Editorial | Generated or reviewed according to the visible evidence level |
Pinned source
Analyze your entire codebase and create 7 comprehensive documentation files in .planning/codebase/:
Use this skill when you need to:
This skill orchestrates 4 parallel agents, each exploring a specific focus area:
Each agent:
$SKILL_PATH/templates/.planning/codebase/The orchestrator:
.planning/codebase/ directoryrun_in_background=trueIf .planning/codebase/ already exists, prompt:
.planning/codebase/ already exists. What's next?
1. Refresh - Delete existing and remap codebase
2. Update - Keep existing, only update specific documents
3. Skip - Use existing codebase map as-is
Create the output directory:
mkdir -p .planning/codebase
Use the Task tool with agent_type="explore" and run_in_background=true for parallel execution.
Tech Agent:
agent_type: explore
description: Map codebase tech stack
prompt: |
Focus: tech
Analyze this codebase for technology stack and external integrations.
Write these documents to .planning/codebase/:
- STACK.md - Languages, runtime, frameworks, dependencies, configuration
- INTEGRATIONS.md - External APIs, databases, auth providers, webhooks
Use the templates from map-codebase skill. Explore thoroughly.
Write documents directly. Return confirmation only.
Architecture Agent:
agent_type: explore
description: Map codebase architecture
prompt: |
Focus: arch
Analyze this codebase architecture and directory structure.
Write these documents to .planning/codebase/:
- ARCHITECTURE.md - Pattern, layers, data flow, abstractions, entry points
- STRUCTURE.md - Directory layout, key locations, naming conventions
Use the templates from map-codebase skill. Explore thoroughly.
Write documents directly. Return confirmation only.
Quality Agent:
agent_type: explore
description: Map codebase conventions
prompt: |
Focus: quality
Analyze this codebase for coding conventions and testing patterns.
Write these documents to .planning/codebase/:
- CONVENTIONS.md - Code style, naming, patterns, error handling
- TESTING.md - Framework, structure, mocking, coverage
Use the templates from map-codebase skill. Explore thoroughly.
Write documents directly. Return confirmation only.
Concerns Agent:
agent_type: explore
description: Map codebase concerns
prompt: |
Focus: concerns
Analyze this codebase for technical debt, known issues, and areas of concern.
Write this document to .planning/codebase/:
- CONCERNS.md - Tech debt, bugs, security, performance, fragile areas
Use the templates from map-codebase skill. Explore thoroughly.
Write document directly. Return confirmation only.
Check that all documents were created:
ls -la .planning/codebase/
wc -l .planning/codebase/*.md
If .planning/ is not gitignored and the user wants to commit:
git add .planning/codebase/*.md
git commit -m "docs: map existing codebase
- STACK.md - Technologies and dependencies
- ARCHITECTURE.md - System design and patterns
- STRUCTURE.md - Directory layout
- CONVENTIONS.md - Code style and patterns
- TESTING.md - Test structure
- INTEGRATIONS.md - External services
- CONCERNS.md - Technical debt and issues"
Present completion summary:
Codebase mapping complete.
Created .planning/codebase/:
- STACK.md ([N] lines) - Technologies and dependencies
- ARCHITECTURE.md ([N] lines) - System design and patterns
- STRUCTURE.md ([N] lines) - Directory layout and organization
- CONVENTIONS.md ([N] lines) - Code style and patterns
- TESTING.md ([N] lines) - Test structure and practices
- INTEGRATIONS.md ([N] lines) - External services and APIs
- CONCERNS.md ([N] lines) - Technical debt and issues
Next steps:
- Review documents: cat .planning/codebase/STACK.md
- Use these as reference when planning features
- Update as codebase evolves
Templates are located in $SKILL_PATH/templates/:
STACK.md.template - Technology stackINTEGRATIONS.md.template - External integrationsARCHITECTURE.md.template - System architectureSTRUCTURE.md.template - Directory structureCONVENTIONS.md.template - Coding conventionsTESTING.md.template - Testing patternsCONCERNS.md.template - Technical concernsEach agent reads the appropriate template and fills it in based on codebase exploration.
When spawned as a mapper agent:
Helper: Use fd if available, fall back to find
# Define finder helper (fd if available, otherwise find)
_finder() { command -v fd >/dev/null 2>&1 && fd "$@" || find "$@"; }
_rg() { command -v rg >/dev/null 2>&1 && rg "$@" || grep -r "$@"; }
Tech Focus:
# Package manifests
cat package.json pyproject.toml Cargo.toml go.mod 2>/dev/null
# Config files
ls -la *.config.* .env* tsconfig.json 2>/dev/null
# Find SDK/API imports
_rg "import.*stripe|import.*supabase|import.*aws" src/ 2>/dev/null | head -50
Architecture Focus:
# Directory structure (fd is faster and ignores node_modules/.git by default)
_finder -t d . | head -50
# Entry points
_finder -t f "index.*" "main.*" "app.*" src/ app/ 2>/dev/null | head -20
# Import patterns
_rg "^import" src/ 2>/dev/null | head -100
Quality Focus:
# Linting/formatting config
cat .eslintrc* .prettierrc* biome.json 2>/dev/null
# Test files
_finder -t f "\.test\." "\.spec\." 2>/dev/null | head -30
Concerns Focus:
# TODO/FIXME comments
_rg "TODO|FIXME|HACK|XXX" src/ 2>/dev/null | head -50
# Large files (potential complexity)
_finder -t f "\.ts$" -e "\.tsx$" src/ 2>/dev/null | xargs wc -l 2>/dev/null | sort -rn | head -20
This skill is inspired by and adapted from glittercowboy/get-shit-done, specifically their map-codebase workflow and gsd-codebase-mapper agent.
Frequently asked questions
Map codebase structure with parallel analysis — produces 7 documents about architecture, concerns, and conventions
The source record exposes this install command: npx skills add https://github.com/jellydn/my-ai-tools --skill "skills/codemap". Inspect the command and pinned source before running it.
The pinned source record declares support for: codex, cursor.
Static rules flagged write-files, exec-script in the source; the page lists the matching lines and excerpts.
Alternatives
PramodDutta/qaskills
Optimize resumes for Applicant Tracking Systems, check ATS compatibility, and analyze keyword match
PramodDutta/qaskills
Generate optimized test combinations using pairwise (all-pairs) testing algorithms to achieve maximum coverage with minimum test cases across multiple input parameters
PramodDutta/qaskills
Gate RAG pipelines in CI with versioned golden eval sets, per-metric thresholds, baseline drift detection, and a build that fails when retrieval or answer quality regresses.
upex-galaxy/agentic-qa-boilerplate
Execute regression test suites via CI/CD, analyze results, classify failures, and produce GO/NO-GO release decisions. Use when running regression, smoke, or sanity suites through GitHub Actions, monitoring workflow runs, downloading Allure or Playwright artifacts, classifying failures (REGRESSION vs FLAKY vs KNOWN vs ENVIRONMENT vs NEW TEST), computing pass-rate and trend metrics, deciding release readiness, generating executive quality reports, or creating regression issues. Triggers on: run re