pr-agent/docs/docs/index.md

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

{width=512}

---

/review

{width=512}

---

/improve

{width=512}

---

/generate_labels

{width=300}

---

How it Works

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

Check out the core abilities page for a comprehensive overview of the variety of core abilities used by PR-Agent.