CI Setup

This page covers CI mode: automated reviews on PRs/MRs. For local/pre-commit reviews use the CLI: revue activate <key>.

New to the CLI? See the CLI activation guide to get started in your terminal.

CI mode needs four pieces: your Revue license key, an AI-provider API key, a pipeline YAML step, and provider/model config. Across all three platforms Revue uses one provider-key variable name: AI_API_KEY. The setup is identical regardless of which AI provider you pick.

Add your license key as a repository variable

Go to Repository settings → Repository variables and add REVUE_LICENSE_KEY (mark it Secured).

Add your AI-provider API key

In the same Repository variables screen add AI_API_KEY (Secured). This one variable name works for every provider.

Add bitbucket-pipelines.yml

image: python:3.12-slim

pipelines:
  pull-requests:
    "**":
      - step:
          name: "Revue AI Code Review"
          script:
            - pip install revue-ci --quiet
            - |
              AUTH=$(echo -n "${BITBUCKET_USERNAME}:${BITBUCKET_API_TOKEN}" | base64)
              curl -s \
                -H "Authorization: Basic ${AUTH}" \
                -H "Accept: text/plain" \
                "https://api.bitbucket.org/2.0/repositories/${BITBUCKET_WORKSPACE}/${BITBUCKET_REPO_SLUG}/pullrequests/${BITBUCKET_PR_ID}/diff" \
                -o /tmp/revue_pr.diff
            - |
              revue-ci review \
                --diff /tmp/revue_pr.diff \
                --platform bitbucket \
                --pr-id "${BITBUCKET_PR_ID}" \
                --workspace "${BITBUCKET_WORKSPACE}" \
                --repo-slug "${BITBUCKET_REPO_SLUG}" \
                --bb-username "${BITBUCKET_USERNAME}" \
                --bb-token "${BITBUCKET_API_TOKEN}" \
                --provider "${AI_PROVIDER:-anthropic}" \
                --model "${AI_MODEL:-claude-sonnet-4-5}" \
                --config .revue.yml

image: python:3.12-slim

pipelines:
  pull-requests:
    "**":
      - step:
          name: "Revue AI Code Review"
          script:
            - pip install revue-ci --quiet
            - |
              AUTH=$(echo -n "${BITBUCKET_USERNAME}:${BITBUCKET_API_TOKEN}" | base64)
              curl -s \
                -H "Authorization: Basic ${AUTH}" \
                -H "Accept: text/plain" \
                "https://api.bitbucket.org/2.0/repositories/${BITBUCKET_WORKSPACE}/${BITBUCKET_REPO_SLUG}/pullrequests/${BITBUCKET_PR_ID}/diff" \
                -o /tmp/revue_pr.diff
            - |
              revue-ci review \
                --diff /tmp/revue_pr.diff \
                --platform bitbucket \
                --pr-id "${BITBUCKET_PR_ID}" \
                --workspace "${BITBUCKET_WORKSPACE}" \
                --repo-slug "${BITBUCKET_REPO_SLUG}" \
                --bb-username "${BITBUCKET_USERNAME}" \
                --bb-token "${BITBUCKET_API_TOKEN}" \
                --provider "${AI_PROVIDER:-anthropic}" \
                --model "${AI_MODEL:-claude-sonnet-4-5}" \
                --config .revue.yml

Choose your AI provider

Add AI_PROVIDER and AI_MODEL as repository variables alongside your AI_API_KEY. Copy the snippet for your provider:

Recommended

OpenRouter (DeepSeek-V4-Pro)

AI_PROVIDER=openrouter
AI_MODEL=deepseek/deepseek-v4-pro

AI_PROVIDER=openrouter
AI_MODEL=deepseek/deepseek-v4-pro

Most cost-efficient. Get a key at openrouter.ai.

Anthropic (Claude)

AI_PROVIDER=anthropic
AI_MODEL=claude-sonnet-4-5

AI_PROVIDER=anthropic
AI_MODEL=claude-sonnet-4-5

Highest quality. Uses your Anthropic API key.

OpenAI

AI_PROVIDER=openai
AI_MODEL=gpt-4o

AI_PROVIDER=openai
AI_MODEL=gpt-4o

Use your OpenAI API key.

Azure OpenAI

AI_PROVIDER=azure
AI_MODEL=gpt-4o

AI_PROVIDER=azure
AI_MODEL=gpt-4o

Set AI_API_KEY to your Azure endpoint key.

Add your license key as a secret

Go to Settings → Secrets and variables → Actions → New repository secret and add REVUE_LICENSE_KEY.

Add your AI-provider API key

Add another secret named AI_API_KEY in the same screen. One name, any provider.

Add .github/workflows/revue.yml

name: Revue AI Code Review

on:
  pull_request:
    types: [opened, synchronize, reopened]

permissions:
  contents: read
  pull-requests: write

