Making pull requests less painful with an AI agent
- News and Updates
- Overview
- Example results
- Try it now
- Installation
- PR-Agent Pro 💎
- How it works
- Why use PR-Agent?
- Introducing the
CI Feedbacktool 💎. The tool automatically triggers when a PR has a failed check. It analyzes the failed check, and provides summarized logs and analysis. Note that this feature requires read access to GitHub 'checks' and 'actions'. See here for more details.
→
- New ability - you can run
/askon specific lines of code in the PR from the PR's diff view. See here for more details.
- Introducing support for Azure DevOps Webhooks, as well as bug fixes and improved support for several ADO commands.
The review tool has been revamped, aiming to make the feedback clearer and more relevant, and better complement the improve tool.
A new feature was added to the review tool - Auto-approve PRs. If enabled, this feature enables to automatically approve PRs that meet specific criteria, by commenting on a PR: /review auto_approve.
Added "PR Actions" 💎 - interactively trigger PR-Agent tools from the PR page.
- 💎 Test - A new tool,
/test component_name, was added to PR-Agent Pro. The tool will generate tests for a selected component, based on the PR code changes. - 💎 Analyze - The
/analyzetool was updated and simplified. It now presents a summary of the code components that were changed in the PR.
- 💎 Custom suggestions - A new tool,
/custom_suggestions, was added to PR-Agent Pro. The tool will propose only suggestions that follow specific guidelines defined by the user. See here for more details.
CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. It automatically analyzes the pull request and can provide several types of commands:
| GitHub | Gitlab | Bitbucket | ||
|---|---|---|---|---|
| TOOLS | Review | ✅ | ✅ | ✅ |
| ⮑ Incremental | ✅ | |||
| ⮑ SOC2 Compliance 💎 | ✅ | ✅ | ✅ | |
| Describe | ✅ | ✅ | ✅ | |
| ⮑ Inline File Summary 💎 | ✅ | |||
| Improve | ✅ | ✅ | ✅ | |
| ⮑ Extended | ✅ | ✅ | ✅ | |
| Ask | ✅ | ✅ | ✅ | |
| ⮑ Ask on code lines | ✅ | ✅ | ||
| Custom Suggestions 💎 | ✅ | ✅ | ✅ | |
| Test 💎 | ✅ | ✅ | ✅ | |
| Reflect and Review | ✅ | ✅ | ✅ | |
| Update CHANGELOG.md | ✅ | ✅ | ✅ | |
| Find Similar Issue | ✅ | |||
| Add PR Documentation 💎 | ✅ | ✅ | ✅ | |
| Custom Labels 💎 | ✅ | ✅ | ||
| Analyze 💎 | ✅ | ✅ | ||
| CI Feedback 💎 | ✅ | |||
| USAGE | CLI | ✅ | ✅ | ✅ |
| App / webhook | ✅ | ✅ | ✅ | |
| Tagging bot | ✅ | |||
| Actions | ✅ | ✅ | ||
| CORE | PR compression | ✅ | ✅ | ✅ |
| Repo language prioritization | ✅ | ✅ | ✅ | |
| Adaptive and token-aware file patch fitting |
✅ | ✅ | ✅ | |
| Multiple models support | ✅ | ✅ | ✅ | |
| Static code analysis 💎 | ✅ | ✅ | ✅ | |
| Global configuration 💎 | ✅ | ✅ | ✅ | |
| PR Actions 💎 | ✅ |
- 💎 means this feature is available only in PR-Agent Pro
- Support for additional git providers is described in here
‣ Auto Description (/describe): Automatically generating PR description - title, type, summary, code walkthrough and labels.
‣ Auto Review (/review): Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
‣ Question Answering (/ask ...): Answering free-text questions about the PR.
‣ Code Suggestions (/improve): Code suggestions for improving the PR.
‣ Update Changelog (/update_changelog): Automatically updating the CHANGELOG.md file with the PR changes.
‣ Find Similar Issue (/similar_issue): Automatically retrieves and presents similar issues.
‣ Add Documentation 💎 (/add_docs): Generates documentation to methods/functions/classes that changed in the PR.
‣ Generate Custom Labels 💎 (/generate_labels): Generates custom labels for the PR, based on specific guidelines defined by the user.
‣ Analyze 💎 (/analyze): Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
‣ Custom Suggestions 💎 (/custom_suggestions): Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
‣ Generate Tests 💎 (/test component_name): Automatically generates unit tests for a selected component, based on the PR code changes.
‣ CI Feedback 💎 (/checks ci_job): Automatically generates feedback and analysis for a failed CI job.
See the Installation Guide for instructions on installing and running the tool on different git platforms.
See the Usage Guide for running the PR-Agent commands via different interfaces, including CLI, online usage, or by automatically triggering them when a new PR is opened.
See the Tools Guide for a detailed description of the different tools (tools are run via the commands).
Try the GPT-4 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
To set up your own PR-Agent, see the Installation section below.
Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention @CodiumAI-Agent .... Instead, directly start with the command, e.g., /ask ....
To use your own version of PR-Agent, you first need to acquire two tokens:
- An OpenAI key from here, with access to GPT-4.
- A GitHub personal access token (classic) with the repo scope.
There are several ways to use PR-Agent:
Locally
GitHub specific methods
GitLab specific methods
BitBucket specific methods
PR-Agent Pro is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
- Fully managed - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
- Improved privacy - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
- Improved support - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
- Extra features -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features:
The following diagram illustrates PR-Agent tools and their flow:
Check out the PR Compression strategy page for more details on how we convert a code diff to a manageable LLM prompt
A reasonable question that can be asked is: "Why use PR-Agent? What makes it stand out from existing tools?"
Here are some advantages of PR-Agent:
- We emphasize real-life practical usage. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
- Our PR Compression strategy is a core ability that enables to effectively tackle both short and long PRs.
- Our JSON prompting strategy enables to have modular, customizable tools. For example, the '/review' tool categories can be controlled via the configuration file. Adding additional categories is easy and accessible.
- We support multiple git providers (GitHub, Gitlab, Bitbucket), multiple ways to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and multiple models (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
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
When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention.
- Discord community: https://discord.gg/kG35uSHDBc
- CodiumAI site: https://codium.ai
- Blog: https://www.codium.ai/blog/
- Troubleshooting: https://www.codium.ai/blog/technical-faq-and-troubleshooting/
- Support: [email protected]