QodoAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions.
Project description
๐ The first AI Code Reviewer
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.
Table of Contents
- Getting Started
- Why Use PR-Agent?
- Features
- See It in Action
- Try It Now
- How It Works
- Data Privacy
- Contributing
Getting Started
๐ Quick Start for PR-Agent
1. Try it Instantly (No Setup)
Test PR-Agent on any public GitHub repository by commenting @CodiumAI-Agent /improve
2. 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: Codium-ai/pr-agent@main
env:
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Full GitHub Action setup guide
3. 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
4. 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 | โ | โ | โ | โ | |
| Chat on code suggestions | โ | โ | ||||
| Dynamic context | โ | โ | โ | โ | ||
| Fetching ticket context | โ | โ | โ | |||
| Incremental Update | โ | |||||
| Interactivity | โ | โ | ||||
| Local and global metadata | โ | โ | โ | โ | ||
| Multiple models support | โ | โ | โ | โ | ||
| PR compression | โ | โ | โ | โ | ||
| RAG context enrichment | โ | โ | ||||
| Self reflection | โ | โ | โ | โ |
See It in Action
/describe
/review
/improve
Try It Now
Try the GPT-5 powered PR-Agent instantly on your public GitHub repository. Just mention @CodiumAI-Agent and add the desired command in any PR comment. The agent will generate a response based on your command.
For example, add a comment to any pull request with the following text:
@CodiumAI-Agent /review
and the agent will respond with a review of your PR.
Note that this is a promotional bot, suitable only for initial experimentation.
It does not have 'edit' access to your repo, for example, so it cannot update the PR description or add labels (@CodiumAI-Agent /describe will publish PR description as a comment). In addition, the bot cannot be used on private repositories, as it does not have access to the files there.
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_patched-0.3.2.tar.gz.
File metadata
- Download URL: pr_agent_patched-0.3.2.tar.gz
- Upload date:
- Size: 261.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
01d2fd556dace9aabe316ce896b7a311721e54128696ff7882620ad2b00be771
|
|
| MD5 |
613c76ee5c82bc952b7b4bcae7ce058f
|
|
| BLAKE2b-256 |
b8a8f102bf98479921f22b64a1b6965719f1d290dbd0b7cdf47916ebca2c6f46
|
File details
Details for the file pr_agent_patched-0.3.2-py3-none-any.whl.
File metadata
- Download URL: pr_agent_patched-0.3.2-py3-none-any.whl
- Upload date:
- Size: 300.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
469080c0ce0cea829472f37c78977a93f91c60680542624e2b20da6855dd0262
|
|
| MD5 |
005f929a1eb4087e54659a7dcd3172aa
|
|
| BLAKE2b-256 |
46f7eecfe0756ffa979828b15243ac2e62fd23c72137adb9cec9cf6756965938
|