Quick Start

Get Reviewflow running in 5 minutes.

Prerequisites

• Node.js 20+
• A GitLab or GitHub account with webhook access
• Claude Code CLI installed and authenticated

1. Install

As a user (recommended)

npm install -g reviewflow
# or
yarn global add reviewflow

You can also run it without installing:

npx reviewflow start

As a contributor

git clone https://github.com/DGouron/review-flow.git
cd review-flow
yarn install
yarn build

2. Initialize

Run the interactive setup wizard:

reviewflow init

The wizard walks you through:

1. Choosing your platform (GitLab, GitHub, or both)
2. Entering your username(s) for @mention filtering
3. Scanning for local repositories to register
4. Generating webhook secrets automatically

Your configuration is saved to ~/.claude-review/config.json and ~/.claude-review/.env.

Non-interactive mode

Use reviewflow init --yes to accept all defaults. You can also pass --scan-path /path/to/projects to target specific directories.

Add repositories later

Use reviewflow discover to scan for and add new repositories to your existing configuration.

3. Configure webhook

GitLab

1. Go to your project → Settings → Webhooks
2. Add webhook:
   • URL: https://YOUR_TUNNEL_URL/webhooks/gitlab
   • Secret token: (shown during reviewflow init, or run reviewflow init --show-secrets to view)
   • Trigger: ☑ Merge request events
3. Click Add webhook

GitHub

1. Go to your repo → Settings → Webhooks
2. Add webhook:
   • Payload URL: https://YOUR_TUNNEL_URL/webhooks/github
   • Content type: application/json
   • Secret: (shown during reviewflow init, or run reviewflow init --show-secrets to view)
   • Events: ☑ Pull requests
3. Click Add webhook

Expose for webhooks

GitLab/GitHub need to reach your server. Use a tunnel:

# Cloudflare Tunnel (recommended)
cloudflared tunnel --url http://localhost:3847

# Or ngrok
ngrok http 3847

4. Start & verify

# Start the server
reviewflow start

# Or as a background daemon
reviewflow start --daemon

# Open the dashboard automatically
reviewflow start --open

The server runs at http://localhost:3847 (or your configured port).

Verify your setup

# Check configuration is valid
reviewflow validate

# Check server status
reviewflow status

5. Test it!

1. Create or open a Merge Request / Pull Request
2. Assign yourself as Reviewer
3. Open http://localhost:3847/dashboard/
4. Watch the review appear!

Next steps

• Project Configuration - Configure review skills per project
• Deployment Guide - Run in production with systemd
• Architecture - Understand the codebase

Troubleshooting

See Troubleshooting for common issues and CLI diagnostics.