Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
121 lines (79 loc) · 2.19 KB

GETTING_STARTED.md

File metadata and controls

121 lines (79 loc) · 2.19 KB

Getting Started with CCM

New to CCM? This guide gets you running in 5 minutes.

What is CCM?

Cognitive Codebase Matrix (CCM) is an intelligent bridge between your codebase and AI assistants:

  • 🔍 Semantic Search - Find code by meaning, not just keywords
  • 🧠 Graph Navigation - Understand code relationships
  • 📍 Smart Context - Get relevant code at your cursor position

Quick Start

Step 1: Install

Option A: For AI Editors (Claude Desktop, Antigravity, Cursor)

npx @senoldogann/context-manager install

Option B: For CLI Development

cargo build --release
./target/release/ccm-cli --help

Step 2: Configure

Ensure Ollama is running:

ollama serve
ollama pull mxbai-embed-large

Optional production settings (recommended for server use):

# Restrict MCP access to allowed roots
CCM_ALLOWED_ROOTS=/Users/you/projects:/Users/you/sandbox
CCM_REQUIRE_ALLOWED_ROOTS=1

# Include data files in semantic search
CCM_EMBED_DATA_FILES=0

Step 3: Index Your Project

npx @senoldogann/context-manager index --path .

Usage

CLI Examples

# Search for code
ccm-cli query --text "dependency injection"

# Find context at specific location
ccm-cli query --text "src/main.rs:42"

# Auto-reindex on changes
ccm-cli index --path . --watch

AI Conversation Examples

Once configured as MCP server:

"Search for the user authentication flow."

"Read the graph for PaymentService and show me all callers."

"What does the parseConfig function do?"

Project Structure

context-manager/
├── core/       # Rust engine (Vector DB + Graph)
├── mcp/        # MCP Server implementation
├── cli/        # Command-line interface
├── npm/        # Node.js wrapper for distribution
└── eval/       # Evaluation framework & golden tasks

Development

# Build
cargo build --release

# Test
cargo test

# Lint
cargo fmt && cargo clippy

Learn More