Quick Start

Get up and running with CodeBroker in less than 2 minutes. This guide will take you from an unindexed repository to running your first intelligent context query.

Prerequisites

Make sure you have already installed the CodeBroker CLI. If not, head over to the Installation guide.

Initialize Repository

Navigate to your project folder and initialize the CodeBroker configuration. This creates a `.codebroker.json` file in your root directory.

codebroker init

✓ Initialized CodeBroker configuration in .codebroker.json

Build Graph

Run the index command to parse your repository and build the deterministic semantic graph.

codebroker index

[1/4] Parsing files... (1,245 files) [2/4] Extracting semantic relationships... [3/4] Building relationship graph... [4/4] Generating vector embeddings... ✓ Graph built successfully in 1.4s

Validate

Ensure your graph was built correctly and check the indexing stats.

codebroker validate

Graph Integrity: 100% Nodes: 3,412 Edges: 12,844 Entrypoints: 29 Status: Ready for queries

Query

You can now instantly query your codebase for perfect context capsules.

codebroker query "authentication"

Found 3 relevant entrypoints and 14 related symbols. Generated context capsule 'auth_context.md' (3.2k tokens)

Launch MCP Server

Start the Model Context Protocol (MCP) server to allow AI tools like Cursor or Claude to query your graph directly.

codebroker mcp

Starting CodeBroker MCP Server... Listening on stdio Available tools: - generate_context_capsule - impact_analysis - architectural_hotspots - search_codebase

You're all set!

You have successfully indexed your repository and learned the basic commands. Head over to the Core Concepts to dive deeper into how the Semantic Graph works.