Skip to content

llms-install.md

Latest commit

 

History

History
74 lines (55 loc) · 1.41 KB

llms-install.md

File metadata and controls

74 lines (55 loc) · 1.41 KB

Installing roam-code

roam-code provides instant codebase comprehension for AI coding agents. 50 commands, 16 languages, 100% local, zero API keys.

Quick install

pip install roam-code

Or with isolated environments:

pipx install roam-code
# or
uv tool install roam-code

Verify installation

roam --version

First-time setup (in a project)

cd /path/to/your/project
roam init        # index + generate agent instructions

This creates .roam/index.db (the codebase graph) and writes a CLAUDE.md with roam-aware agent instructions.

MCP server setup

Claude Code

claude mcp add roam-code -- roam mcp

Claude Desktop / Cursor / VS Code

Add to your MCP config:

{
  "mcpServers": {
    "roam-code": {
      "command": "roam",
      "args": ["mcp"]
    }
  }
}

Requirements

  • Python 3.9+
  • No native dependencies (pure Python + bundled tree-sitter grammars)
  • Works on Linux, macOS, Windows
  • No API keys, no accounts, no telemetry

Key commands for agents

Command Purpose
roam understand Full codebase briefing
roam search <pattern> Find symbols by name
roam preflight <symbol> Pre-change safety check (blast radius + tests + fitness)
roam context <symbol> Files and line ranges to read
roam diff Blast radius of uncommitted changes

Run roam --help for all 48 commands.