3.5 KiB
3.5 KiB
name, description, argument-hint, allowed-tools, requires
| name | description | argument-hint | allowed-tools | requires | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| gsd:map-codebase | Analyze codebase with parallel mapper agents to produce .planning/codebase/ documents | [--fast [--focus tech|arch|quality|concerns]] [--query <term>|status|diff|refresh] [area] |
|
|
Each mapper agent explores a focus area and writes documents directly to .planning/codebase/. The orchestrator only receives confirmations, keeping context usage minimal.
Output: .planning/codebase/ folder with 7 structured documents about the codebase state.
<execution_context> @~/.claude/gsd-core/workflows/map-codebase.md </execution_context>
- **--fast**: Lightweight scan mode — spawns one mapper agent instead of four. Accepts an optional `--focus` value: `tech`, `arch`, `quality`, `concerns`, or `tech+arch` (default). Faster and lower-context than the full map. - **--query**: Codebase intelligence query mode. Sub-commands: `query `, `status`, `diff`, `refresh`. Requires intel to be enabled in config (`intel.enabled: true`). Runs inline for query/status/diff; spawns an agent for refresh. - **(no flag)**: Full parallel map — spawns 4 mapper agents to produce all 7 codebase documents. Arguments: $ARGUMENTSParse the first token of $ARGUMENTS:
- If it is
--fast: strip the flag, run the scan workflow (passing remaining args including optional --focus). - If it is
--query: strip the flag, run the intel workflow (passing remaining args as the subcommand). - Otherwise: pass all of $ARGUMENTS as focus area to the map-codebase workflow.
Load project state if exists: Check for .planning/STATE.md - loads context if project already initialized
This command can run:
- Via /gsd:onboard for first-time brownfield setup - creates codebase map first
- After /gsd:new-project (greenfield codebases) - updates codebase map as code evolves
- Anytime to refresh codebase understanding
<when_to_use> Use map-codebase for:
- Brownfield projects before initialization (understand existing code first)
- Refreshing codebase map after significant changes
- Refreshing or deepening an onboarded codebase map
- Before major refactoring (understand current state)
- When STATE.md references outdated codebase info
Skip map-codebase for:
- Greenfield projects with no code yet (nothing to map)
- Trivial codebases (<5 files) </when_to_use>
<success_criteria>
- .planning/codebase/ directory created
- All 7 codebase documents written by mapper agents
- Documents follow template structure
- Parallel agents completed without errors
- User knows next steps </success_criteria>