<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <title>Setup — Roam · Install + wire into your AI editor</title>
  <meta name="description" content="Install roam-code in 30 seconds. Wire it into Claude Code, Cursor, Codex, Gemini, or any MCP-aware editor. Reference docs at roam-code.com/docs.">
  <link rel="canonical" href="https://roam-code.com/setup">
  <link rel="icon" type="image/svg+xml" href="/favicon.svg">
  <meta name="theme-color" content="#0049b7">
  <meta name="apple-mobile-web-app-title" content="Roam">
  <link rel="apple-touch-icon" href="/favicon.svg">
  <link rel="manifest" href="/manifest.webmanifest">
  <link rel="preload" href="/fonts/space-grotesk-variable.woff2" as="font" type="font/woff2" crossorigin>
  <link rel="preconnect" href="//github.com" crossorigin>
  <link rel="preconnect" href="//pypi.org" crossorigin>
  <link rel="preload" href="./landing.css" as="style">
  <link rel="stylesheet" href="./landing.css">
  <meta name="robots" content="index,follow">
  <meta property="og:title" content="Setup — Roam">
  <meta property="og:description" content="Install in 30 seconds. Wire into Claude Code, Cursor, Codex, and any MCP-aware editor.">
  <meta property="og:url" content="https://roam-code.com/setup">
  <meta property="og:image" content="https://roam-code.com/og.png">
  <meta name="twitter:card" content="summary_large_image">
  <meta name="twitter:image" content="https://roam-code.com/og.png">

  <script type="application/ld+json">
  {
    "@context": "https://schema.org",
    "@type": "BreadcrumbList",
    "itemListElement": [
      {"@type": "ListItem", "position": 1, "name": "Home", "item": "https://roam-code.com/"},
      {"@type": "ListItem", "position": 2, "name": "Setup", "item": "https://roam-code.com/setup"}
    ]
  }
  </script>
