Documentation
Put Roam to work.
Connect Roam to your coding agent so it can explore code, investigate quality concerns, and check changes. Start with setup, follow a worked example, or look up the command for the question at hand.
Free and open source · Static checks run locally without model calls
Where would you like to start?
New here? Start with setup or a worked example. Already using Roam? Jump to the reference or troubleshooting. Choose the guide for the task you have now.
See a complete example
Follow a first scan through change review and a configured record of the checks. Setup time varies by project.
Get started
Install Roam, build your project's local map, and try the first checks. Start here if Roam is new to you.
Connect your agent
Find the setup steps for Claude Code, Cursor, Gemini CLI, Codex CLI, or Amp, and check that the connection works.
Use the agent tools
Understand what your agent receives, what happens on a fresh project, and how to handle slow or incomplete results.
Find a command
Browse commands by the question they answer, with options and examples. Keep this nearby when building an agent workflow.
Look under the hood
See how Roam reads files, connects symbols, stores the map, and uses it to answer questions about changes.
Build a checking habit
Give your agent a clear routine: understand the code, inspect what a change touches, and report the checks and their limits.
Choose your next check
“Where should I start?” “What could this affect?” Match common questions to the tools that help answer them.
Explore the examples
Walk through eight illustrative changes: copied code, slow loops, missing tests, and more. See what to investigate and what static checks cannot prove.
Inspect the evidence
Run small public examples and read historical comparisons, including misses, baselines, and what remains unmeasured.
Get unstuck
Work through stale maps, installation problems, connection errors, and slow results. Each section starts with a concrete check.
Need help getting started?
Tell us what you're trying to do and where you're stuck. Email [email protected] to ask about help or a walkthrough. We'll confirm availability before arranging anything.