Setup
Install once. Wire it into your editor.
30 seconds for the CLI. Another 30 seconds per editor for the MCP integration. The reference docs live separately at roam-code.com/docs.
1. Install the CLI
One command. Works on Linux, macOS, Windows. Apache 2.0.
pip install roam-code && roam init
roam init indexes the current Git repo into a SQLite file
in .roam/. A typical 100k-LOC repo finishes in seconds.
After git pull or major changes, re-run roam index
(incremental, near-instant — only changed files re-parse).
Discover everything: roam --help (241 commands
grouped by what an agent asks) or roam tour (guided
walk through the five core verbs). Full reference at
/docs/command-reference.
2. Wire it into your editor
Roam is an MCP server. Pick your editor, follow the link to its setup guide on the reference docs.
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.
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.