Skip to main content

PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions.

Project description


logo
The Original Open-Source PR Reviewer

GitHub

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

[!NOTE] Docker Hub namespace migration. Releases 0.34.2 and later are published under pragent/pr-agent. Older releases (up to and including v0.31) remain available at the legacy codiumai/pr-agent namespace as a frozen archive โ€” no new images are pushed there. Update any pinned image: / docker pull / uses: docker:// references when upgrading to 0.34.2+.

๐Ÿš€ 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

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

PR-Agent offers comprehensive pull request functionalities integrated with various git providers:

GitHub GitLab Bitbucket Azure DevOps Gitea
TOOLS Describe โœ… โœ… โœ… โœ… โœ…
Review โœ… โœ… โœ… โœ… โœ…
Improve โœ… โœ… โœ… โœ… โœ…
Ask โœ… โœ… โœ… โœ…
โฎ‘ Ask on code lines โœ… โœ…
Help Docs โœ… โœ… โœ…
Update CHANGELOG โœ… โœ… โœ… โœ…
USAGE CLI โœ… โœ… โœ… โœ… โœ…
App / webhook โœ… โœ… โœ… โœ… โœ…
Tagging bot โœ…
Actions โœ… โœ… โœ… โœ…
CORE Adaptive and token-aware file patch fitting โœ… โœ… โœ… โœ…
Dynamic context โœ… โœ… โœ… โœ…
Fetching ticket context โœ… โœ… โœ…
Interactivity โœ… โœ…
Local and global metadata โœ… โœ… โœ… โœ…
Multiple models support โœ… โœ… โœ… โœ…
PR compression โœ… โœ… โœ… โœ…
Self reflection โœ… โœ… โœ… โœ…

See It in Action

/describe


/review


/improve


How It Works

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

PR-Agent Tools

Data Privacy

Self-hosted PR-Agent

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pr_agent-0.36.1.tar.gz (254.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pr_agent-0.36.1-py3-none-any.whl (307.8 kB view details)

Uploaded Python 3

File details

Details for the file pr_agent-0.36.1.tar.gz.

File metadata

  • Download URL: pr_agent-0.36.1.tar.gz
  • Upload date:
  • Size: 254.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pr_agent-0.36.1.tar.gz
Algorithm Hash digest
SHA256 d2d8a7ae313a68f587a0d5a03dacb044d5d23575d0e8316c221d280cfb22c76f
MD5 e10e3d77628725dd47eac72ce4b809bc
BLAKE2b-256 353bbf6222bfe06aa9f8a4302b0214df50f0f48dec0d410132e85560e09708b7

See more details on using hashes here.

File details

Details for the file pr_agent-0.36.1-py3-none-any.whl.

File metadata

  • Download URL: pr_agent-0.36.1-py3-none-any.whl
  • Upload date:
  • Size: 307.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pr_agent-0.36.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d7d55efa7a6afcbade58c3c57d7a1a628988c5c1c4f572771d0284c33fc9df7
MD5 03df423514a80afe8ef8573739c07ecf
BLAKE2b-256 b495b3d7058706f298d4f3ca291a5e09ed97919a85aca0d9ab419087693888f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page