README.md

The Original Open-Source PR Reviewer

This repository contains the open-source PR Agent Project. It is not the Qodo free tier.

Try the free version on our website.

👉Get Started Now

PR-Agent is an open-source, AI-powered code review agent and a community-maintained legacy project of Qodo. It is distinct from Qodo’s primary AI code review offering, which provides a feature-rich, context-aware experience. Qodo now offers a free tier that integrates seamlessly with GitHub, GitLab, Bitbucket, and Azure DevOps for high-quality automated reviews.

Big News for PR-Agent

PR-Agent has a new home!

After years of building this tool alongside the community, Qodo has donated PR-Agent to the open-source community - and we couldn't be more excited about what comes next.

The project now lives in the PR-Agent org on GitHub, is fully community-owned, and is open for contributions and additional maintainers.

What else changed:

• Docs moved to - www.pr-agent.ai
• Qodo Merge (Qodo 1.0), the hosted URL, which was the enterprise version of PR-Agent, has been rebranded and evolved into Qodo (Qodo 2.0), a full AI code review platform.

Table of Contents

• Getting Started
• Why Use PR-Agent?
• Features
• See It in Action
• How It Works
• Data Privacy
• Contributing

Getting Started

🚀 Quick Start for PR-Agent

1. GitHub Action (Recommended)

Add automated PR reviews to your repository with a simple workflow file:

# .github/workflows/pr-agent.yml
name: PR Agent
on:
  pull_request:
    types: [opened, synchronize]
jobs:
  pr_agent_job:
    runs-on: ubuntu-latest
    steps:
    - name: PR Agent action step
      uses: the-pr-agent/pr-agent@main
      env:
        OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Full GitHub Action setup guide

2. CLI Usage (Local Development)

Run PR-Agent locally on your repository:

pip install pr-agent
export OPENAI_KEY=your_key_here
pr-agent --pr_url https://github.com/owner/repo/pull/123 review

Complete CLI setup guide

3. Other Platforms

• GitLab webhook setup
• BitBucket app installation
• Azure DevOps setup

Why Use PR-Agent?

🎯 Built for Real Development Teams

Fast & Affordable: Each tool (/review, /improve, /ask) uses a single LLM call (~30 seconds, low cost)

Handles Any PR Size: Our PR Compression strategy effectively processes both small and large PRs

Highly Customizable: JSON-based prompting allows easy customization of review categories and behavior via configuration files

Platform Agnostic:

• Git Providers: GitHub, GitLab, BitBucket, Azure DevOps, Gitea
• Deployment: CLI, GitHub Actions, Docker, self-hosted, webhooks
• AI Models: OpenAI GPT, Claude, Deepseek, and more

Open Source Benefits:

• Full control over your data and infrastructure
• Customize prompts and behavior for your team's needs
• No vendor lock-in
• Community-driven development

Features

/describe

/review

/improve

How It Works

The following diagram illustrates PR-Agent tools and their flow:

Data Privacy

Self-hosted PR-Agent

• If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: https://openai.com/enterprise-privacy

Contributing

To contribute to the project, get started by reading our Contributing Guide.

❤️ Community

This open-source release remains here as a community contribution from Qodo — the origin of modern AI-powered code collaboration. We’re proud to share it and inspire developers worldwide.

The project now has its first external maintainer, Naor (@naorpeled), and is currently in the process of being donated to an open-source foundation.