PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions.
Project description
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.2and later are published underpragent/pr-agent. Older releases (up to and includingv0.31) remain available at the legacycodiumai/pr-agentnamespace as a frozen archive โ no new images are pushed there. Update any pinnedimage:/docker pull/uses: docker://references when upgrading to0.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
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:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pr_agent-0.34.3.tar.gz.
File metadata
- Download URL: pr_agent-0.34.3.tar.gz
- Upload date:
- Size: 263.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5085bdacb853b5c7806332abb6232fc566aa530e6b51b440efd4dc9b9c28a085
|
|
| MD5 |
a4e7ddd0cbb3c1c7e3341f60dffb7bfb
|
|
| BLAKE2b-256 |
6b3d8496d6950b3793cad2a4204c44480e09d416479c9ce4e4bf5482e994cbd4
|
File details
Details for the file pr_agent-0.34.3-py3-none-any.whl.
File metadata
- Download URL: pr_agent-0.34.3-py3-none-any.whl
- Upload date:
- Size: 302.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd1ae430895c64b6d43195515f2a85deefa08ba37314e9720793e83070a8d083
|
|
| MD5 |
ecb45231fce0db90f5cb6e9c6d43f6b5
|
|
| BLAKE2b-256 |
5d77f2e82a9b414d23c1e47a4f4be87a876eeb3e540c3a51728d60c3705c241d
|