Files
pr-agent/docs/docs/index.md

10 KiB
Raw Blame History

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{:target="_blank"} 💎
Ask
Describe
Inline file summary{:target="_blank"} 💎
Improve
⮑ Extended
Custom Prompt{:target="_blank"} 💎
Reflect and Review
Update CHANGELOG.md
Find Similar Issue
Add PR Documentation{:target="_blank"} 💎
Generate Custom Labels{:target="_blank"} 💎
Analyze PR Components{:target="_blank"} 💎
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{:target="_blank"} 💎
Multiple configuration options{:target="_blank"} 💎

💎 marks a feature available only in PR-Agent Pro{:target="_blank"}

Example Results


/describe

![/describe](https://www.codium.ai/images/pr_agent/describe_new_short_main.png){width=512}

/review

![/review](https://www.codium.ai/images/pr_agent/review_new_short_main.png){width=512}

/improve

![/improve](https://www.codium.ai/images/pr_agent/improve_new_short_main.png){width=512}

/generate_labels

![/generate_labels](https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png){width=300}

How it Works

The following diagram illustrates PR-Agent tools and their flow:

PR-Agent Tools

Check out the PR Compression strategy page for more details on how we convert a code diff to a manageable LLM prompt

PR-Agent Pro 💎

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:

  1. 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\GitLab\BitBucket repo.
  2. 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.
  3. Improved support - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
  4. 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:

Data Privacy

Self-hosted PR-Agent

CodiumAI-hosted PR-Agent Pro 💎

  • 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 CodiumAIs 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.

PR-Agent Chrome extension

  • The PR-Agent Chrome extension serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of PR-Agent.