๐CodiumAI PR-Agent: An AI-Powered ๐ค Tool for Automated Pull Request Analysis, Feedback, Suggestions and More! ๐ป๐
APACHE-2.0 License
See the Installation Guide for instructions on installing PR-Agent on different platforms.
See the Usage Guide for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.
See the Tools Guide for a detailed description of the different tools, and the available configurations for each tool.
Improved support for GitHub enterprise server with GitHub Actions
New ability for the review
tool - ticket compliance feedback. If the PR contains a ticket number, PR-Agent will check if the PR code actually complies with the ticket requirements.
Need help with PR-Agent? New feature - simply comment /help "your question"
in a pull request, and PR-Agent will provide you with the relevant documentation.
Supported commands per platform:
GitHub | Gitlab | Bitbucket | Azure DevOps | ||
---|---|---|---|---|---|
TOOLS | Review | โ | โ | โ | โ |
โฎ Incremental | โ | ||||
Describe | โ | โ | โ | โ | |
โฎ Inline File Summary ๐ | โ | ||||
Improve | โ | โ | โ | โ | |
โฎ Extended | โ | โ | โ | โ | |
Ask | โ | โ | โ | โ | |
โฎ Ask on code lines | โ | โ | |||
Custom Prompt ๐ | โ | โ | โ | ||
Test ๐ | โ | โ | |||
Reflect and Review | โ | โ | โ | โ | |
Update CHANGELOG.md | โ | โ | โ | โ | |
Find Similar Issue | โ | ||||
Add PR Documentation ๐ | โ | โ | |||
Custom Labels ๐ | โ | โ | |||
Analyze ๐ | โ | โ | |||
CI Feedback ๐ | โ | ||||
Similar Code ๐ | โ | ||||
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 and wiki configurations ๐ | โ | โ | โ | ||
PR interactive actions ๐ | โ | โ |
โฃ 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.
โฃ Code Suggestions (/improve
): Code suggestions for improving the PR.
โฃ Question Answering (/ask ...
): Answering free-text questions about 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 Prompt ๐ (/custom_prompt
): Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
โฃ Generate Tests ๐ (/test component_name
): 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.
โฃ Similar Code ๐ (/find_similar_component
): Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
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.
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.
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 ...
.
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:
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:
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.
For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAIโs proprietary models โ if this is the case, you will be notified.
No passive collection of Code and Pull Requestsโ data โ PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request.