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 cranot.github.io/roam-code.

Install the CLI Reference 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, run roam reindex (incremental, near-instant).

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. Windsurf MCP setup for Codeium Windsurf.

Or run roam skill-generate --target claude to emit a SKILL.md directly from the live capability registry.

Reference docs The full command reference + architecture guide + integration tutorials live at cranot.github.io/roam-code. This page is just the install + integration starter.

README Quick overview at github.com/Cranot/roam-code. Surface counts, install snippet, sample commands.

Browse the source 194 commands live in src/roam/commands/. Each one is a single file. Apache 2.0.

Need help? Open an issue or discussion on GitHub, or email [email protected].