Documentation

Everything you need to run Roam in 5 minutes.

Getting started, command reference, architecture, integration guides. Or jump straight to pip install roam-code and find your way.

Open the full docs GitHub

Start here

Getting started Install, index your first repo, run the five core commands. Command reference All 190 commands, with examples and JSON schemas. Architecture How the index, graph, and MCP server fit together.

Integration guides

Roam works with every major AI coding tool. Pick yours.

Claude Code MCP server setup + roam-as-skill. Cursor MCP config + Cursor rules generation. Codex CLI MCP server setup for OpenAI Codex CLI. Gemini CLI MCP server setup for Google Gemini CLI. Amp MCP server setup for Amp (Sourcegraph). Windsurf MCP server setup for Codeium Windsurf.

Open the GitHub Pages site Full documentation tree at cranot.github.io/roam-code. The page you're on is a starting menu.

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

Browse the source 190 commands live in src/roam/commands/. Each command is one file. Apache 2.0.

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