ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-16 12:55:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
pr-agent/docs/docs/index.md
mrT23 4739fd3d37
readme
2024-03-11 09:13:35 +02:00

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 Suggestions{: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 ✔️ ✔️ ✔️
Tagging bot ✔️ ✔️
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

/review

/improve

/generate_labels

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\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

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.