Skip to main content

/update-codemaps Command

Analyze the codebase structure and generate token-lean architecture documentation.

Process

  1. Scan Project Structure - Identify project type, source dirs, entry points
  2. Generate Codemaps - Create/update architecture docs
  3. Diff Detection - Compare with previous codemaps
  4. Add Metadata - Freshness headers
  5. Save Analysis Report - Codemap diff summary

Generated Codemaps

Created in docs/CODEMAPS/ (or .reports/codemaps/):

Command Syntax

No arguments required.

Codemap Format

Token-lean - optimized for AI context consumption:

Metadata Header

Tips

  • Focus on high-level structure, not implementation details
  • Prefer file paths and function signatures over full code blocks
  • Keep each codemap under 1000 tokens
  • Use ASCII diagrams for data flow
  • Run after major feature additions or refactoring
  • Commands: /update-docs