Overview¶
CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests.
-
See the Installation Guide for instructions on installing and running the tool on different git platforms.
-
See the Usage Guide for instructions on 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.
PR-Agent Features¶
PR-Agent offers extensive pull request functionalities across various git providers.
GitHub | Gitlab | Bitbucket | Azure DevOps | ||
---|---|---|---|---|---|
TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
⮑ Incremental | ✅ | ||||
⮑ SOC2 Compliance 💎 | ✅ | ✅ | ✅ | ||
Ask | ✅ | ✅ | ✅ | ✅ | |
Describe | ✅ | ✅ | ✅ | ✅ | |
⮑ Inline file summary 💎 | ✅ | ✅ | |||
Improve | ✅ | ✅ | ✅ | ✅ | |
⮑ Extended | ✅ | ✅ | ✅ | ✅ | |
Custom Prompt 💎 | ✅ | ✅ | ✅ | ||
Reflect and Review | ✅ | ✅ | ✅ | ||
Update CHANGELOG.md | ✅ | ✅ | ✅ | ️ | |
Find Similar Issue | ✅ | ️ | |||
Add PR Documentation 💎 | ✅ | ✅ | |||
Generate Custom Labels 💎 | ✅ | ✅ | |||
Analyze PR Components 💎 | ✅ | ✅ | |||
️ | |||||
USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
App / webhook | ✅ | ✅ | ✅ | ✅ | |
Actions | ✅ | ️ | |||
CORE | PR compression | ✅ | ✅ | ✅ | ✅ |
Repo language prioritization | ✅ | ✅ | ✅ | ✅ | |
Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | |
Multiple models support | ✅ | ✅ | ✅ | ✅ | |
Incremental PR review | ✅ | ||||
Static code analysis 💎 | ✅ | ✅ | ✅ | ||
Multiple configuration options 💎 | ✅ | ✅ | ✅ |
💎 marks a feature available only in PR-Agent Pro
Example Results¶
/describe¶
/review¶
/improve¶
/generate_labels¶
How it Works¶
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