- A new [knowledge-base website](https://codium-ai.github.io/Docs-PR-Agent/) for PR-Agent is now available. It includes detailed information about the different tools, usage guides and more, in an accessible and organized format.
- You can now use the repo's [wiki page](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/configuration_options/) to set configurations for PR-Agent 💎
- See the [Installation Guide](https://codium-ai.github.io/Docs-PR-Agent/installation/) for instructions on installing and running the tool on different git platforms.
- See the [Usage Guide](https://codium-ai.github.io/Docs-PR-Agent/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](https://codium-ai.github.io/Docs-PR-Agent/tools/) for a detailed description of the different tools (tools are run via the commands).
‣ **Auto Review ([`/review`](https://codium-ai.github.io/Docs-PR-Agent/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
‣ **Update Changelog ([`/update_changelog`](https://codium-ai.github.io/Docs-PR-Agent/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
‣ **Find Similar Issue ([`/similar_issue`](https://codium-ai.github.io/Docs-PR-Agent/tools/similar_issues/))**: Automatically retrieves and presents similar issues.
‣ **Add Documentation 💎 ([`/add_docs`](https://codium-ai.github.io/Docs-PR-Agent/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
‣ **Generate Custom Labels 💎 ([`/generate_labels`](https://codium-ai.github.io/Docs-PR-Agent/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
‣ **Analyze 💎 ([`/analyze`](https://codium-ai.github.io/Docs-PR-Agent/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
‣ **Custom Suggestions 💎 ([`/custom_suggestions`](https://codium-ai.github.io/Docs-PR-Agent/tools/custom_suggestions/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
‣ **Generate Tests 💎 ([`/test component_name`](https://codium-ai.github.io/Docs-PR-Agent/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
‣ **CI Feedback 💎 ([`/checks ci_job`](https://codium-ai.github.io/Docs-PR-Agent/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
‣ **Similar Code 💎 ([`/find_similar_component`](https://codium-ai.github.io/Docs-PR-Agent/tools/similar_code//))**: 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.
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](https://www.codium.ai/pricing/) 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.
See [here](https://codium-ai.github.io/Docs-PR-Agent/#pr-agent-pro) for a list of features available in PR-Agent Pro.
Check out the [PR Compression strategy](https://codium-ai.github.io/Docs-PR-Agent/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
- Our [PR Compression strategy](https://codium-ai.github.io/Docs-PR-Agent/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