jobs:
  revue:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install revue-ci
      - name: Run Revue review
        env:
          REVUE_LICENSE_KEY: ${{ secrets.REVUE_LICENSE_KEY }}
          AI_API_KEY: ${{ secrets.AI_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_REPOSITORY: ${{ github.repository }}
        run: |
          git diff origin/${{ github.base_ref }}...HEAD > /tmp/pr.diff
          revue-ci review \
            --diff /tmp/pr.diff \
            --platform github \
            --pr-id "${{ github.event.pull_request.number }}" \
            --provider "${{ vars.AI_PROVIDER || 'anthropic' }}" \
            --model "${{ vars.AI_MODEL || 'claude-sonnet-4-5' }}" \
            --config .revue.yml

name: Revue AI Code Review

on:
  pull_request:
    types: [opened, synchronize, reopened]

permissions:
  contents: read
  pull-requests: write

jobs:
  revue:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install revue-ci
      - name: Run Revue review
        env:
          REVUE_LICENSE_KEY: ${{ secrets.REVUE_LICENSE_KEY }}
          AI_API_KEY: ${{ secrets.AI_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_REPOSITORY: ${{ github.repository }}
        run: |
          git diff origin/${{ github.base_ref }}...HEAD > /tmp/pr.diff
          revue-ci review \
            --diff /tmp/pr.diff \
            --platform github \
            --pr-id "${{ github.event.pull_request.number }}" \
            --provider "${{ vars.AI_PROVIDER || 'anthropic' }}" \
            --model "${{ vars.AI_MODEL || 'claude-sonnet-4-5' }}" \
            --config .revue.yml

Choose your AI provider

Add AI_PROVIDER and AI_MODEL as repository variables alongside your AI_API_KEY. Copy the snippet for your provider:

Recommended

OpenRouter (DeepSeek-V4-Pro)

AI_PROVIDER=openrouter
AI_MODEL=deepseek/deepseek-v4-pro

AI_PROVIDER=openrouter
AI_MODEL=deepseek/deepseek-v4-pro

Most cost-efficient. Get a key at openrouter.ai.

Anthropic (Claude)

AI_PROVIDER=anthropic
AI_MODEL=claude-sonnet-4-5

AI_PROVIDER=anthropic
AI_MODEL=claude-sonnet-4-5

Highest quality. Uses your Anthropic API key.

OpenAI

AI_PROVIDER=openai
AI_MODEL=gpt-4o

AI_PROVIDER=openai
AI_MODEL=gpt-4o

Use your OpenAI API key.

Azure OpenAI

AI_PROVIDER=azure
AI_MODEL=gpt-4o

AI_PROVIDER=azure
AI_MODEL=gpt-4o

Set AI_API_KEY to your Azure endpoint key.

Add your license key as a CI/CD variable

Go to Settings → CI/CD → Variables → Add variable and add REVUE_LICENSE_KEY (Masked).

Add your AI-provider API key

Add another variable named AI_API_KEY (Masked). The same name works whichever provider you use.

Add .gitlab-ci.yml

stages:
  - review

revue-ai-review:
  stage: review
  image: python:3.12-slim
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
  before_script:
    - pip install revue-ci
  script:
    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    - git diff origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...HEAD > /tmp/mr.diff
    - >
      revue-ci review
      --diff /tmp/mr.diff
      --platform gitlab
      --pr-id "$CI_MERGE_REQUEST_IID"
      --provider "${AI_PROVIDER:-openai}"
      --model "${AI_MODEL:-gpt-4o-mini}"
      --config .revue.yml
  variables:
    REVUE_LICENSE_KEY: $REVUE_LICENSE_KEY
    AI_API_KEY: $AI_API_KEY
    GITLAB_TOKEN: $GITLAB_TOKEN
    CI_PROJECT_PATH: $CI_PROJECT_PATH

stages:
  - review

revue-ai-review:
  stage: review
  image: python:3.12-slim
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
  before_script:
    - pip install revue-ci
  script:
    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    - git diff origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...HEAD > /tmp/mr.diff
    - >
      revue-ci review
      --diff /tmp/mr.diff
      --platform gitlab
      --pr-id "$CI_MERGE_REQUEST_IID"
      --provider "${AI_PROVIDER:-openai}"
      --model "${AI_MODEL:-gpt-4o-mini}"
      --config .revue.yml
  variables:
    REVUE_LICENSE_KEY: $REVUE_LICENSE_KEY
    AI_API_KEY: $AI_API_KEY
    GITLAB_TOKEN: $GITLAB_TOKEN
    CI_PROJECT_PATH: $CI_PROJECT_PATH

Choose your AI provider

Add AI_PROVIDER and AI_MODEL as repository variables alongside your AI_API_KEY. Copy the snippet for your provider:

Recommended

OpenRouter (DeepSeek-V4-Pro)

AI_PROVIDER=openrouter
AI_MODEL=deepseek/deepseek-v4-pro

AI_PROVIDER=openrouter
AI_MODEL=deepseek/deepseek-v4-pro

Most cost-efficient. Get a key at openrouter.ai.

Anthropic (Claude)

AI_PROVIDER=anthropic
AI_MODEL=claude-sonnet-4-5

AI_PROVIDER=anthropic
AI_MODEL=claude-sonnet-4-5

Highest quality. Uses your Anthropic API key.

OpenAI

AI_PROVIDER=openai
AI_MODEL=gpt-4o

AI_PROVIDER=openai
AI_MODEL=gpt-4o

Use your OpenAI API key.

Azure OpenAI

AI_PROVIDER=azure
AI_MODEL=gpt-4o

AI_PROVIDER=azure
AI_MODEL=gpt-4o

Set AI_API_KEY to your Azure endpoint key.

Prefer local reviews? Run revue activate <key> and review before you even open a PR. See the CLI activation guide.