Quick Start

Get up and running with CodeMap in 5 minutes

Learn CodeMap basics in 5 minutes with this hands-on guide.

Step 1

Scan Your Project

Build the knowledge graph:

cd your-project
npx codemap scan

Step 2

Explore Your Code

Search for files and symbols, show dependencies, list symbols:

npx codemap search "AuthService"
npx codemap deps src/services/auth.ts
npx codemap symbols src/utils/helpers.ts

Step 3

Organize with Labels

Labels help AI agents organize code semantically:

// Create labels for your architecture
await codemap.labels.create({
  emoji: '🔐',
  name: 'Authentication',
  description: 'User authentication and authorization'
});

// Assign to files
await codemap.labels.assign('lbl_auth_123', [
  'src/services/auth.ts',
  'src/middleware/auth.ts'
]);

Step 4

Create Groups

Groups organize related files:

await codemap.groups.add({
  name: 'auth-system',
  description: 'Authentication system',
  members: ['src/services/auth.ts']
});

Step 5

Start a Session (For AI Agents)

AI agents should start sessions for tracking:

// Orient to the project
const orientation = await codemap.orient();

// Start a session
await codemap.sessions.start();

// Close with summary
await codemap.sessions.close('Implemented auth');

Scan Your Project

Explore Your Code

Organize with Labels

Create Groups

Start a Session (For AI Agents)

Next Steps