Cairn
GitHubDashboard

Getting started

There are two ways to use Cairn. Most people start with the managed cloud; self-host when you want to run it on your own infrastructure.

Option A — Managed cloud (fastest)

  1. Go to the Cairn dashboard and sign in with GitHub.
  2. Install the Cairn GitHub App on a repository you own.
  3. Cairn starts mapping your flows automatically. When mapping finishes, review the flows and click Generate tests.
  4. Add an environment (a deployed URL to test against) and a schedule, or hit Run from the dashboard.
  5. Push or merge to your tracked branch — Cairn re-runs the affected tests and, on failure, files a root-caused issue and (if enabled) opens a fix PR.

That's it — no CI config, no test code to write.

Option B — Self-host

Run the open-source code on your own infrastructure. You'll create your own GitHub App + OAuth App and bring your own model keys. Follow the full guide:

➡️ Self-hosting

The short version:

git clone https://github.com/Vela-Engineering/cairn-vela.git
cd cairn-vela
pnpm install
cp .env.example .env        # fill in the values — see the self-hosting guide
pnpm db:push                # create the schema

# three terminals:
npx inngest-cli@latest dev  # background jobs
pnpm dev                    # web app on :3000
pnpm --filter worker dev    # worker on :3100

What you'll need either way

  • A GitHub account and a repo to connect.
  • For self-hosting: Node 20+, pnpm 9, Postgres, a GitHub App + OAuth App, and a Google Gemini API key. See Self-hosting for the full list.

Next