Setup
Install Roam. Equip your coding agent.
Give your agent a local map of the code and static checks it can use before and after edits. Install the tools, index your project, then follow your agent’s connection guide. Full reference docs live at roam-code.com/docs.
1. Install the tools and index your project
Python 3.10+ and a Git repository. Works on Linux, macOS, and Windows. Free and open source under Apache 2.0.
pip install "roam-code[mcp]" && roam init
Run this inside your project. roam init builds the local
index in .roam/ and creates project configuration. First-run
time depends on the repository, its history, and your machine. After
changes, refresh with roam index; later runs reuse the index
and process changed files. If your agent only uses shell commands,
pip install roam-code is enough for the CLI.
Discover everything: roam --help-all (287 commands
grouped by what an agent asks) or roam tour (guided
walk through the five core verbs). Full reference at
/docs/command-reference.
2. Connect your agent and add the workflow
MCP lets coding agents use Roam as a tool. Pick your agent’s guide below, connect the server, and include Roam checks in its project instructions. A connection makes tools available; it does not guarantee the agent uses them.
Claude Code
MCP server config + roam-as-skill setup.
Cursor
MCP config + Cursor rule generation.
Codex CLI
MCP setup for OpenAI Codex CLI.
Gemini CLI
MCP setup for Google Gemini CLI.
Amp
MCP setup for Sourcegraph Amp.
All 5 platforms
Full integration matrix + cross-platform checklist.
Ask your agent to use Roam to find relevant code, check likely impact
before editing, and review the patch afterward. It should still run
tests and report missing or incomplete checks, not just successful ones.
Or run roam skill-generate --target claude to emit a SKILL.md
directly from the live capability registry.
src/roam/commands/, registered in cli.py. Apache 2.0.