ShipFlow

Docs · Getting started

Quick setup

From zero to your first reviewed pull request in under ten minutes. You can use the hosted app, or run it locally.

Using the hosted app

  1. 1

    Create your account

    Sign up with email, Google, or GitHub. A personal workspace is created for you automatically.
  2. 2

    Connect the GitHub App

    From Settings → GitHub, install the ShipFlow GitHub App and grant it access to the repositories you want reviewed.
  3. 3

    Create a project & link a repo

    Projects group feature requests around a repository. Create one, then link a connected repo to it.
  4. 4

    Open your first feature request

    Paste a raw request. ShipFlow drafts a PRD, breaks it into tasks, and reviews the resulting pull request — all visible on the pipeline.

Bring your own key first

Add your model API key before your first run so AI features are live from the start. See Bring your own key.

Running locally

Prerequisites: Node 20+, pnpm 9+, and a PostgreSQL database.

# 1. Clone & install
git clone https://github.com/saurabhravte/shipflowAI.git
cd shipflowAI
pnpm install

# 2. Configure environment
cp apps/web/.env.example apps/web/.env.local
# fill in DATABASE_URL, BETTER_AUTH_SECRET, OPENROUTER_API_KEY, ...

# 3. Set up the database
pnpm --filter web db:generate
pnpm --filter web db:migrate

# 4. Start the dev server
pnpm dev

In a second terminal, start the durable workflow dev server so background pipeline steps run locally:

npx inngest-cli@latest dev -u http://localhost:3000/api/inngest

Required environment variables

DATABASE_URL="postgresql://user:password@host:5432/shipflowai"
BETTER_AUTH_SECRET="generate-with-openssl-rand-base64-32"
OPENROUTER_API_KEY="sk-or-..."          # your model key (BYOK)
GITHUB_APP_ID="your-github-app-id"
GITHUB_WEBHOOK_SECRET="your-webhook-secret"
NEXT_PUBLIC_APP_URL="http://localhost:3000"

Social login is optional

Email/password works out of the box. Add the Google / GitHub OAuth variables only if you want those sign-in buttons enabled.

Connect a repository for reviews

ShipFlow uses a GitHub App for repository access and webhooks. Install it on the org or account that owns your repos, select the repositories to grant access to, and link them to a project. Pull request events then trigger AI reviews automatically.

Create your account Bring your own key