Quick Start

Get fouine running and reviewing PRs in under 10 minutes.

Prerequisites

• Docker and Docker Compose
• A GitHub account
• An OpenCode API key

1. Create a GitHub App

Follow the GitHub App setup guide to create and configure your app. You'll need:

• The App ID
• A private key (.pem file)
• The webhook secret

2. Configure

cp .env.example .env

Fill in the required values:

GITHUB_APP_ID=123456
GITHUB_APP_PRIVATE_KEY_PATH=./app.pem
GITHUB_WEBHOOK_SECRET=your-webhook-secret
OPENCODE_API_KEY=your-opencode-key

3. Start

docker compose up -d

fouine is now running on http://localhost:3000.

4. Register a repo

Open the dashboard at http://localhost:3000, go to Repos, and register the repository you want reviewed. Make sure the GitHub App is installed on that repo.

5. Open a PR

Open (or push to) a pull request on the registered repo. fouine will automatically receive the webhook, clone the repo, run the AI review, and post comments on the PR.

6. Trigger manually

Comment /fouine on any PR to trigger an on-demand review:

/fouine

To cancel a review that's still running on that PR, comment /fouine stop. fouine reacts 👍 if it stopped something, 😕 if nothing was running.

The old /review and /review stop still work, but are deprecated — prefer /fouine.

That's it. Check the Configuration page to customize the review prompt, model, and more.