Installation
Get started with CodeMap - installation and setup guide
Installing CodeMap
CodeMap is a zero-configuration tool designed for AI agents to understand, navigate, and modify codebases with deep contextual awareness.
Requirements
- Node.js: 18.0.0 or higher
- Package Manager: npm, yarn, or pnpm
Installation
Install CodeMap in your project:
npm install @egentica/codemapThat's it! CodeMap includes all language parsers bundled:
- ✅ TypeScript/JavaScript (
.ts,.tsx,.js,.jsx) - ✅ Vue (
.vuesingle-file components) - ✅ PHP (
.php- supports PHP 5.2 through 8.x)
Quick Verification
Test your installation:
# Scan your project
npx codemap scan
# Show project statistics
npx codemap statsProject Setup
For optimal performance, create a .codemap directory in your project root:
mkdir .codemapThis enables:
- Graph caching (10-50x faster operations)
- Session tracking (AI agent continuity)
- Labels & groups (semantic organization)
- Audit rules (architecture validation)
What's Included
CodeMap v0.2.x includes:
- 🚀 Zero Configuration - Works out of the box
- 🔍 Deep Code Understanding - AST-based parsing
- 🤖 AI-First Design - Built for AI agents
- 🏷️ Labels & Groups - Semantic organization
- 📋 Session Tracking - Conversation continuity
- 🛡️ Audit System - Architecture validation
- ⚡ Macro System - Shell command automation
- 🔌 MCP Server - Model Context Protocol support