</head>
<body>

  <a class="skip-link" href="#main">Skip to content</a>

  <nav class="site-nav" aria-label="Main navigation">
    <div class="nav-inner">
      <a href="/" class="site-logo">roam<span class="logo-dot">.</span></a>
      <input type="checkbox" id="nav-toggle" class="nav-toggle-checkbox" aria-label="Toggle navigation menu">
      <label for="nav-toggle" class="nav-toggle-label">
        <span class="nav-burger" aria-hidden="true"></span>
        <span class="visually-hidden">Menu</span>
      </label>
      <ul class="nav-links">
        <li><a href="/">Home</a></li>
        <li><a href="/pricing">Pricing</a></li>
        <li><a href="/compare">Compare</a></li>
        <li><a href="/setup" aria-current="page">Setup</a></li>
        <li><a href="/docs/">Docs</a></li>
        <li><a href="https://github.com/Cranot/roam-code">GitHub</a></li>
      </ul>
    </div>
  </nav>

  <main id="main">

  <header class="hero">
    <div class="hero-inner">
      <p class="eyebrow">Setup</p>
      <h1 class="hero-headline">
        <strong>Install once. Wire it into your editor.</strong>
      </h1>
      <p class="hero-subhead">
        30 seconds for the CLI. Another 30 seconds per editor for the MCP integration.
        The reference docs live separately at
        <a href="/docs/">roam-code.com/docs</a>.
      </p>
      <div class="hero-ctas">
        <a class="btn-primary" href="#install-cli">Install the CLI</a>
        <a class="btn-secondary" href="/docs/">Reference docs</a>
      </div>
    </div>
  </header>

  <section class="whats-in" id="install-cli">
    <div class="whats-in-inner">
      <h2>1. Install the CLI</h2>
      <p class="lede">
        One command. Works on Linux, macOS, Windows. Apache 2.0.
      </p>
      <p class="install-cmd">
        <code>pip install roam-code &amp;&amp; roam init</code>
      </p>
      <p class="install-note">
        <code>roam init</code> indexes the current Git repo into a SQLite file
        in <code>.roam/</code>. A typical 100k-LOC repo finishes in seconds.
        After <code>git pull</code> or major changes, re-run <code>roam index</code>
        (incremental, near-instant — only changed files re-parse).
      </p>
      <p class="install-note">
        Discover everything: <code>roam --help</code> (267 commands
        grouped by what an agent asks) or <code>roam tour</code> (guided
        walk through the five core verbs). Full reference at
        <a href="/docs/command-reference">/docs/command-reference</a>.
      </p>
    </div>
  </section>

  <section class="how-it-works" id="install-mcp">
    <div class="how-it-works-inner">
      <h2>2. Wire it into your editor</h2>
      <p class="lede">
        Roam is an MCP server. Pick your editor, follow the link to its setup
        guide on the reference docs.
      </p>
      <div class="setup-editor-grid">
        <a class="verb-cell" href="/docs/integration-tutorials#claude-code">
          <code>Claude Code</code>
          <span>MCP server config + roam-as-skill setup.</span>
        </a>
        <a class="verb-cell" href="/docs/integration-tutorials#cursor">
          <code>Cursor</code>
          <span>MCP config + Cursor rule generation.</span>
        </a>
        <a class="verb-cell" href="/docs/integration-tutorials#codex-cli">
          <code>Codex CLI</code>
          <span>MCP setup for OpenAI Codex CLI.</span>
        </a>
        <a class="verb-cell" href="/docs/integration-tutorials#gemini-cli">
          <code>Gemini CLI</code>
          <span>MCP setup for Google Gemini CLI.</span>
        </a>
        <a class="verb-cell" href="/docs/integration-tutorials#amp">
          <code>Amp</code>
          <span>MCP setup for Sourcegraph Amp.</span>
        </a>
        <a class="verb-cell" href="/docs/integration-tutorials">
          <code>All 5 platforms</code>
          <span>Full integration matrix + cross-platform checklist.</span>
        </a>
      </div>
      <p class="how-it-works-foot">
        Or run <code>roam skill-generate --target claude</code> to emit a SKILL.md
        directly from the live capability registry.
      </p>
    </div>
  </section>

  <section class="trust-strip">
    <div class="trust-strip-inner">
      <div class="trust-cell">
        <strong>Reference docs</strong>
        <span>The full command reference + architecture guide + integration tutorials live at <a href="/docs/">roam-code.com/docs</a>. This page is just the install + integration starter.</span>
      </div>
      <div class="trust-cell">
        <strong>README</strong>
        <span>Quick overview at <a href="https://github.com/Cranot/roam-code">github.com/Cranot/roam-code</a>. Surface counts, install snippet, sample commands.</span>
      </div>
      <div class="trust-cell">
        <strong>Browse the source</strong>
        <span>267 commands live in <code>src/roam/commands/</code>, registered in <code>cli.py</code>. Apache 2.0.</span>
      </div>
      <div class="trust-cell">
        <strong>Need help?</strong>
        <span>See our <a href="/security">security policy</a> · open an issue or discussion on <a href="https://github.com/Cranot/roam-code/issues">GitHub</a>, or email <a href="mailto:hello@roam-code.com">hello@roam-code.com</a>.</span>
      </div>
    </div>
  </section>

  </main>

  <footer>
    <div class="footer-inner">
      <div class="footer-col">
        <strong>Roam</strong>
        <span>The local codebase intelligence layer for AI agents and the teams that run them.</span>
        <span class="footer-meta">Built in Athens. Made in the EU.</span>
      </div>
      <div class="footer-col">
        <a href="https://github.com/Cranot/roam-code">GitHub</a>
        <a href="https://pypi.org/project/roam-code/">PyPI</a>
        <a href="/docs/">Docs</a>
      </div>
      <div class="footer-col">
        <a href="/setup">Setup</a>
        <a href="/about">About</a>
        <a href="/press">Press</a>
        <a href="/changelog">Changelog</a>
        <a href="/status">Status</a>
        <a href="/security">Security</a>
        <a href="/accessibility">Accessibility</a>
      </div>
      <div class="footer-col">
        <a href="/privacy">Privacy</a>
        <a href="/terms">Terms</a>
        <a href="/refund">Refund</a>
        <a href="/no-cookies">No cookies</a>
      </div>
      <div class="footer-col">
        <a href="mailto:hello@roam-code.com">hello@roam-code.com</a>
        <a href="mailto:security@roam-code.com">security@roam-code.com</a>
        <span class="footer-meta">No cookies. No tracking. No analytics.</span>
        <span class="footer-meta"><a href="https://github.com/Cranot/roam-code/tree/main/templates/distribution/landing-page">This page is open source</a></span>
      </div>
    </div>
  </footer>

</body>
</html>
