mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-12-12 02:45:18 +00:00
Name changes
This commit is contained in:
parent
6779376222
commit
2332bf411a
77 changed files with 592 additions and 584 deletions
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -2,7 +2,7 @@ blank_issues_enabled: false
|
|||
version: 0.1
|
||||
contact_links:
|
||||
- name: Discussions
|
||||
url: https://github.com/qodo-ai/pr-agent/discussions
|
||||
url: https://github.com/Blackbox-ai/pr-agent/discussions
|
||||
about: GitHub Discussions
|
||||
|
||||
- name: Discord community
|
||||
|
|
|
|||
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -11,5 +11,5 @@ dist/
|
|||
build/
|
||||
.DS_Store
|
||||
docs/.cache/
|
||||
.qodo
|
||||
.Blackbox
|
||||
poetry.lock
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
|
|||
individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
|
||||
contacting a project maintainer at dana.f@qodo.ai . All complaints will
|
||||
contacting a project maintainer at dana.f@Blackbox.ai . All complaints will
|
||||
be reviewed and investigated and will result in a response that is deemed necessary and
|
||||
appropriate to the circumstances. Maintainers are obligated to maintain confidentiality
|
||||
with regard to the reporter of an incident.
|
||||
|
|
|
|||
|
|
@ -34,5 +34,5 @@ Thank you for your interest in contributing to the PR-Agent project!
|
|||
## Questions or Need Help?
|
||||
|
||||
- Join our [Discord community](https://discord.com/channels/1057273017547378788/1126104260430528613) for questions and discussions
|
||||
- Check the [documentation](https://qodo-merge-docs.qodo.ai/) for detailed information
|
||||
- Report bugs or request features through [GitHub Issues](https://github.com/qodo-ai/pr-agent/issues)
|
||||
- Check the [documentation](https://Blackbox-merge-docs.Blackbox.ai/) for detailed information
|
||||
- Report bugs or request features through [GitHub Issues](https://github.com/Blackbox-ai/pr-agent/issues)
|
||||
|
|
|
|||
16
README.md
16
README.md
|
|
@ -1,18 +1,18 @@
|
|||
# 🧠 PR Agent LEGACY STATUS (open source)
|
||||
Originally created and open-sourced by Qodo - the team behind next-generation AI Code Review.
|
||||
Originally created and open-sourced by Blackbox - the team behind next-generation AI Code Review.
|
||||
|
||||
## 🚀 About
|
||||
PR Agent was the first AI assistant for pull requests, built by Qodo, and contributed to the open-source community.
|
||||
It represents the first generation of intelligent code review - the project that started Qodo’s journey toward fully AI-driven development, Code Review.
|
||||
If you enjoy this project, you’ll love the next-level PR Agent - Qodo free tier version, which is faster, smarter, and built for today’s workflows.
|
||||
PR Agent was the first AI assistant for pull requests, built by Blackbox, and contributed to the open-source community.
|
||||
It represents the first generation of intelligent code review - the project that started Blackbox’s journey toward fully AI-driven development, Code Review.
|
||||
If you enjoy this project, you’ll love the next-level PR Agent - Blackbox free tier version, which is faster, smarter, and built for today’s workflows.
|
||||
|
||||
🚀 Qodo includes a free user trial, 250 tokens, bonus tokens for active contributors, and 50% more advanced features than this open-source version.
|
||||
🚀 Blackbox includes a free user trial, 250 tokens, bonus tokens for active contributors, and 50% more advanced features than this open-source version.
|
||||
|
||||
If you have an open-source project, you can get the Qodo paid version for free for your project, powered by Google Gemini 2.5 Pro – [https://www.qodo.ai/solutions/open-source/](https://www.qodo.ai/solutions/open-source/)
|
||||
If you have an open-source project, you can get the Blackbox paid version for free for your project, powered by Google Gemini 2.5 Pro – [https://www.Blackbox.ai/solutions/open-source/](https://www.Blackbox.ai/solutions/open-source/)
|
||||
|
||||
---
|
||||
|
||||
## ✨ Advanced Features in Qodo
|
||||
## ✨ Advanced Features in Blackbox
|
||||
|
||||
### 🧭 PR → Ticket Automation
|
||||
Seamlessly links pull requests to your project tracking system for end-to-end visibility.
|
||||
|
|
@ -32,5 +32,5 @@ Analyzes the business and technical effect of each change before approval.
|
|||
---
|
||||
|
||||
## ❤️ Community
|
||||
This open-source release remains here as a community contribution from Qodo — the origin of modern AI-powered code collaboration.
|
||||
This open-source release remains here as a community contribution from Blackbox — the origin of modern AI-powered code collaboration.
|
||||
We’re proud to share it and inspire developers worldwide.
|
||||
|
|
|
|||
14
SECURITY.md
14
SECURITY.md
|
|
@ -1,14 +1,14 @@
|
|||
# Security Policy
|
||||
|
||||
PR-Agent is an open-source tool to help efficiently review and handle pull requests. Qodo Merge is a paid version of PR-Agent, designed for companies and teams that require additional features and capabilities.
|
||||
PR-Agent is an open-source tool to help efficiently review and handle pull requests. Blackbox Merge is a paid version of PR-Agent, designed for companies and teams that require additional features and capabilities.
|
||||
|
||||
This document describes the security policy of PR-Agent. For Qodo Merge's security policy, see [here](https://qodo-merge-docs.qodo.ai/overview/data_privacy/#qodo-merge).
|
||||
This document describes the security policy of PR-Agent. For Blackbox Merge's security policy, see [here](https://Blackbox-merge-docs.Blackbox.ai/overview/data_privacy/#Blackbox-merge).
|
||||
|
||||
## PR-Agent Self-Hosted Solutions
|
||||
|
||||
When using PR-Agent with your OpenAI (or other LLM provider) API key, the security relationship is directly between you and the provider. We do not send your code to Qodo servers.
|
||||
When using PR-Agent with your OpenAI (or other LLM provider) API key, the security relationship is directly between you and the provider. We do not send your code to Blackbox servers.
|
||||
|
||||
Types of [self-hosted solutions](https://qodo-merge-docs.qodo.ai/installation):
|
||||
Types of [self-hosted solutions](https://Blackbox-merge-docs.Blackbox.ai/installation):
|
||||
|
||||
- Locally
|
||||
- GitHub integration
|
||||
|
|
@ -27,13 +27,13 @@ This section outlines which versions of PR-Agent are currently supported with se
|
|||
For the most recent updates, use our latest Docker image which is automatically built nightly:
|
||||
|
||||
```yaml
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
```
|
||||
|
||||
#### Specific Release Version
|
||||
|
||||
For a fixed version, you can pin your action to a specific release version. Browse available releases at:
|
||||
[PR-Agent Releases](https://github.com/qodo-ai/pr-agent/releases)
|
||||
[PR-Agent Releases](https://github.com/Blackbox-ai/pr-agent/releases)
|
||||
|
||||
For example, to github action:
|
||||
|
||||
|
|
@ -59,6 +59,6 @@ steps:
|
|||
|
||||
We take the security of PR-Agent seriously. If you discover a security vulnerability, please report it immediately to:
|
||||
|
||||
Email: security@qodo.ai
|
||||
Email: security@Blackbox.ai
|
||||
|
||||
Please include a description of the vulnerability, steps to reproduce, and the affected PR-Agent version.
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
# [Visit Our Docs Portal](https://qodo-merge-docs.qodo.ai/)
|
||||
# [Visit Our Docs Portal](https://Blackbox-merge-docs.Blackbox.ai/)
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
qodo-merge-docs.qodo.ai
|
||||
Blackbox-merge-docs.Blackbox.ai
|
||||
|
|
|
|||
|
|
@ -289,7 +289,7 @@ window.addEventListener('load', function() {
|
|||
};
|
||||
|
||||
//const API_ENDPOINT = 'http://0.0.0.0:3000/api/v1/docs_help';
|
||||
const API_ENDPOINT = 'https://help.merge.qodo.ai/api/v1/docs_help';
|
||||
const API_ENDPOINT = 'https://help.merge.Blackbox.ai/api/v1/docs_help';
|
||||
|
||||
const response = await fetch(API_ENDPOINT, options);
|
||||
const responseText = await response.text();
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
|
@ -1,4 +1,4 @@
|
|||
We take your code's security and privacy seriously:
|
||||
|
||||
- The Chrome extension will not send your code to any external servers.
|
||||
- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge integration.
|
||||
- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Blackbox Merge integration.
|
||||
|
|
|
|||
|
|
@ -4,22 +4,22 @@
|
|||
The PR-Chat feature allows to freely chat with your PR code, within your GitHub environment.
|
||||
It will seamlessly use the PR as context to your chat session, and provide AI-powered feedback.
|
||||
|
||||
To enable private chat, simply install the Qodo Merge Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code.
|
||||
To enable private chat, simply install the Blackbox Merge Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code.
|
||||
This chat session is **private**, and won't be visible to other users.
|
||||
|
||||
All open-source repositories are supported.
|
||||
For private repositories, you will also need to install Qodo Merge. After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
|
||||
For private repositories, you will also need to install Blackbox Merge. After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
|
||||
|
||||
#### Context-aware PR chat
|
||||
|
||||
Qodo Merge constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request.
|
||||
Blackbox Merge constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request.
|
||||
|
||||
<img src="https://codium.ai/images/pr_agent/pr_chat_1.png" width="768">
|
||||
<img src="https://codium.ai/images/pr_agent/pr_chat_2.png" width="768">
|
||||
|
||||
### Toolbar extension
|
||||
|
||||
With Qodo Merge Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options.
|
||||
With Blackbox Merge Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options.
|
||||
|
||||
For private repositories, after you found the setup that works for you, you can also easily export it as a persistent configuration file, and use it for automatic commands.
|
||||
|
||||
|
|
@ -27,11 +27,11 @@ For private repositories, after you found the setup that works for you, you can
|
|||
|
||||
<img src="https://codium.ai/images/pr_agent/toolbar2.png" width="512">
|
||||
|
||||
### Qodo Merge filters
|
||||
### Blackbox Merge filters
|
||||
|
||||
Qodo Merge filters is a sidepanel option. that allows you to filter different message in the conversation tab.
|
||||
Blackbox Merge filters is a sidepanel option. that allows you to filter different message in the conversation tab.
|
||||
|
||||
For example, you can choose to present only message from Qodo Merge, or filter those messages, focusing only on user's comments.
|
||||
For example, you can choose to present only message from Blackbox Merge, or filter those messages, focusing only on user's comments.
|
||||
|
||||
<img src="https://codium.ai/images/pr_agent/pr_agent_filters1.png" width="256">
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ For example, you can choose to present only message from Qodo Merge, or filter t
|
|||
|
||||
### Enhanced code suggestions
|
||||
|
||||
Qodo Merge Chrome extension adds the following capabilities to code suggestions tool's comments:
|
||||
Blackbox Merge Chrome extension adds the following capabilities to code suggestions tool's comments:
|
||||
|
||||
- Auto-expand the table when you are viewing a code block, to avoid clipping.
|
||||
- Adding a "quote-and-reply" button, that enables to address and comment on a specific suggestion (for example, asking the author to fix the issue)
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
`Platforms supported: GitHub Cloud`
|
||||
|
||||
[Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl){:target="_blank"} is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your Git usage experience, and providing AI-powered capabilities to your PRs.
|
||||
[Blackbox Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl){:target="_blank"} is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your Git usage experience, and providing AI-powered capabilities to your PRs.
|
||||
|
||||
With a single-click installation you will gain access to a context-aware chat on your pull requests code, a toolbar extension with multiple AI feedbacks, Qodo Merge filters, and additional abilities.
|
||||
With a single-click installation you will gain access to a context-aware chat on your pull requests code, a toolbar extension with multiple AI feedbacks, Blackbox Merge filters, and additional abilities.
|
||||
|
||||
The extension is powered by top code models like GPT-5. All the extension's features are free to use on public repositories.
|
||||
|
||||
For private repositories, you will need to install [Qodo Merge](https://github.com/apps/qodo-merge-pro){:target="_blank"} in addition to the extension.
|
||||
For a demonstration of how to install Qodo Merge and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4){:target="_blank"}.
|
||||
For private repositories, you will need to install [Blackbox Merge](https://github.com/apps/Blackbox-merge-pro){:target="_blank"} in addition to the extension.
|
||||
For a demonstration of how to install Blackbox Merge and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4){:target="_blank"}.
|
||||
|
||||
<img src="https://codium.ai/images/pr_agent/PR-AgentChat.gif" width="768">
|
||||
|
||||
|
|
@ -22,22 +22,22 @@ The extension is supported on all Chromium-based browsers, including Google Chro
|
|||
The PR-Chat feature allows to freely chat with your PR code, within your GitHub environment.
|
||||
It will seamlessly use the PR as context to your chat session, and provide AI-powered feedback.
|
||||
|
||||
To enable private chat, simply install the Qodo Merge Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code.
|
||||
To enable private chat, simply install the Blackbox Merge Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code.
|
||||
This chat session is **private**, and won't be visible to other users.
|
||||
|
||||
All open-source repositories are supported.
|
||||
For private repositories, you will also need to install Qodo Merge. After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
|
||||
For private repositories, you will also need to install Blackbox Merge. After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
|
||||
|
||||
#### Context-aware PR chat
|
||||
|
||||
Qodo Merge constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request.
|
||||
Blackbox Merge constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request.
|
||||
|
||||
<img src="https://codium.ai/images/pr_agent/pr_chat_1.png" width="768">
|
||||
<img src="https://codium.ai/images/pr_agent/pr_chat_2.png" width="768">
|
||||
|
||||
### Toolbar extension
|
||||
|
||||
With Qodo Merge Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options.
|
||||
With Blackbox Merge Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options.
|
||||
|
||||
For private repositories, after you found the setup that works for you, you can also easily export it as a persistent configuration file, and use it for automatic commands.
|
||||
|
||||
|
|
@ -45,11 +45,11 @@ For private repositories, after you found the setup that works for you, you can
|
|||
|
||||
<img src="https://codium.ai/images/pr_agent/toolbar2.png" width="512">
|
||||
|
||||
### Qodo Merge filters
|
||||
### Blackbox Merge filters
|
||||
|
||||
Qodo Merge filters is a sidepanel option. that allows you to filter different message in the conversation tab.
|
||||
Blackbox Merge filters is a sidepanel option. that allows you to filter different message in the conversation tab.
|
||||
|
||||
For example, you can choose to present only message from Qodo Merge, or filter those messages, focusing only on user's comments.
|
||||
For example, you can choose to present only message from Blackbox Merge, or filter those messages, focusing only on user's comments.
|
||||
|
||||
<img src="https://codium.ai/images/pr_agent/pr_agent_filters1.png" width="256">
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ For example, you can choose to present only message from Qodo Merge, or filter t
|
|||
|
||||
### Enhanced code suggestions
|
||||
|
||||
Qodo Merge Chrome extension adds the following capabilities to code suggestions tool's comments:
|
||||
Blackbox Merge Chrome extension adds the following capabilities to code suggestions tool's comments:
|
||||
|
||||
- Auto-expand the table when you are viewing a code block, to avoid clipping.
|
||||
- Adding a "quote-and-reply" button, that enables to address and comment on a specific suggestion (for example, asking the author to fix the issue)
|
||||
|
|
@ -71,13 +71,13 @@ Qodo Merge Chrome extension adds the following capabilities to code suggestions
|
|||
We take your code's security and privacy seriously:
|
||||
|
||||
- The Chrome extension will not send your code to any external servers.
|
||||
- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge integration.
|
||||
- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Blackbox Merge integration.
|
||||
|
||||
## Options and Configurations
|
||||
|
||||
### Accessing the Options Page
|
||||
|
||||
To access the options page for the Qodo Merge Chrome extension:
|
||||
To access the options page for the Blackbox Merge Chrome extension:
|
||||
|
||||
1. Find the extension icon in your Chrome toolbar (usually in the top-right corner of your browser)
|
||||
2. Right-click on the extension icon
|
||||
|
|
@ -95,20 +95,20 @@ Alternatively, you can access the options page directly using this URL:
|
|||
|
||||
#### API Base Host
|
||||
|
||||
For single-tenant customers, you can configure the extension to communicate directly with your company's Qodo Merge server instance.
|
||||
For single-tenant customers, you can configure the extension to communicate directly with your company's Blackbox Merge server instance.
|
||||
|
||||
To set this up:
|
||||
|
||||
- Enter your organization's Qodo Merge API endpoint in the "API Base Host" field
|
||||
- This endpoint should be provided by your Qodo DevOps Team
|
||||
- Enter your organization's Blackbox Merge API endpoint in the "API Base Host" field
|
||||
- This endpoint should be provided by your Blackbox DevOps Team
|
||||
|
||||
*Note: The extension does not send your code to the server, but only triggers your previously installed Qodo Merge application.*
|
||||
*Note: The extension does not send your code to the server, but only triggers your previously installed Blackbox Merge application.*
|
||||
|
||||
#### Interface Options
|
||||
|
||||
You can customize the extension's interface by:
|
||||
|
||||
- Toggling the "Show Qodo Merge Toolbar" option
|
||||
- Toggling the "Show Blackbox Merge Toolbar" option
|
||||
- When disabled, the toolbar will not appear in your Github comment bar
|
||||
|
||||
Remember to click "Save Settings" after making any changes.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
### Accessing the Options Page
|
||||
|
||||
To access the options page for the Qodo Merge Chrome extension:
|
||||
To access the options page for the Blackbox Merge Chrome extension:
|
||||
|
||||
1. Find the extension icon in your Chrome toolbar (usually in the top-right corner of your browser)
|
||||
2. Right-click on the extension icon
|
||||
|
|
@ -20,20 +20,20 @@ Alternatively, you can access the options page directly using this URL:
|
|||
|
||||
#### API Base Host
|
||||
|
||||
For single-tenant customers, you can configure the extension to communicate directly with your company's Qodo Merge server instance.
|
||||
For single-tenant customers, you can configure the extension to communicate directly with your company's Blackbox Merge server instance.
|
||||
|
||||
To set this up:
|
||||
|
||||
- Enter your organization's Qodo Merge API endpoint in the "API Base Host" field
|
||||
- This endpoint should be provided by your Qodo DevOps Team
|
||||
- Enter your organization's Blackbox Merge API endpoint in the "API Base Host" field
|
||||
- This endpoint should be provided by your Blackbox DevOps Team
|
||||
|
||||
*Note: The extension does not send your code to the server, but only triggers your previously installed Qodo Merge application.*
|
||||
*Note: The extension does not send your code to the server, but only triggers your previously installed Blackbox Merge application.*
|
||||
|
||||
#### Interface Options
|
||||
|
||||
You can customize the extension's interface by:
|
||||
|
||||
- Toggling the "Show Qodo Merge Toolbar" option
|
||||
- Toggling the "Show Blackbox Merge Toolbar" option
|
||||
- When disabled, the toolbar will not appear in your Github comment bar
|
||||
|
||||
Remember to click "Save Settings" after making any changes.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
Under specific conditions, Qodo Merge can auto-approve a PR when a manual comment is invoked, or when the PR meets certain criteria.
|
||||
Under specific conditions, Blackbox Merge can auto-approve a PR when a manual comment is invoked, or when the PR meets certain criteria.
|
||||
|
||||
**To ensure safety, the auto-approval feature is disabled by default.**
|
||||
To enable auto-approval features, you need to actively set one or both of the following options in a pre-defined _configuration file_:
|
||||
|
|
@ -32,7 +32,7 @@ After enabling, by commenting on a PR:
|
|||
/review auto_approve
|
||||
```
|
||||
|
||||
Qodo Merge will approve the PR and add a comment with the reason for the approval.
|
||||
Blackbox Merge will approve the PR and add a comment with the reason for the approval.
|
||||
|
||||
## **Auto-approval when the PR meets certain criteria**
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ There are two possible paths leading to this auto-approval - one via the `review
|
|||
auto_approve_for_low_review_effort = X # X is a number between 1 and 5
|
||||
```
|
||||
|
||||
When the [review effort score](https://www.qodo.ai/images/pr_agent/review3.png) is lower than or equal to X, the PR will be auto-approved (unless ticket compliance is enabled and fails, see below).
|
||||
When the [review effort score](https://www.Blackbox.ai/images/pr_agent/review3.png) is lower than or equal to X, the PR will be auto-approved (unless ticket compliance is enabled and fails, see below).
|
||||
|
||||
- **Ticket compliance criteria**
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ There are two possible paths leading to this auto-approval - one via the `review
|
|||
|
||||
If `ensure_ticket_compliance` is set to `true`, auto-approval for the `review` toll path will be disabled if no ticket is linked to the PR, or if the PR is not fully compliant with a linked ticket. This ensures that PRs are only auto-approved if their associated tickets are properly resolved.
|
||||
|
||||
You can also prevent auto-approval if the PR exceeds the ticket's scope (see [here](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#configuration-options)).
|
||||
You can also prevent auto-approval if the PR exceeds the ticket's scope (see [here](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/#configuration-options)).
|
||||
|
||||
|
||||
### Auto-approval via the `improve` tool
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
## Overview
|
||||
|
||||
{width=684}
|
||||
{width=684}
|
||||
|
||||
> Note - enabling a [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/enabling_a_wiki/) is required for this feature.
|
||||
> Note - enabling a [Wiki](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/enabling_a_wiki/) is required for this feature.
|
||||
|
||||
### Finding Code Problems - Exploration Phase
|
||||
|
||||
|
|
@ -17,12 +17,12 @@ The analysis intentionally takes a flexible, _exploratory_ approach to identify
|
|||
|
||||
### Tracking Implemented Suggestions
|
||||
|
||||
Qodo Merge features a novel [tracking system](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) that automatically detects when PR authors implement AI-generated code suggestions.
|
||||
All accepted suggestions are aggregated in a repository-specific wiki page called [`.pr_agent_accepted_suggestions`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
|
||||
Blackbox Merge features a novel [tracking system](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#suggestion-tracking) that automatically detects when PR authors implement AI-generated code suggestions.
|
||||
All accepted suggestions are aggregated in a repository-specific wiki page called [`.pr_agent_accepted_suggestions`](https://github.com/Blackbox-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
|
||||
|
||||
### Learning and Applying Auto Best Practices
|
||||
|
||||
Monthly, Qodo Merge analyzes the collection of accepted suggestions to generate repository-specific best practices, stored in [`.pr_agent_auto_best_practices`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_auto_best_practices) wiki file.
|
||||
Monthly, Blackbox Merge analyzes the collection of accepted suggestions to generate repository-specific best practices, stored in [`.pr_agent_auto_best_practices`](https://github.com/Blackbox-ai/pr-agent/wiki/.pr_agent_auto_best_practices) wiki file.
|
||||
These best practices reflect recurring patterns in accepted code improvements.
|
||||
|
||||
The `improve` tool will incorporate these best practices as an additional analysis layer, checking PR code changes against known patterns of previously accepted improvements.
|
||||
|
|
@ -33,15 +33,15 @@ This creates a two-phase analysis:
|
|||
|
||||
By keeping these phases decoupled, the tool remains free to discover new or unseen issues and problems, while also learning from past experiences.
|
||||
|
||||
When presenting the suggestions generated by the `improve` tool, Qodo Merge will add a dedicated label for each suggestion generated from the auto best practices - 'Learned best practice':
|
||||
When presenting the suggestions generated by the `improve` tool, Blackbox Merge will add a dedicated label for each suggestion generated from the auto best practices - 'Learned best practice':
|
||||
|
||||
{width=684}
|
||||
{width=684}
|
||||
|
||||
## Auto Best Practices vs Custom Best Practices
|
||||
|
||||
Teams and companies can also manually define their own [custom best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) in Qodo Merge.
|
||||
Teams and companies can also manually define their own [custom best practices](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#best-practices) in Blackbox Merge.
|
||||
|
||||
When custom best practices exist, Qodo Merge will use both the auto-generated best practices and your custom best practices together. The auto best practices file provides additional insights derived from suggestions your team found valuable enough to implement, while also demonstrating effective patterns for writing AI-friendly best practices.
|
||||
When custom best practices exist, Blackbox Merge will use both the auto-generated best practices and your custom best practices together. The auto best practices file provides additional insights derived from suggestions your team found valuable enough to implement, while also demonstrating effective patterns for writing AI-friendly best practices.
|
||||
|
||||
We recommend utilizing both auto and custom best practices to get the most comprehensive code improvement suggestions for your team.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## Overview
|
||||
|
||||
Qodo Merge implements an orchestrator agent that enables interactive code discussions, listening and responding to comments without requiring explicit tool calls.
|
||||
Blackbox Merge implements an orchestrator agent that enables interactive code discussions, listening and responding to comments without requiring explicit tool calls.
|
||||
The orchestrator intelligently analyzes your responses to determine if you want to implement a suggestion, ask a question, or request help, then delegates to the appropriate specialized tool.
|
||||
|
||||
To minimize unnecessary notifications and maintain focused discussions, the orchestrator agent will only respond to comments made directly within the inline code suggestion discussions it has created (`/improve`) or within discussions initiated by the `/implement` command.
|
||||
|
|
@ -28,7 +28,7 @@ enable_chat_in_code_suggestions = true
|
|||
To obtain dynamic responses, the following steps are required:
|
||||
|
||||
1. Run the `/improve` command (mostly automatic)
|
||||
2. Check the `/improve` recommendation checkboxes (_Apply this suggestion_) to have Qodo Merge generate a new inline code suggestion discussion
|
||||
2. Check the `/improve` recommendation checkboxes (_Apply this suggestion_) to have Blackbox Merge generate a new inline code suggestion discussion
|
||||
3. The orchestrator agent will then automatically listen to and reply to comments within the discussion without requiring additional commands
|
||||
|
||||
#### `/implement`
|
||||
|
|
@ -36,7 +36,7 @@ To obtain dynamic responses, the following steps are required:
|
|||
To obtain dynamic responses, the following steps are required:
|
||||
|
||||
1. Select code lines in the PR diff and run the `/implement` command
|
||||
2. Wait for Qodo Merge to generate a new inline code suggestion
|
||||
2. Wait for Blackbox Merge to generate a new inline code suggestion
|
||||
3. The orchestrator agent will then automatically listen to and reply to comments within the discussion without requiring additional commands
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
The Git environment usually represents the final stage before code enters production. Hence, Detecting bugs and issues during the review process is critical.
|
||||
|
||||
The [`improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) tool provides actionable code suggestions for your pull requests, aiming to help detect and fix bugs and problems.
|
||||
The [`improve`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/) tool provides actionable code suggestions for your pull requests, aiming to help detect and fix bugs and problems.
|
||||
By default, suggestions appear as a comment in a table format:
|
||||
|
||||
{width=512}
|
||||
|
|
@ -21,25 +21,25 @@ This approach allows to fix issues without returning to your IDE for manual edit
|
|||
|
||||
However, committing a suggestion in a Git environment carries more risk than in a local IDE, as you don't have the opportunity to fully run and test the code before committing.
|
||||
|
||||
To balance convenience with safety, Qodo Merge implements a dual validation system for each generated code suggestion:
|
||||
To balance convenience with safety, Blackbox Merge implements a dual validation system for each generated code suggestion:
|
||||
|
||||
1) **Localization** - Qodo Merge confirms that the suggestion's line numbers and surrounding code, as predicted by the model, actually match the repo code. This means that the model correctly identified the context and location of the code to be changed.
|
||||
1) **Localization** - Blackbox Merge confirms that the suggestion's line numbers and surrounding code, as predicted by the model, actually match the repo code. This means that the model correctly identified the context and location of the code to be changed.
|
||||
|
||||
2) **"Compilation"** - Using static code analysis, Qodo Merge verifies that after applying the suggestion, the modified file will still be valid, meaning tree-sitter syntax processing will not throw an error. This process is relevant for multiple programming languages, see [here](https://pypi.org/project/tree-sitter-languages/) for the full list of supported languages.
|
||||
2) **"Compilation"** - Using static code analysis, Blackbox Merge verifies that after applying the suggestion, the modified file will still be valid, meaning tree-sitter syntax processing will not throw an error. This process is relevant for multiple programming languages, see [here](https://pypi.org/project/tree-sitter-languages/) for the full list of supported languages.
|
||||
|
||||
When a suggestion fails to meet these validation criteria, it may still provide valuable feedback, but isn't suitable for direct application to the PR.
|
||||
In such cases, Qodo Merge will omit the 'apply' checkbox and instead display:
|
||||
In such cases, Blackbox Merge will omit the 'apply' checkbox and instead display:
|
||||
|
||||
`[To ensure code accuracy, apply this suggestion manually]`
|
||||
|
||||
All suggestions that pass these validations undergo a final stage of **self-reflection**, where the AI model evaluates, scores, and re-ranks its own suggestions, eliminating any that are irrelevant or incorrect.
|
||||
Read more about this process in the [self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) page.
|
||||
Read more about this process in the [self-reflection](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/self_reflection/) page.
|
||||
|
||||
## Conclusion
|
||||
|
||||
The validation methods described above enhance the reliability of code suggestions and help PR authors determine which suggestions are safer to apply in the Git environment.
|
||||
Of course, additional factors should be considered, such as suggestion complexity and potential code impact.
|
||||
|
||||
Human judgment remains essential. After clicking 'apply', Qodo Merge still presents the 'before' and 'after' code snippets for review, allowing you to assess the changes before finalizing the commit.
|
||||
Human judgment remains essential. After clicking 'apply', Blackbox Merge still presents the 'before' and 'after' code snippets for review, allowing you to assess the changes before finalizing the commit.
|
||||
|
||||
{width=512}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
|
||||
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
Qodo Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests.
|
||||
Blackbox Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests.
|
||||
It provides more context before changes than after, and dynamically adjusts the context based on code structure (e.g., enclosing functions or classes).
|
||||
This approach balances providing sufficient context for accurate analysis, while avoiding needle-in-the-haystack information overload that could degrade AI performance or exceed token limits.
|
||||
|
||||
|
|
@ -45,14 +45,14 @@ Pull requests often encompass multiple changes across many files, potentially sp
|
|||
|
||||
## Asymmetric and dynamic context
|
||||
|
||||
To address these challenges, Qodo Merge employs an **asymmetric** and **dynamic** context strategy, providing the model with more focused and relevant context information for each code change.
|
||||
To address these challenges, Blackbox Merge employs an **asymmetric** and **dynamic** context strategy, providing the model with more focused and relevant context information for each code change.
|
||||
|
||||
**Asymmetric:**
|
||||
|
||||
We start by recognizing that the context preceding a code change is typically more crucial for understanding the modification than the context following it.
|
||||
Consequently, Qodo Merge implements an asymmetric context policy, decoupling the context window into two distinct segments: one for the code before the change and another for the code after.
|
||||
Consequently, Blackbox Merge implements an asymmetric context policy, decoupling the context window into two distinct segments: one for the code before the change and another for the code after.
|
||||
|
||||
By independently adjusting each context window, Qodo Merge can supply the model with a more tailored and pertinent context for individual code changes.
|
||||
By independently adjusting each context window, Blackbox Merge can supply the model with a more tailored and pertinent context for individual code changes.
|
||||
|
||||
**Dynamic:**
|
||||
|
||||
|
|
|
|||
|
|
@ -4,15 +4,15 @@
|
|||
|
||||
## Overview
|
||||
|
||||
Qodo Merge streamlines code review workflows by seamlessly connecting with multiple ticket management systems.
|
||||
Blackbox Merge streamlines code review workflows by seamlessly connecting with multiple ticket management systems.
|
||||
This integration enriches the review process by automatically surfacing relevant ticket information and context alongside code changes.
|
||||
|
||||
**Ticket systems supported**:
|
||||
|
||||
- [GitHub/Gitlab Issues](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#githubgitlab-issues-integration)
|
||||
- [Jira (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration)
|
||||
- [Linear (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#linear-integration)
|
||||
- [Monday (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#monday-integration)
|
||||
- [GitHub/Gitlab Issues](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/#githubgitlab-issues-integration)
|
||||
- [Jira (💎)](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/#jira-integration)
|
||||
- [Linear (💎)](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/#linear-integration)
|
||||
- [Monday (💎)](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/#monday-integration)
|
||||
|
||||
**Ticket data fetched:**
|
||||
|
||||
|
|
@ -28,11 +28,11 @@ This integration enriches the review process by automatically surfacing relevant
|
|||
Ticket Recognition Requirements:
|
||||
|
||||
- The PR description should contain a link to the ticket or if the branch name starts with the ticket id / number.
|
||||
- For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.
|
||||
- For Jira tickets, you should follow the instructions in [Jira Integration](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.
|
||||
|
||||
### Describe tool
|
||||
|
||||
Qodo Merge will recognize the ticket and use the ticket content (title, description, labels) to provide additional context for the code changes.
|
||||
Blackbox Merge will recognize the ticket and use the ticket content (title, description, labels) to provide additional context for the code changes.
|
||||
By understanding the reasoning and intent behind modifications, the LLM can offer more insightful and relevant code analysis.
|
||||
|
||||
### Review tool
|
||||
|
|
@ -47,7 +47,7 @@ Each ticket will be assigned a label (Compliance/Alignment level), Indicates the
|
|||
- Not Compliant
|
||||
- PR Code Verified
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
A `PR Code Verified` label indicates the PR code meets ticket requirements, but requires additional manual testing beyond the code scope. For example - validating UI display across different environments (Mac, Windows, mobile, etc.).
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ A `PR Code Verified` label indicates the PR code meets ticket requirements, but
|
|||
|
||||
## GitHub/Gitlab Issues Integration
|
||||
|
||||
Qodo Merge will automatically recognize GitHub/Gitlab issues mentioned in the PR description and fetch the issue content.
|
||||
Blackbox Merge will automatically recognize GitHub/Gitlab issues mentioned in the PR description and fetch the issue content.
|
||||
Examples of valid GitHub/Gitlab issue references:
|
||||
|
||||
- `https://github.com/<ORG_NAME>/<REPO_NAME>/issues/<ISSUE_NUMBER>` or `https://gitlab.com/<ORG_NAME>/<REPO_NAME>/-/issues/<ISSUE_NUMBER>`
|
||||
|
|
@ -87,7 +87,7 @@ Examples of valid GitHub/Gitlab issue references:
|
|||
Branch names can also be used to link issues, for example:
|
||||
- `123-fix-bug` (where `123` is the issue number)
|
||||
|
||||
Since Qodo Merge is integrated with GitHub, it doesn't require any additional configuration to fetch GitHub issues.
|
||||
Since Blackbox Merge is integrated with GitHub, it doesn't require any additional configuration to fetch GitHub issues.
|
||||
|
||||
## Jira Integration 💎
|
||||
|
||||
|
|
@ -99,21 +99,21 @@ There are two ways to authenticate with Jira Cloud:
|
|||
|
||||
**1) Jira App Authentication**
|
||||
|
||||
The recommended way to authenticate with Jira Cloud is to install the Qodo Merge app in your Jira Cloud instance. This will allow Qodo Merge to access Jira data on your behalf.
|
||||
The recommended way to authenticate with Jira Cloud is to install the Blackbox Merge app in your Jira Cloud instance. This will allow Blackbox Merge to access Jira data on your behalf.
|
||||
|
||||
Installation steps:
|
||||
|
||||
1. Go to the [Qodo Merge integrations page](https://app.qodo.ai/qodo-merge/integrations)
|
||||
1. Go to the [Blackbox Merge integrations page](https://app.Blackbox.ai/Blackbox-merge/integrations)
|
||||
|
||||
2. Click on the Connect **Jira Cloud** button to connect the Jira Cloud app
|
||||
|
||||
3. Click the `accept` button.<br>
|
||||
{width=384}
|
||||
{width=384}
|
||||
|
||||
4. After installing the app, you will be redirected to the Qodo Merge registration page. and you will see a success message.<br>
|
||||
{width=384}
|
||||
4. After installing the app, you will be redirected to the Blackbox Merge registration page. and you will see a success message.<br>
|
||||
{width=384}
|
||||
|
||||
5. Now Qodo Merge will be able to fetch Jira ticket context for your PRs.
|
||||
5. Now Blackbox Merge will be able to fetch Jira ticket context for your PRs.
|
||||
|
||||
**2) Email/Token Authentication**
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ You can create an API token from your Atlassian account:
|
|||
|
||||
{width=384}
|
||||
|
||||
5. In your [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) add the following lines:
|
||||
5. In your [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/) add the following lines:
|
||||
|
||||
```toml
|
||||
[jira]
|
||||
|
|
@ -140,7 +140,7 @@ jira_api_email = "YOUR_EMAIL"
|
|||
### Jira Data Center/Server
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (##### Local App Authentication (For Qodo Merge On-Premise Customers))
|
||||
[//]: # (##### Local App Authentication (For Blackbox Merge On-Premise Customers))
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (##### 1. Step 1: Set up an application link in Jira Data Center/Server)
|
||||
|
|
@ -148,30 +148,30 @@ jira_api_email = "YOUR_EMAIL"
|
|||
[//]: # (* Go to Jira Administration > Applications > Application Links > Click on `Create link`)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ({width=384})
|
||||
[//]: # ({width=384})
|
||||
|
||||
[//]: # (* Choose `External application` and set the direction to `Incoming` and then click `Continue`)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ({width=256})
|
||||
[//]: # ({width=256})
|
||||
|
||||
[//]: # (* In the following screen, enter the following details:)
|
||||
|
||||
[//]: # ( * Name: `Qodo Merge`)
|
||||
[//]: # ( * Name: `Blackbox Merge`)
|
||||
|
||||
[//]: # ( * Redirect URL: Enter your Qodo Merge URL followed `https://{QODO_MERGE_ENDPOINT}/register_ticket_provider`)
|
||||
[//]: # ( * Redirect URL: Enter your Blackbox Merge URL followed `https://{Blackbox_MERGE_ENDPOINT}/register_ticket_provider`)
|
||||
|
||||
[//]: # ( * Permission: Select `Read`)
|
||||
|
||||
[//]: # ( * Click `Save`)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ({width=384})
|
||||
[//]: # ({width=384})
|
||||
|
||||
[//]: # (* Copy the `Client ID` and `Client secret` and set them in your `.secrets` file:)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ({width=256})
|
||||
[//]: # ({width=256})
|
||||
|
||||
[//]: # (```toml)
|
||||
|
||||
|
|
@ -186,17 +186,17 @@ jira_api_email = "YOUR_EMAIL"
|
|||
[//]: # ()
|
||||
[//]: # (##### 2. Step 2: Authenticate with Jira Data Center/Server)
|
||||
|
||||
[//]: # (* Open this URL in your browser: `https://{QODO_MERGE_ENDPOINT}/jira_auth`)
|
||||
[//]: # (* Open this URL in your browser: `https://{Blackbox_MERGE_ENDPOINT}/jira_auth`)
|
||||
|
||||
[//]: # (* Click on link)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ({width=384})
|
||||
[//]: # ({width=384})
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (* You will be redirected to Jira Data Center/Server, click `Allow`)
|
||||
|
||||
[//]: # (* You will be redirected back to Qodo Merge and you will see a success message.)
|
||||
[//]: # (* You will be redirected back to Blackbox Merge and you will see a success message.)
|
||||
|
||||
[//]: # (Personal Access Token (PAT) Authentication)
|
||||
|
||||
|
|
@ -215,7 +215,7 @@ jira_api_token = "your_password"
|
|||
|
||||
##### Validating Basic authentication via Python script
|
||||
|
||||
If you are facing issues retrieving tickets in Qodo Merge with Basic auth, you can validate the flow using a Python script.
|
||||
If you are facing issues retrieving tickets in Blackbox Merge with Basic auth, you can validate the flow using a Python script.
|
||||
This following steps will help you check if the basic auth is working correctly, and if you can access the Jira ticket details:
|
||||
|
||||
1. run `pip install jira==3.8.0`
|
||||
|
|
@ -271,7 +271,7 @@ jira_api_token = "YOUR_API_TOKEN"
|
|||
|
||||
##### Validating PAT token via Python script
|
||||
|
||||
If you are facing issues retrieving tickets in Qodo Merge with PAT token, you can validate the flow using a Python script.
|
||||
If you are facing issues retrieving tickets in Blackbox Merge with PAT token, you can validate the flow using a Python script.
|
||||
This following steps will help you check if the token is working correctly, and if you can access the Jira ticket details:
|
||||
|
||||
1. run `pip install jira==3.8.0`
|
||||
|
|
@ -316,7 +316,7 @@ This following steps will help you check if the token is working correctly, and
|
|||
|
||||
### Multi-JIRA Server Configuration 💎
|
||||
|
||||
Qodo Merge supports connecting to multiple JIRA servers using different authentication methods.
|
||||
Blackbox Merge supports connecting to multiple JIRA servers using different authentication methods.
|
||||
|
||||
=== "Email/Token (Basic Auth)"
|
||||
|
||||
|
|
@ -377,7 +377,7 @@ Qodo Merge supports connecting to multiple JIRA servers using different authenti
|
|||
|
||||
For Jira Cloud instances using App Authentication:
|
||||
|
||||
1. Install the Qodo Merge app on each JIRA Cloud instance you want to connect to
|
||||
1. Install the Blackbox Merge app on each JIRA Cloud instance you want to connect to
|
||||
2. Set the default server for ticket ID resolution:
|
||||
|
||||
```toml
|
||||
|
|
@ -415,23 +415,23 @@ Name your branch with the ticket ID as a prefix (e.g., `ISSUE-123-feature-descri
|
|||
|
||||
### Linear App Authentication
|
||||
|
||||
The recommended way to authenticate with Linear is to connect the Linear app through the Qodo Merge portal.
|
||||
The recommended way to authenticate with Linear is to connect the Linear app through the Blackbox Merge portal.
|
||||
|
||||
Installation steps:
|
||||
|
||||
1. Go to the [Qodo Merge integrations page](https://app.qodo.ai/qodo-merge/integrations)
|
||||
1. Go to the [Blackbox Merge integrations page](https://app.Blackbox.ai/Blackbox-merge/integrations)
|
||||
|
||||
2. Navigate to the **Integrations** tab
|
||||
|
||||
3. Click on the **Linear** button to connect the Linear app
|
||||
|
||||
4. Follow the authentication flow to authorize Qodo Merge to access your Linear workspace
|
||||
4. Follow the authentication flow to authorize Blackbox Merge to access your Linear workspace
|
||||
|
||||
5. Once connected, Qodo Merge will be able to fetch Linear ticket context for your PRs
|
||||
5. Once connected, Blackbox Merge will be able to fetch Linear ticket context for your PRs
|
||||
|
||||
### How to link a PR to a Linear ticket
|
||||
|
||||
Qodo Merge will automatically detect Linear tickets using either of these methods:
|
||||
Blackbox Merge will automatically detect Linear tickets using either of these methods:
|
||||
|
||||
**Method 1: Description Reference:**
|
||||
|
||||
|
|
@ -456,20 +456,20 @@ Name your branch with the ticket ID as a prefix (e.g., `ABC-123-feature-descript
|
|||
## Monday Integration 💎
|
||||
|
||||
### Monday App Authentication
|
||||
The recommended way to authenticate with Monday is to connect the Monday app through the Qodo Merge portal.
|
||||
The recommended way to authenticate with Monday is to connect the Monday app through the Blackbox Merge portal.
|
||||
|
||||
Installation steps:
|
||||
|
||||
1. Go to the [Qodo Merge integrations page](https://app.qodo.ai/qodo-merge/integrations)
|
||||
1. Go to the [Blackbox Merge integrations page](https://app.Blackbox.ai/Blackbox-merge/integrations)
|
||||
2. Navigate to the **Integrations** tab
|
||||
3. Click on the **Monday** button to connect the Monday app
|
||||
4. Follow the authentication flow to authorize Qodo Merge to access your Monday workspace
|
||||
5. Once connected, Qodo Merge will be able to fetch Monday ticket context for your PRs
|
||||
4. Follow the authentication flow to authorize Blackbox Merge to access your Monday workspace
|
||||
5. Once connected, Blackbox Merge will be able to fetch Monday ticket context for your PRs
|
||||
|
||||
### Monday Ticket Context
|
||||
`Ticket Context and Ticket Compliance are supported for Monday items, but not yet available in the "PR to Ticket" feature.`
|
||||
|
||||
When Qodo Merge processes your PRs, it extracts the following information from Monday items:
|
||||
When Blackbox Merge processes your PRs, it extracts the following information from Monday items:
|
||||
|
||||
* **Item ID and Name:** The unique identifier and title of the Monday item
|
||||
* **Item URL:** Direct link to the Monday item in your workspace
|
||||
|
|
@ -478,7 +478,7 @@ When Qodo Merge processes your PRs, it extracts the following information from M
|
|||
* **Sub-items:** Names, IDs, and descriptions of all related sub-items with hierarchical structure
|
||||
|
||||
### How Monday Items are Detected
|
||||
Qodo Merge automatically detects Monday items from:
|
||||
Blackbox Merge automatically detects Monday items from:
|
||||
|
||||
* PR Descriptions: Full Monday URLs like https://workspace.monday.com/boards/123/pulses/456
|
||||
* Branch Names: Item IDs in branch names (6-12 digit patterns) - requires `monday_base_url` configuration
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ High-level code suggestions, generated by the `improve` tool, offer big-picture
|
|||
### How it works
|
||||
|
||||
=== "Example of a high-level suggestion"
|
||||
{width=512}
|
||||
{width=512}
|
||||
{width=512}
|
||||
{width=512}
|
||||
|
||||
___
|
||||
|
||||
|
|
|
|||
|
|
@ -3,47 +3,47 @@
|
|||
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
Demonstrating the return on investment (ROI) of AI-powered initiatives is crucial for modern organizations.
|
||||
To address this need, Qodo Merge has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process.
|
||||
To address this need, Blackbox Merge has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process.
|
||||
|
||||
## Auto Impact Validator - Real-Time Tracking of Implemented Qodo Merge Suggestions
|
||||
## Auto Impact Validator - Real-Time Tracking of Implemented Blackbox Merge Suggestions
|
||||
|
||||
### How It Works
|
||||
|
||||
When a user pushes a new commit to the pull request, Qodo Merge automatically compares the updated code against the previous suggestions, marking them as implemented if the changes address these recommendations, whether directly or indirectly:
|
||||
When a user pushes a new commit to the pull request, Blackbox Merge automatically compares the updated code against the previous suggestions, marking them as implemented if the changes address these recommendations, whether directly or indirectly:
|
||||
|
||||
1. **Direct Implementation:** The user directly addresses the suggestion as-is in the PR, either by clicking on the "apply code suggestion" checkbox or by making the changes manually.
|
||||
2. **Indirect Implementation:** Qodo Merge recognizes when a suggestion's intent is fulfilled, even if the exact code changes differ from the original recommendation. It marks these suggestions as implemented, acknowledging that users may achieve the same goal through alternative solutions.
|
||||
2. **Indirect Implementation:** Blackbox Merge recognizes when a suggestion's intent is fulfilled, even if the exact code changes differ from the original recommendation. It marks these suggestions as implemented, acknowledging that users may achieve the same goal through alternative solutions.
|
||||
|
||||
### Real-Time Visual Feedback
|
||||
|
||||
Upon confirming that a suggestion was implemented, Qodo Merge automatically adds a ✅ (check mark) to the relevant suggestion, enabling transparent tracking of Qodo Merge's impact analysis.
|
||||
Qodo Merge will also add, inside the relevant suggestions, an explanation of how the new code was impacted by each suggestion.
|
||||
Upon confirming that a suggestion was implemented, Blackbox Merge automatically adds a ✅ (check mark) to the relevant suggestion, enabling transparent tracking of Blackbox Merge's impact analysis.
|
||||
Blackbox Merge will also add, inside the relevant suggestions, an explanation of how the new code was impacted by each suggestion.
|
||||
|
||||
{width=512}
|
||||
|
||||
### Dashboard Metrics
|
||||
|
||||
The dashboard provides macro-level insights into the overall impact of Qodo Merge on the pull-request process with key productivity metrics.
|
||||
The dashboard provides macro-level insights into the overall impact of Blackbox Merge on the pull-request process with key productivity metrics.
|
||||
|
||||
By offering clear, data-driven evidence of Qodo Merge's impact, it empowers leadership teams to make informed decisions about the tool's effectiveness and ROI.
|
||||
By offering clear, data-driven evidence of Blackbox Merge's impact, it empowers leadership teams to make informed decisions about the tool's effectiveness and ROI.
|
||||
|
||||
Here are key metrics that the dashboard tracks:
|
||||
|
||||
#### Qodo Merge Impacts per 1K Lines
|
||||
#### Blackbox Merge Impacts per 1K Lines
|
||||
|
||||
{width=512}
|
||||
> Explanation: for every 1K lines of code (additions/edits), Qodo Merge had on average ~X suggestions implemented.
|
||||
> Explanation: for every 1K lines of code (additions/edits), Blackbox Merge had on average ~X suggestions implemented.
|
||||
|
||||
**Why This Metric Matters:**
|
||||
|
||||
1. **Standardized and Comparable Measurement:** By measuring impacts per 1K lines of code additions, you create a standardized metric that can be compared across different projects, teams, customers, and time periods. This standardization is crucial for meaningful analysis, benchmarking, and identifying where Qodo Merge is most effective.
|
||||
1. **Standardized and Comparable Measurement:** By measuring impacts per 1K lines of code additions, you create a standardized metric that can be compared across different projects, teams, customers, and time periods. This standardization is crucial for meaningful analysis, benchmarking, and identifying where Blackbox Merge is most effective.
|
||||
2. **Accounts for PR Variability and Incentivizes Quality:** This metric addresses the fact that "Not all PRs are created equal." By normalizing against lines of code rather than PR count, you account for the variability in PR sizes and focus on the quality and impact of suggestions rather than just the number of PRs affected.
|
||||
3. **Quantifies Value and ROI:** The metric directly correlates with the value Qodo Merge is providing, showing how frequently it offers improvements relative to the amount of new code being written. This provides a clear, quantifiable way to demonstrate Qodo Merge's return on investment to stakeholders.
|
||||
3. **Quantifies Value and ROI:** The metric directly correlates with the value Blackbox Merge is providing, showing how frequently it offers improvements relative to the amount of new code being written. This provides a clear, quantifiable way to demonstrate Blackbox Merge's return on investment to stakeholders.
|
||||
|
||||
#### Suggestion Effectiveness Across Categories
|
||||
|
||||
{width=512}
|
||||
> Explanation: This chart illustrates the distribution of implemented suggestions across different categories, enabling teams to better understand Qodo Merge's impact on various aspects of code quality and development practices.
|
||||
> Explanation: This chart illustrates the distribution of implemented suggestions across different categories, enabling teams to better understand Blackbox Merge's impact on various aspects of code quality and development practices.
|
||||
|
||||
#### Suggestion Score Distribution
|
||||
|
||||
|
|
|
|||
|
|
@ -8,10 +8,10 @@ The Incremental Update feature helps users focus on feedback for their newest ch
|
|||
### How it works
|
||||
|
||||
=== "Update Option on Subsequent Commits"
|
||||
{width=512}
|
||||
{width=512}
|
||||
|
||||
=== "Generation of Incremental Update"
|
||||
{width=512}
|
||||
{width=512}
|
||||
|
||||
___
|
||||
|
||||
|
|
|
|||
|
|
@ -1,39 +1,39 @@
|
|||
# Core Abilities
|
||||
|
||||
Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include:
|
||||
Blackbox Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include:
|
||||
|
||||
- [Auto approval](https://qodo-merge-docs.qodo.ai/core-abilities/auto_approval/)
|
||||
- [Auto best practices](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/)
|
||||
- [Chat on code suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/chat_on_code_suggestions/)
|
||||
- [Chrome extension](https://qodo-merge-docs.qodo.ai/chrome-extension/)
|
||||
- [Code validation](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) <!-- - [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) -->
|
||||
- [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)
|
||||
- [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
|
||||
- [High-level Suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/high_level_suggestions/)
|
||||
- [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/)
|
||||
- [Incremental Update](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/)
|
||||
- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
|
||||
- [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)
|
||||
- [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/)
|
||||
- [Self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/)
|
||||
- [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/)
|
||||
- [Auto approval](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/auto_approval/)
|
||||
- [Auto best practices](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/auto_best_practices/)
|
||||
- [Chat on code suggestions](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/chat_on_code_suggestions/)
|
||||
- [Chrome extension](https://Blackbox-merge-docs.Blackbox.ai/chrome-extension/)
|
||||
- [Code validation](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/code_validation/) <!-- - [Compression strategy](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/compression_strategy/) -->
|
||||
- [Dynamic context](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/dynamic_context/)
|
||||
- [Fetching ticket context](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/)
|
||||
- [High-level Suggestions](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/high_level_suggestions/)
|
||||
- [Impact evaluation](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/impact_evaluation/)
|
||||
- [Incremental Update](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/incremental_update/)
|
||||
- [Interactivity](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/interactivity/)
|
||||
- [Local and global metadata](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/metadata/)
|
||||
- [RAG context enrichment](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/rag_context_enrichment/)
|
||||
- [Self-reflection](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/self_reflection/)
|
||||
- [Static code analysis](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/static_code_analysis/)
|
||||
|
||||
## Blogs
|
||||
|
||||
Here are some additional technical blogs from Qodo, that delve deeper into the core capabilities and features of Large Language Models (LLMs) when applied to coding tasks.
|
||||
Here are some additional technical blogs from Blackbox, that delve deeper into the core capabilities and features of Large Language Models (LLMs) when applied to coding tasks.
|
||||
These resources provide more comprehensive insights into leveraging LLMs for software development.
|
||||
|
||||
### Code Generation and LLMs
|
||||
|
||||
- [Effective AI code suggestions: less is more](https://www.qodo.ai/blog/effective-code-suggestions-llms-less-is-more/)
|
||||
- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.qodo.ai/blog/qodoflow-state-of-the-art-code-generation-for-code-contests/)
|
||||
- [RAG for a Codebase with 10k Repos](https://www.qodo.ai/blog/rag-for-large-scale-code-repos/)
|
||||
- [Effective AI code suggestions: less is more](https://www.Blackbox.ai/blog/effective-code-suggestions-llms-less-is-more/)
|
||||
- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.Blackbox.ai/blog/Blackboxflow-state-of-the-art-code-generation-for-code-contests/)
|
||||
- [RAG for a Codebase with 10k Repos](https://www.Blackbox.ai/blog/rag-for-large-scale-code-repos/)
|
||||
|
||||
### Development Processes
|
||||
|
||||
- [Understanding the Challenges and Pain Points of the Pull Request Cycle](https://www.qodo.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
|
||||
- [Introduction to Code Coverage Testing](https://www.qodo.ai/blog/introduction-to-code-coverage-testing/)
|
||||
- [Understanding the Challenges and Pain Points of the Pull Request Cycle](https://www.Blackbox.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
|
||||
- [Introduction to Code Coverage Testing](https://www.Blackbox.ai/blog/introduction-to-code-coverage-testing/)
|
||||
|
||||
### Cost Optimization
|
||||
|
||||
- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)
|
||||
- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.Blackbox.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## Overview
|
||||
|
||||
Qodo Merge transforms static code reviews into interactive experiences by enabling direct actions from pull request (PR) comments.
|
||||
Blackbox Merge transforms static code reviews into interactive experiences by enabling direct actions from pull request (PR) comments.
|
||||
Developers can immediately trigger actions and apply changes with simple checkbox clicks.
|
||||
|
||||
This focused workflow maintains context while dramatically reducing the time between PR creation and final merge.
|
||||
|
|
@ -14,7 +14,7 @@ The approach eliminates manual steps, provides clear visual indicators, and crea
|
|||
|
||||
### 1\. Interactive `/improve` Tool
|
||||
|
||||
The [`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) command delivers a comprehensive interactive experience:
|
||||
The [`/improve`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/) command delivers a comprehensive interactive experience:
|
||||
|
||||
- _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change. When committed to the PR, changes made to code that was flagged for improvement will be marked with a check mark, allowing developers to easily track and review implemented recommendations.
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ The [`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) command deliver
|
|||
|
||||
### 2\. Interactive `/analyze` Tool
|
||||
|
||||
The [`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) command provides component-level analysis with interactive options for each identified code component:
|
||||
The [`/analyze`](https://Blackbox-merge-docs.Blackbox.ai/tools/analyze/) command provides component-level analysis with interactive options for each identified code component:
|
||||
|
||||
- Interactive checkboxes to generate tests, documentation, and code suggestions for specific components
|
||||
|
||||
|
|
@ -36,6 +36,6 @@ The [`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) command provide
|
|||
|
||||
### 3\. Interactive `/help` Tool
|
||||
|
||||
The [`/help`](https://qodo-merge-docs.qodo.ai/tools/help/) command not only lists available tools and their descriptions but also enables immediate tool invocation through interactive checkboxes.
|
||||
When a user checks a tool's checkbox, Qodo Merge instantly triggers that tool without requiring additional commands.
|
||||
This transforms the standard help menu into an interactive launch pad for all Qodo Merge capabilities, eliminating context switching by keeping developers within their PR workflow.
|
||||
The [`/help`](https://Blackbox-merge-docs.Blackbox.ai/tools/help/) command not only lists available tools and their descriptions but also enables immediate tool invocation through interactive checkboxes.
|
||||
When a user checks a tool's checkbox, Blackbox Merge instantly triggers that tool without requiring additional commands.
|
||||
This transforms the standard help menu into an interactive launch pad for all Blackbox Merge capabilities, eliminating context switching by keeping developers within their PR workflow.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
1\.
|
||||
Qodo Merge initially retrieves for each PR the following data:
|
||||
Blackbox Merge initially retrieves for each PR the following data:
|
||||
|
||||
- PR title and branch name
|
||||
- PR original description
|
||||
|
|
@ -12,10 +12,10 @@ Qodo Merge initially retrieves for each PR the following data:
|
|||
- The entire content of the files that were modified in the PR
|
||||
|
||||
!!! tip "Tip: Organization-level metadata"
|
||||
In addition to the inputs above, Qodo Merge can incorporate supplementary preferences provided by the user, like [`extra_instructions` and `organization best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices). This information can be used to enhance the PR analysis.
|
||||
In addition to the inputs above, Blackbox Merge can incorporate supplementary preferences provided by the user, like [`extra_instructions` and `organization best practices`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#extra-instructions-and-best-practices). This information can be used to enhance the PR analysis.
|
||||
|
||||
2\.
|
||||
By default, the first command that Qodo Merge executes is [`describe`](https://qodo-merge-docs.qodo.ai/tools/describe/), which generates three types of outputs:
|
||||
By default, the first command that Blackbox Merge executes is [`describe`](https://Blackbox-merge-docs.Blackbox.ai/tools/describe/), which generates three types of outputs:
|
||||
|
||||
- PR Type (e.g. bug fix, feature, refactor, etc)
|
||||
- PR Description - a bullet point summary of the PR
|
||||
|
|
@ -24,7 +24,7 @@ By default, the first command that Qodo Merge executes is [`describe`](https://q
|
|||
These AI-generated outputs are now considered as part of the PR metadata, and can be used in subsequent commands like `review` and `improve`.
|
||||
This effectively enables multi-stage chain-of-thought analysis, without doing any additional API calls which will cost time and money.
|
||||
|
||||
For example, when generating code suggestions for different files, Qodo Merge can inject the AI-generated ["Changes walkthrough"](https://github.com/Codium-ai/pr-agent/pull/1202#issue-2511546839) file summary in the prompt:
|
||||
For example, when generating code suggestions for different files, Blackbox Merge can inject the AI-generated ["Changes walkthrough"](https://github.com/Codium-ai/pr-agent/pull/1202#issue-2511546839) file summary in the prompt:
|
||||
|
||||
```diff
|
||||
## File: 'src/file1.py'
|
||||
|
|
@ -52,7 +52,7 @@ __old hunk__
|
|||
...
|
||||
```
|
||||
|
||||
3\. The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)).
|
||||
3\. The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/dynamic_context/)).
|
||||
|
||||
4\. All the metadata described above represents several level of cumulative analysis - ranging from hunk level, to file level, to PR level, to organization level.
|
||||
This comprehensive approach enables Qodo Merge AI models to generate more precise and contextually relevant suggestions and feedback.
|
||||
This comprehensive approach enables Blackbox Merge AI models to generate more precise and contextually relevant suggestions and feedback.
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
`Supported Git Platforms: GitHub, GitLab, Bitbucket, Bitbucket Data Center`
|
||||
|
||||
!!! info "Prerequisites"
|
||||
- RAG is available only for Qodo enterprise plan users, with single tenant or on-premises setup.
|
||||
- Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.qodo.ai/contact/) for more information.
|
||||
- RAG is available only for Blackbox enterprise plan users, with single tenant or on-premises setup.
|
||||
- Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.Blackbox.ai/contact/) for more information.
|
||||
|
||||
## Overview
|
||||
|
||||
|
|
@ -45,26 +45,26 @@ enable_rag=true
|
|||
RAG capability is exclusively available in the following tools:
|
||||
|
||||
=== "`/ask`"
|
||||
The [`/ask`](https://qodo-merge-docs.qodo.ai/tools/ask/) tool can access broader repository context through the RAG feature when answering questions that go beyond the PR scope alone.
|
||||
The [`/ask`](https://Blackbox-merge-docs.Blackbox.ai/tools/ask/) tool can access broader repository context through the RAG feature when answering questions that go beyond the PR scope alone.
|
||||
The _References_ section displays the additional repository content consulted to formulate the answer.
|
||||
|
||||
{width=640}
|
||||
|
||||
|
||||
=== "`/compliance`"
|
||||
The [`/compliance`](https://qodo-merge-docs.qodo.ai/tools/compliance/) tool offers the _Codebase Code Duplication Compliance_ section which contains feedback based on the RAG references.
|
||||
The [`/compliance`](https://Blackbox-merge-docs.Blackbox.ai/tools/compliance/) tool offers the _Codebase Code Duplication Compliance_ section which contains feedback based on the RAG references.
|
||||
This section highlights possible code duplication issues in the PR, providing developers with insights into potential code quality concerns.
|
||||
|
||||
{width=640}
|
||||
|
||||
=== "`/implement`"
|
||||
The [`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/) tool utilizes the RAG feature to provide comprehensive context of the repository codebase, allowing it to generate more refined code output.
|
||||
The [`/implement`](https://Blackbox-merge-docs.Blackbox.ai/tools/implement/) tool utilizes the RAG feature to provide comprehensive context of the repository codebase, allowing it to generate more refined code output.
|
||||
The _References_ section contains links to the content used to support the code generation.
|
||||
|
||||
{width=640}
|
||||
|
||||
=== "`/review`"
|
||||
The [`/review`](https://qodo-merge-docs.qodo.ai/tools/review/) tool offers the _Focus area from RAG data_ which contains feedback based on the RAG references analysis.
|
||||
The [`/review`](https://Blackbox-merge-docs.Blackbox.ai/tools/review/) tool offers the _Focus area from RAG data_ which contains feedback based on the RAG references analysis.
|
||||
The complete list of references found relevant to the PR will be shown in the _References_ section, helping developers understand the broader context by exploring the provided references.
|
||||
|
||||
{width=640}
|
||||
|
|
@ -81,4 +81,4 @@ RAG capability is exclusively available in the following tools:
|
|||
|
||||
- **Codebase**: Must be properly indexed for search functionality
|
||||
- **Security**: Requires secure and private indexed codebase implementation
|
||||
- **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup
|
||||
- **Deployment**: Only available for Blackbox Merge Enterprise plan using single tenant or on-premises setup
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
Qodo Merge implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones.
|
||||
Blackbox Merge implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones.
|
||||
This approach improves the quality and relevance of suggestions, saving users time and enhancing their experience.
|
||||
Configuration options allow users to set a score threshold for further filtering out suggestions.
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ Configuration options allow users to set a score threshold for further filtering
|
|||
|
||||
Given that not all generated code suggestions will be relevant, it is crucial to enable users to review them in a fast and efficient way, allowing quick identification and filtering of non-applicable ones.
|
||||
|
||||
To achieve this goal, Qodo Merge offers a dedicated hierarchical structure when presenting suggestions to users:
|
||||
To achieve this goal, Blackbox Merge offers a dedicated hierarchical structure when presenting suggestions to users:
|
||||
|
||||
- A "category" section groups suggestions by their category, allowing users to quickly dismiss irrelevant suggestions.
|
||||
- Each suggestion is first described by a one-line summary, which can be expanded to a full description by clicking on a collapsible.
|
||||
|
|
@ -33,7 +33,7 @@ This process consists of the following steps:
|
|||
|
||||
Note that presenting all generated suggestions simultaneously provides the model with a comprehensive context, enabling it to make more informed decisions compared to evaluating each suggestion individually.
|
||||
|
||||
To conclude, the self-reflection process enables Qodo Merge to prioritize suggestions based on their importance, eliminate inaccurate or irrelevant proposals, and optionally exclude suggestions that fall below a specified threshold of significance.
|
||||
To conclude, the self-reflection process enables Blackbox Merge to prioritize suggestions based on their importance, eliminate inaccurate or irrelevant proposals, and optionally exclude suggestions that fall below a specified threshold of significance.
|
||||
This results in a more refined and valuable set of suggestions for the user, saving time and improving the overall experience.
|
||||
|
||||
## Example Results
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
` Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
|
||||
By combining static code analysis with LLM capabilities, Qodo Merge can provide a comprehensive analysis of the PR code changes on a component level.
|
||||
By combining static code analysis with LLM capabilities, Blackbox Merge can provide a comprehensive analysis of the PR code changes on a component level.
|
||||
|
||||
It scans the PR code changes, finds all the code components (methods, functions, classes) that changed, and enables to interactively generate tests, docs, code suggestions and similar code search for each component.
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ It scans the PR code changes, finds all the code components (methods, functions,
|
|||
|
||||
### Analyze PR
|
||||
|
||||
The [`analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) tool enables to interactively generate tests, docs, code suggestions and similar code search for each component that changed in the PR.
|
||||
The [`analyze`](https://Blackbox-merge-docs.Blackbox.ai/tools/analyze/) tool enables to interactively generate tests, docs, code suggestions and similar code search for each component that changed in the PR.
|
||||
It can be invoked manually by commenting on any PR:
|
||||
|
||||
```
|
||||
|
|
@ -29,7 +29,7 @@ Clicking on each checkbox will trigger the relevant tool for the selected compon
|
|||
|
||||
### Generate Tests
|
||||
|
||||
The [`test`](https://qodo-merge-docs.qodo.ai/tools/test/) tool generate tests for a selected component, based on the PR code changes.
|
||||
The [`test`](https://Blackbox-merge-docs.Blackbox.ai/tools/test/) tool generate tests for a selected component, based on the PR code changes.
|
||||
It can be invoked manually by commenting on any PR:
|
||||
|
||||
```
|
||||
|
|
@ -42,7 +42,7 @@ where 'component_name' is the name of a specific component in the PR, Or be tri
|
|||
|
||||
### Generate Docs for a Component
|
||||
|
||||
The [`add_docs`](https://qodo-merge-docs.qodo.ai/tools/documentation/) tool scans the PR code changes, and automatically generate docstrings for any code components that changed in the PR.
|
||||
The [`add_docs`](https://Blackbox-merge-docs.Blackbox.ai/tools/documentation/) tool scans the PR code changes, and automatically generate docstrings for any code components that changed in the PR.
|
||||
It can be invoked manually by commenting on any PR:
|
||||
|
||||
```
|
||||
|
|
@ -55,7 +55,7 @@ Or be triggered interactively by using the `analyze` tool.
|
|||
|
||||
### Generate Code Suggestions for a Component
|
||||
|
||||
The [`improve_component`](https://qodo-merge-docs.qodo.ai/tools/improve_component/) tool generates code suggestions for a specific code component that changed in the PR.
|
||||
The [`improve_component`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve_component/) tool generates code suggestions for a specific code component that changed in the PR.
|
||||
It can be invoked manually by commenting on any PR:
|
||||
|
||||
```
|
||||
|
|
@ -68,7 +68,7 @@ Or be triggered interactively by using the `analyze` tool.
|
|||
|
||||
### Find Similar Code
|
||||
|
||||
The [`similar code`](https://qodo-merge-docs.qodo.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase or from open-source code, including details about the license associated with each repository.
|
||||
The [`similar code`](https://Blackbox-merge-docs.Blackbox.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase or from open-source code, including details about the license associated with each repository.
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
# FAQ
|
||||
|
||||
??? note "Q: Can Qodo Merge serve as a substitute for a human reviewer?"
|
||||
??? note "Q: Can Blackbox Merge serve as a substitute for a human reviewer?"
|
||||
#### Answer:<span style="display:none;">1</span>
|
||||
|
||||
Qodo Merge is designed to assist, not replace, human reviewers.
|
||||
Blackbox Merge is designed to assist, not replace, human reviewers.
|
||||
|
||||
Reviewing PRs is a tedious and time-consuming task often seen as a "chore". In addition, the longer the PR – the shorter the relative feedback, since long PRs can overwhelm reviewers, both in terms of technical difficulty, and the actual review time.
|
||||
Qodo Merge aims to address these pain points, and to assist and empower both the PR author and reviewer.
|
||||
Blackbox Merge aims to address these pain points, and to assist and empower both the PR author and reviewer.
|
||||
|
||||
However, Qodo Merge has built-in safeguards to ensure the developer remains in the driver's seat. For example:
|
||||
However, Blackbox Merge has built-in safeguards to ensure the developer remains in the driver's seat. For example:
|
||||
|
||||
1. Preserves user's original PR header
|
||||
2. Places user's description above the AI-generated PR description
|
||||
|
|
@ -35,48 +35,48 @@ ___
|
|||
- Only if the `Category` header is relevant, the user should move to the summarized suggestion description.
|
||||
- Only if the summarized suggestion description is relevant, the user should click on the collapsible, to read the full suggestion description with a code preview example.
|
||||
|
||||
- In addition, we recommend to use the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project.
|
||||
- The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.
|
||||
- In addition, we recommend to use the [`extra_instructions`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project.
|
||||
- The interactive [PR chat](https://Blackbox-merge-docs.Blackbox.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.
|
||||
|
||||
___
|
||||
|
||||
??? note "Q: How can I get more tailored suggestions?"
|
||||
#### Answer:<span style="display:none;">3</span>
|
||||
|
||||
See [here](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) for more information on how to use the `extra_instructions` and `best_practices` configuration options, to guide the model to more tailored suggestions.
|
||||
See [here](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#extra-instructions-and-best-practices) for more information on how to use the `extra_instructions` and `best_practices` configuration options, to guide the model to more tailored suggestions.
|
||||
|
||||
___
|
||||
|
||||
??? note "Q: Will you store my code? Are you using my code to train models?"
|
||||
#### Answer:<span style="display:none;">4</span>
|
||||
|
||||
No. Qodo Merge strict privacy policy ensures that your code is not stored or used for training purposes.
|
||||
No. Blackbox Merge strict privacy policy ensures that your code is not stored or used for training purposes.
|
||||
|
||||
For a detailed overview of our data privacy policy, please refer to [this link](https://qodo-merge-docs.qodo.ai/overview/data_privacy/)
|
||||
For a detailed overview of our data privacy policy, please refer to [this link](https://Blackbox-merge-docs.Blackbox.ai/overview/data_privacy/)
|
||||
|
||||
___
|
||||
|
||||
??? note "Q: Can I use my own LLM keys with Qodo Merge?"
|
||||
??? note "Q: Can I use my own LLM keys with Blackbox Merge?"
|
||||
#### Answer:<span style="display:none;">5</span>
|
||||
|
||||
When you self-host the [open-source](https://github.com/Codium-ai/pr-agent) version, you use your own keys.
|
||||
|
||||
Qodo Merge with SaaS deployment is a hosted version of Qodo Merge, where Qodo manages the infrastructure and the keys.
|
||||
Blackbox Merge with SaaS deployment is a hosted version of Blackbox Merge, where Blackbox manages the infrastructure and the keys.
|
||||
For enterprise customers, on-prem deployment is also available. [Contact us](https://www.codium.ai/contact/#pricing) for more information.
|
||||
___
|
||||
|
||||
??? note "Q: Can Qodo Merge review draft/offline PRs?"
|
||||
??? note "Q: Can Blackbox Merge review draft/offline PRs?"
|
||||
#### Answer:<span style="display:none;">6</span>
|
||||
|
||||
Yes. While Qodo Merge won't automatically review draft PRs, you can still get feedback by manually requesting it through [online commenting](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#online-usage).
|
||||
Yes. While Blackbox Merge won't automatically review draft PRs, you can still get feedback by manually requesting it through [online commenting](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#online-usage).
|
||||
|
||||
For active PRs, you can customize the automatic feedback settings [here](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#qodo-merge-automatic-feedback) to match your team's workflow.
|
||||
For active PRs, you can customize the automatic feedback settings [here](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#Blackbox-merge-automatic-feedback) to match your team's workflow.
|
||||
___
|
||||
|
||||
??? note "Q: Can the 'Review effort' feedback be calibrated or customized?"
|
||||
#### Answer:<span style="display:none;">7</span>
|
||||
|
||||
Yes, you can customize review effort estimates using the `extra_instructions` configuration option (see [documentation](https://qodo-merge-docs.qodo.ai/tools/review/#configuration-options)).
|
||||
Yes, you can customize review effort estimates using the `extra_instructions` configuration option (see [documentation](https://Blackbox-merge-docs.Blackbox.ai/tools/review/#configuration-options)).
|
||||
|
||||
Example mapping:
|
||||
|
||||
|
|
@ -89,34 +89,34 @@ ___
|
|||
|
||||
___
|
||||
|
||||
??? note "Q: How to reduce the noise generated by Qodo Merge?"
|
||||
??? note "Q: How to reduce the noise generated by Blackbox Merge?"
|
||||
#### Answer:<span style="display:none;">3</span>
|
||||
|
||||
The default configuration of Qodo Merge is designed to balance helpful feedback with noise reduction. It reduces noise through several approaches:
|
||||
The default configuration of Blackbox Merge is designed to balance helpful feedback with noise reduction. It reduces noise through several approaches:
|
||||
|
||||
- Auto-feedback uses three highly structured tools (`/describe`, `/review`, and `/improve`), designed to be accessible at a glance without creating large visual overload
|
||||
- Suggestions are presented in a table format rather than as committable comments, which are far noisier
|
||||
- The 'File Walkthrough' section is folded by default, as it tends to be verbose
|
||||
- Intermediate comments are avoided when creating new PRs (like "Qodo Merge is now reviewing your PR..."), which would generate email noise
|
||||
- Intermediate comments are avoided when creating new PRs (like "Blackbox Merge is now reviewing your PR..."), which would generate email noise
|
||||
|
||||
From our experience, especially in large teams or organizations, complaints about "noise" sometimes stem from the following issues:
|
||||
|
||||
- **Feedback from multiple bots**: When multiple bots provide feedback on the same PR, it creates confusion and noise. We recommend using Qodo Merge as the primary feedback tool to streamline the process and reduce redundancy.
|
||||
- **Getting familiar with the tool**: Unlike many tools that provide feedback only on demand, Qodo Merge automatically analyzes and suggests improvements for every code change. While this proactive approach can feel intimidating at first, it's designed to continuously enhance code quality and catch bugs and problems when they occur. We recommend reviewing [this guide](https://qodo-merge-docs.qodo.ai/tools/improve/#understanding-ai-code-suggestions) to help align expectations and maximize the value of Qodo Merge's auto-feedback.
|
||||
- **Feedback from multiple bots**: When multiple bots provide feedback on the same PR, it creates confusion and noise. We recommend using Blackbox Merge as the primary feedback tool to streamline the process and reduce redundancy.
|
||||
- **Getting familiar with the tool**: Unlike many tools that provide feedback only on demand, Blackbox Merge automatically analyzes and suggests improvements for every code change. While this proactive approach can feel intimidating at first, it's designed to continuously enhance code quality and catch bugs and problems when they occur. We recommend reviewing [this guide](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#understanding-ai-code-suggestions) to help align expectations and maximize the value of Blackbox Merge's auto-feedback.
|
||||
|
||||
Therefore, at a global configuration level, we recommend using the default configuration, which is designed to reduce noise while providing valuable feedback.
|
||||
|
||||
However, if you still find the feedback too noisy, you can adjust the configuration. Since each user and team has different needs, it's definitely possible - and even recommended - to adjust configurations for specific repos as needed.
|
||||
Ways to adjust the configuration for noise reduction include for example:
|
||||
|
||||
- [Score thresholds for code suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#configuration-options)
|
||||
- [Utilizing the `extra_instructions` field for more tailored feedback](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions)
|
||||
- [Controlling which tools run automatically](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened)
|
||||
- [Score thresholds for code suggestions](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#configuration-options)
|
||||
- [Utilizing the `extra_instructions` field for more tailored feedback](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#extra-instructions)
|
||||
- [Controlling which tools run automatically](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened)
|
||||
|
||||
Note that some users may prefer the opposite - more thorough and detailed feedback. Qodo Merge is designed to be flexible and customizable, allowing you to tailor the feedback to your team's specific needs and preferences.
|
||||
Note that some users may prefer the opposite - more thorough and detailed feedback. Blackbox Merge is designed to be flexible and customizable, allowing you to tailor the feedback to your team's specific needs and preferences.
|
||||
Examples of ways to increase feedback include:
|
||||
|
||||
- [`Exhaustive` code suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#controlling-suggestions-depth)
|
||||
- [Dual-publishing mode](https://qodo-merge-docs.qodo.ai/tools/improve/#dual-publishing-mode)
|
||||
- [Interactive usage](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
|
||||
- [`Exhaustive` code suggestions](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#controlling-suggestions-depth)
|
||||
- [Dual-publishing mode](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#dual-publishing-mode)
|
||||
- [Interactive usage](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/interactivity/)
|
||||
___
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Overview
|
||||
|
||||
[PR-Agent](https://github.com/Codium-ai/pr-agent) is an open-source tool to help efficiently review and handle pull requests.
|
||||
Qodo Merge is a hosted version of PR-Agent, designed for companies and teams that require additional features and capabilities
|
||||
Blackbox Merge is a hosted version of PR-Agent, designed for companies and teams that require additional features and capabilities
|
||||
|
||||
- See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms.
|
||||
|
||||
|
|
@ -17,64 +17,64 @@ To search the documentation site using natural language:
|
|||
|
||||
1) Comment `/help "your question"` in either:
|
||||
|
||||
- A pull request where Qodo Merge is installed
|
||||
- A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat)
|
||||
- A pull request where Blackbox Merge is installed
|
||||
- A [PR Chat](https://Blackbox-merge-docs.Blackbox.ai/chrome-extension/features/#pr-chat)
|
||||
|
||||
2) The bot will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links.
|
||||
|
||||
## Features
|
||||
|
||||
PR-Agent and Qodo Merge offer comprehensive pull request functionalities integrated with various git providers:
|
||||
PR-Agent and Blackbox Merge offer comprehensive pull request functionalities integrated with various git providers:
|
||||
|
||||
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
|
||||
| ----- |---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
|
||||
| [TOOLS](https://qodo-merge-docs.qodo.ai/tools/) | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Review](https://qodo-merge-docs.qodo.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines) | ✅ | ✅ | | | |
|
||||
| | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval) | ✅ | ✅ | ✅ | | |
|
||||
| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Add Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎 | ✅ | | | | |
|
||||
| | [Compliance](https://qodo-merge-docs.qodo.ai/tools/compliance/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Generate Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Generate Tests](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | | |
|
||||
| | [PR to Ticket](https://qodo-merge-docs.qodo.ai/tools/pr_to_ticket/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | | |
|
||||
| | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎 | ✅ | | | | |
|
||||
| | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | ✅ | | | |
|
||||
| | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| [TOOLS](https://Blackbox-merge-docs.Blackbox.ai/tools/) | [Describe](https://Blackbox-merge-docs.Blackbox.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Review](https://Blackbox-merge-docs.Blackbox.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Improve](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Ask](https://Blackbox-merge-docs.Blackbox.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | ⮑ [Ask on code lines](https://Blackbox-merge-docs.Blackbox.ai/tools/ask/#ask-lines) | ✅ | ✅ | | | |
|
||||
| | [Help Docs](https://Blackbox-merge-docs.Blackbox.ai/tools/help_docs/?h=auto#auto-approval) | ✅ | ✅ | ✅ | | |
|
||||
| | [Update CHANGELOG](https://Blackbox-merge-docs.Blackbox.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Add Documentation](https://Blackbox-merge-docs.Blackbox.ai/tools/documentation/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Analyze](https://Blackbox-merge-docs.Blackbox.ai/tools/analyze/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Auto-Approve](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [CI Feedback](https://Blackbox-merge-docs.Blackbox.ai/tools/ci_feedback/) 💎 | ✅ | | | | |
|
||||
| | [Compliance](https://Blackbox-merge-docs.Blackbox.ai/tools/compliance/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Custom Prompt](https://Blackbox-merge-docs.Blackbox.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Generate Custom Labels](https://Blackbox-merge-docs.Blackbox.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Generate Tests](https://Blackbox-merge-docs.Blackbox.ai/tools/test/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Implement](https://Blackbox-merge-docs.Blackbox.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [PR Chat](https://Blackbox-merge-docs.Blackbox.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | | |
|
||||
| | [PR to Ticket](https://Blackbox-merge-docs.Blackbox.ai/tools/pr_to_ticket/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Scan Repo Discussions](https://Blackbox-merge-docs.Blackbox.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | | |
|
||||
| | [Similar Code](https://Blackbox-merge-docs.Blackbox.ai/tools/similar_code/) 💎 | ✅ | | | | |
|
||||
| | [Suggestion Tracking](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | ✅ | | | |
|
||||
| | [Utilizing Best Practices](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | | | | | | |
|
||||
| [USAGE](https://qodo-merge-docs.qodo.ai/usage-guide/) | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| [USAGE](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/) | [CLI](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [App / webhook](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now) | ✅ | | | | |
|
||||
| | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Actions](https://Blackbox-merge-docs.Blackbox.ai/installation/github/#run-as-a-github-action) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | | | | | | |
|
||||
| [CORE](https://qodo-merge-docs.qodo.ai/core-abilities/) | [Adaptive and token-aware file patch fitting](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | | |
|
||||
| | [Chat on code suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/chat_on_code_suggestions/) | ✅ | ✅ | | | |
|
||||
| | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) | ✅ | ✅ | ✅ | | |
|
||||
| | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Incremental Update 💎](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) | ✅ | | | | |
|
||||
| | [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) | ✅ | ✅ | | | |
|
||||
| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | |
|
||||
| | [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) | ✅ | | ✅ | | |
|
||||
| | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | | | |
|
||||
!!! note "💎 means Qodo Merge only"
|
||||
All along the documentation, 💎 marks a feature available only in [Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version.
|
||||
| [CORE](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/) | [Adaptive and token-aware file patch fitting](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Auto Best Practices 💎](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/auto_best_practices/) | ✅ | | | | |
|
||||
| | [Chat on code suggestions](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/chat_on_code_suggestions/) | ✅ | ✅ | | | |
|
||||
| | [Code Validation 💎](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Dynamic context](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Fetching ticket context](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/) | ✅ | ✅ | ✅ | | |
|
||||
| | [Global and wiki configurations](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | | |
|
||||
| | [Impact Evaluation](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | |
|
||||
| | [Incremental Update 💎](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/incremental_update/) | ✅ | | | | |
|
||||
| | [Interactivity](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/interactivity/) | ✅ | ✅ | | | |
|
||||
| | [Local and global metadata](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Multiple models support](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [PR compression](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [PR interactive actions](https://www.Blackbox.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | |
|
||||
| | [RAG context enrichment](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/rag_context_enrichment/) | ✅ | | ✅ | | |
|
||||
| | [Self reflection](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | ✅ | |
|
||||
| | [Static code analysis](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | | | |
|
||||
!!! note "💎 means Blackbox Merge only"
|
||||
All along the documentation, 💎 marks a feature available only in [Blackbox Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version.
|
||||
|
||||
## Example Results
|
||||
|
||||
|
|
@ -110,8 +110,8 @@ PR-Agent and Qodo Merge offer comprehensive pull request functionalities integra
|
|||
|
||||
## How it Works
|
||||
|
||||
The following diagram illustrates Qodo Merge tools and their flow:
|
||||
The following diagram illustrates Blackbox Merge tools and their flow:
|
||||
|
||||

|
||||

|
||||
|
||||
Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt
|
||||
|
|
|
|||
|
|
@ -53,13 +53,13 @@ stages:
|
|||
env:
|
||||
azure_devops__pat: $(azure_devops_pat)
|
||||
openai__key: $(OPENAI_KEY)
|
||||
displayName: 'Run Qodo Merge'
|
||||
displayName: 'Run Blackbox Merge'
|
||||
```
|
||||
|
||||
This script will run Qodo Merge on every new merge request, with the `improve`, `review`, and `describe` commands.
|
||||
This script will run Blackbox Merge on every new merge request, with the `improve`, `review`, and `describe` commands.
|
||||
Note that you need to export the `azure_devops__pat` and `OPENAI_KEY` variables in the Azure DevOps pipeline settings (Pipelines -> Library -> + Variable group):
|
||||
|
||||
{width=468}
|
||||
{width=468}
|
||||
|
||||
Make sure to give pipeline permissions to the `pr_agent` variable group.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
|
|||
4. Clone this repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/qodo-ai/pr-agent.git
|
||||
git clone https://github.com/Blackbox-ai/pr-agent.git
|
||||
```
|
||||
|
||||
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ jobs:
|
|||
steps:
|
||||
- name: PR Agent action step
|
||||
id: pragent
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
env:
|
||||
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -41,7 +41,7 @@ The GITHUB_TOKEN secret is automatically created by GitHub.
|
|||
3) Merge this change to your main branch.
|
||||
When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
|
||||
|
||||
4) You may configure Qodo Merge by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
|
||||
4) You may configure Blackbox Merge by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
|
||||
|
||||
```yaml
|
||||
env:
|
||||
|
|
@ -51,7 +51,7 @@ When you open your next PR, you should see a comment from `github-actions` bot w
|
|||
PR_CODE_SUGGESTIONS.NUM_CODE_SUGGESTIONS: 6 # Increase number of code suggestions
|
||||
```
|
||||
|
||||
See detailed usage instructions in the [USAGE GUIDE](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-action)
|
||||
See detailed usage instructions in the [USAGE GUIDE](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#github-action)
|
||||
|
||||
### Configuration Examples
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ jobs:
|
|||
contents: write
|
||||
steps:
|
||||
- name: PR Agent action step
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
env:
|
||||
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -105,7 +105,7 @@ jobs:
|
|||
contents: write
|
||||
steps:
|
||||
- name: PR Agent action step
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
config.model: "gemini/gemini-1.5-flash"
|
||||
|
|
@ -136,7 +136,7 @@ jobs:
|
|||
contents: write
|
||||
steps:
|
||||
- name: PR Agent action step
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
config.model: "anthropic/claude-3-opus-20240229"
|
||||
|
|
@ -168,7 +168,7 @@ jobs:
|
|||
steps:
|
||||
- name: PR Agent action step
|
||||
id: pragent
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
env:
|
||||
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -370,7 +370,7 @@ jobs:
|
|||
steps:
|
||||
- name: PR Agent action step
|
||||
id: pragent
|
||||
uses: qodo-ai/pr-agent@main
|
||||
uses: Blackbox-ai/pr-agent@main
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GOOGLE_AI_STUDIO.GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
|
||||
|
|
@ -606,7 +606,7 @@ cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
|
|||
|
||||
9. Install the app by navigating to the "Install App" tab and selecting your desired repositories.
|
||||
|
||||
> **Note:** When running Qodo Merge from GitHub app, the default configuration file (configuration.toml) will be loaded.
|
||||
> **Note:** When running Blackbox Merge from GitHub app, the default configuration file (configuration.toml) will be loaded.
|
||||
> However, you can override the default tool parameters by uploading a local configuration file `.pr_agent.toml`
|
||||
> For more information please check out the [USAGE GUIDE](../usage-guide/automations_and_usage.md#github-app)
|
||||
---
|
||||
|
|
@ -666,7 +666,7 @@ CONFIG__SECRET_PROVIDER=aws_secrets_manager
|
|||
|
||||
### AWS CodeCommit Setup
|
||||
|
||||
Not all features have been added to CodeCommit yet. As of right now, CodeCommit has been implemented to run the Qodo Merge CLI on the command line, using AWS credentials stored in environment variables. (More features will be added in the future.) The following is a set of instructions to have Qodo Merge do a review of your CodeCommit pull request from the command line:
|
||||
Not all features have been added to CodeCommit yet. As of right now, CodeCommit has been implemented to run the Blackbox Merge CLI on the command line, using AWS credentials stored in environment variables. (More features will be added in the future.) The following is a set of instructions to have Blackbox Merge do a review of your CodeCommit pull request from the command line:
|
||||
|
||||
1. Create an IAM user that you will use to read CodeCommit pull requests and post comments
|
||||
- Note: That user should have CLI access only, not Console access
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
## Run as a GitLab Pipeline
|
||||
|
||||
You can use a pre-built Action Docker image to run PR-Agent as a GitLab pipeline. This is a simple way to get started with Qodo Merge without setting up your own server.
|
||||
You can use a pre-built Action Docker image to run PR-Agent as a GitLab pipeline. This is a simple way to get started with Blackbox Merge without setting up your own server.
|
||||
|
||||
(1) Add the following file to your repository under `.gitlab-ci.yml`:
|
||||
|
||||
|
|
@ -29,8 +29,8 @@ pr_agent_job:
|
|||
- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
|
||||
```
|
||||
|
||||
This script will run Qodo Merge on every new merge request. You can modify the `rules` section to run Qodo Merge on different events.
|
||||
You can also modify the `script` section to run different Qodo Merge commands, or with different parameters by exporting different environment variables.
|
||||
This script will run Blackbox Merge on every new merge request. You can modify the `rules` section to run Blackbox Merge on different events.
|
||||
You can also modify the `script` section to run different Blackbox Merge commands, or with different parameters by exporting different environment variables.
|
||||
|
||||
(2) Add the following masked variables to your GitLab repository (CI/CD -> Variables):
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ SHARED_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
|
|||
4. Clone this repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/qodo-ai/pr-agent.git
|
||||
git clone https://github.com/Blackbox-ai/pr-agent.git
|
||||
```
|
||||
|
||||
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@ There are several ways to use self-hosted PR-Agent:
|
|||
- [Azure DevOps integration](./azure.md)
|
||||
- [Gitea integration](./gitea.md)
|
||||
|
||||
## Qodo Merge 💎
|
||||
## Blackbox Merge 💎
|
||||
|
||||
Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
|
||||
Blackbox Merge, an app hosted by BlackboxAI for GitHub\GitLab\BitBucket, is also available.
|
||||
<br>
|
||||
With Qodo Merge, installation is as simple as adding the Qodo Merge app to your relevant repositories.
|
||||
See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details.
|
||||
With Blackbox Merge, installation is as simple as adding the Blackbox Merge app to your relevant repositories.
|
||||
See [here](https://Blackbox-merge-docs.Blackbox.ai/installation/Blackbox_merge/) for more details.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
To run PR-Agent locally, you first need to acquire two keys:
|
||||
|
||||
1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 and o4-mini (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer).
|
||||
1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 and o4-mini (or a key for other [language models](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/), if you prefer).
|
||||
2. A personal access token from your Git platform (GitHub, GitLab, BitBucket,Gitea) with repo scope. GitHub token, for example, can be issued from [here](https://github.com/settings/tokens){:target="_blank"}
|
||||
|
||||
## Using Docker image
|
||||
|
|
@ -87,8 +87,8 @@ Note that litellm, which is used by pr-agent, sometimes returns non-informative
|
|||
Carefully check the api keys and tokens you provided and make sure they are correct.
|
||||
Adjustments may be needed depending on your llm provider.
|
||||
|
||||
For example, for Azure OpenAI, additional keys are [needed](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#azure).
|
||||
Same goes for other providers, make sure to check the [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#changing-a-model)
|
||||
For example, for Azure OpenAI, additional keys are [needed](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/#azure).
|
||||
Same goes for other providers, make sure to check the [documentation](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/#changing-a-model)
|
||||
|
||||
## Using pip package
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Learn how to run PR-Agent locally using:
|
|||
- pip package
|
||||
- CLI from source code
|
||||
|
||||
[View Local Installation Guide →](https://qodo-merge-docs.qodo.ai/installation/locally/)
|
||||
[View Local Installation Guide →](https://Blackbox-merge-docs.Blackbox.ai/installation/locally/)
|
||||
|
||||
## 🐙 GitHub Integration
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ Set up PR-Agent with GitHub as:
|
|||
- GitHub Action
|
||||
- Local GitHub App
|
||||
|
||||
[View GitHub Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/github/)
|
||||
[View GitHub Integration Guide →](https://Blackbox-merge-docs.Blackbox.ai/installation/github/)
|
||||
|
||||
## 🦊 GitLab Integration
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ Deploy PR-Agent on GitLab as:
|
|||
- GitLab pipeline job
|
||||
- Local GitLab webhook server
|
||||
|
||||
[View GitLab Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/gitlab/)
|
||||
[View GitLab Integration Guide →](https://Blackbox-merge-docs.Blackbox.ai/installation/gitlab/)
|
||||
|
||||
## 🟦 BitBucket Integration
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ Implement PR-Agent in BitBucket as:
|
|||
- BitBucket pipeline job
|
||||
- Local BitBucket server
|
||||
|
||||
[View BitBucket Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/bitbucket/)
|
||||
[View BitBucket Integration Guide →](https://Blackbox-merge-docs.Blackbox.ai/installation/bitbucket/)
|
||||
|
||||
## 🔷 Azure DevOps Integration
|
||||
|
||||
|
|
@ -46,4 +46,4 @@ Configure PR-Agent with Azure DevOps as:
|
|||
- Azure DevOps pipeline job
|
||||
- Local Azure DevOps webhook
|
||||
|
||||
[View Azure DevOps Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/azure/)
|
||||
[View Azure DevOps Integration Guide →](https://Blackbox-merge-docs.Blackbox.ai/installation/azure/)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Qodo Merge is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by QodoAI.
|
||||
See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for more details about the benefits of using Qodo Merge.
|
||||
Blackbox Merge is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by BlackboxAI.
|
||||
See [here](https://Blackbox-merge-docs.Blackbox.ai/overview/pr_agent_pro/) for more details about the benefits of using Blackbox Merge.
|
||||
|
||||
## Usage and Licensing
|
||||
|
||||
|
|
@ -14,44 +14,44 @@ With an assigned seat, users can seamlessly deploy the application across any of
|
|||
|
||||
### Enterprise Account
|
||||
|
||||
For companies who require an Enterprise account, please [contact](https://www.qodo.ai/contact/#pricing) us to initiate a trial period, and to discuss pricing and licensing options.
|
||||
For companies who require an Enterprise account, please [contact](https://www.Blackbox.ai/contact/#pricing) us to initiate a trial period, and to discuss pricing and licensing options.
|
||||
|
||||
|
||||
## Install Qodo Merge for GitHub
|
||||
## Install Blackbox Merge for GitHub
|
||||
|
||||
### GitHub Cloud
|
||||
|
||||
Qodo Merge for GitHub cloud is available for installation through the [GitHub Marketplace](https://github.com/apps/qodo-merge-pro).
|
||||
Blackbox Merge for GitHub cloud is available for installation through the [GitHub Marketplace](https://github.com/apps/Blackbox-merge-pro).
|
||||
|
||||
{width=468}
|
||||
{width=468}
|
||||
|
||||
### GitHub Enterprise Server
|
||||
|
||||
To use Qodo Merge on your private GitHub Enterprise Server, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for starting an Enterprise trial.
|
||||
To use Blackbox Merge on your private GitHub Enterprise Server, you will need to [contact](https://www.Blackbox.ai/contact/#pricing) Blackbox for starting an Enterprise trial.
|
||||
|
||||
(Note: The marketplace app is not compatible with GitHub Enterprise Server. Installation requires creating a private GitHub App instead.)
|
||||
|
||||
### GitHub Open Source Projects
|
||||
|
||||
For open-source projects, Qodo Merge is available for free usage. To install Qodo Merge for your open-source repositories, use the following marketplace [link](https://github.com/marketplace/qodo-merge-pro-for-open-source).
|
||||
For open-source projects, Blackbox Merge is available for free usage. To install Blackbox Merge for your open-source repositories, use the following marketplace [link](https://github.com/marketplace/Blackbox-merge-pro-for-open-source).
|
||||
|
||||
## Install Qodo Merge for Bitbucket
|
||||
## Install Blackbox Merge for Bitbucket
|
||||
|
||||
### Bitbucket Cloud
|
||||
|
||||
Qodo Merge for Bitbucket Cloud is available for installation through the following [link](https://bitbucket.org/site/addons/authorize?addon_key=d6df813252c37258)
|
||||
Blackbox Merge for Bitbucket Cloud is available for installation through the following [link](https://bitbucket.org/site/addons/authorize?addon_key=d6df813252c37258)
|
||||
|
||||
{width=468}
|
||||
{width=468}
|
||||
|
||||
### Bitbucket Server
|
||||
|
||||
To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.qodo.ai/pricing/) trial.
|
||||
To use Blackbox Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.Blackbox.ai/pricing/) trial.
|
||||
|
||||
## Install Qodo Merge for GitLab
|
||||
## Install Blackbox Merge for GitLab
|
||||
|
||||
### GitLab Cloud
|
||||
|
||||
Installing Qodo Merge for GitLab uses GitLab's OAuth 2.0 application system and requires the following steps:
|
||||
Installing Blackbox Merge for GitLab uses GitLab's OAuth 2.0 application system and requires the following steps:
|
||||
|
||||
#### Step 1: Create a GitLab OAuth 2.0 Application
|
||||
|
||||
|
|
@ -61,8 +61,8 @@ Create a new OAuth 2.0 application in your GitLab instance:
|
|||
2. Go to "Applications" in the left sidebar
|
||||
3. Click on "Add new application"
|
||||
4. Fill in the application details:
|
||||
- **Name**: You can give any name you wish (e.g., "Qodo Merge")
|
||||
- **Redirect URI**: `https://register.oauth.app.gitlab.merge.qodo.ai/oauth/callback`
|
||||
- **Name**: You can give any name you wish (e.g., "Blackbox Merge")
|
||||
- **Redirect URI**: `https://register.oauth.app.gitlab.merge.Blackbox.ai/oauth/callback`
|
||||
- **Confidential**: Check this checkbox
|
||||
- **Scopes**: Check the "api" scope
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ Create a new OAuth 2.0 application in your GitLab instance:
|
|||
|
||||
#### Step 2: Register Your OAuth Application
|
||||
|
||||
1. Browse to: <https://register.oauth.app.gitlab.merge.qodo.ai>
|
||||
1. Browse to: <https://register.oauth.app.gitlab.merge.Blackbox.ai>
|
||||
2. Fill in the registration form:
|
||||
- **Host Address**: Leave empty if using gitlab.com ([for self-hosted GitLab servers](#gitlab-server), enter your GitLab base URL including scheme (e.g., https://gitlab.mycorp-inc.com) without trailing slash. Do not include paths or query strings.
|
||||
- **OAuth Application ID**: Enter the Application ID from Step 1
|
||||
|
|
@ -123,8 +123,8 @@ Install a webhook for your repository or groups by following these steps:
|
|||
|
||||
#### Step 6: You’re all set!
|
||||
|
||||
Open a new merge request or add a MR comment with one of Qodo Merge’s commands such as /review, /describe or /improve.
|
||||
Open a new merge request or add a MR comment with one of Blackbox Merge’s commands such as /review, /describe or /improve.
|
||||
|
||||
### GitLab Server
|
||||
|
||||
For [limited free usage](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users) on private GitLab Server, the same [installation steps](#gitlab-cloud) as for GitLab Cloud apply, aside from the [Host Address field mentioned in Step 2](#step-2-register-your-oauth-application) (where you fill in the hostname for your GitLab server, such as: https://gitlab.mycorp-inc.com). For unlimited usage, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for moving to an Enterprise account.
|
||||
For [limited free usage](https://Blackbox-merge-docs.Blackbox.ai/installation/Blackbox_merge/#cloud-users) on private GitLab Server, the same [installation steps](#gitlab-cloud) as for GitLab Cloud apply, aside from the [Host Address field mentioned in Step 2](#step-2-register-your-oauth-application) (where you fill in the hostname for your GitLab server, such as: https://gitlab.mycorp-inc.com). For unlimited usage, you will need to [contact](https://www.Blackbox.ai/contact/#pricing) Blackbox for moving to an Enterprise account.
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
## Self-hosted PR-Agent
|
||||
|
||||
- If you self-host PR-Agent with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to Qodo servers.
|
||||
- If you self-host PR-Agent with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to Blackbox servers.
|
||||
|
||||
## Qodo Merge 💎
|
||||
## Blackbox Merge 💎
|
||||
|
||||
- When using Qodo Merge💎, hosted by Qodo, 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.
|
||||
- When using Blackbox Merge💎, hosted by Blackbox, 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, Qodo Merge will use Qodo’s proprietary models. If this is the case, you will be notified.
|
||||
- For certain clients, Blackbox Merge will use Blackbox’s proprietary models. If this is the case, you will be notified.
|
||||
|
||||
- No passive collection of Code and Pull Requests’ data — Qodo Merge 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.
|
||||
- No passive collection of Code and Pull Requests’ data — Blackbox Merge 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.
|
||||
|
||||
## Qodo Merge Chrome extension
|
||||
## Blackbox Merge Chrome extension
|
||||
|
||||
- The [Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) will not send your code to any external servers.
|
||||
- The [Blackbox Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) will not send your code to any external servers.
|
||||
|
|
|
|||
|
|
@ -1,56 +1,56 @@
|
|||
### Overview
|
||||
|
||||
[Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"} is a hosted version of the open-source [PR-Agent](https://github.com/Codium-ai/pr-agent){:target="_blank"}.
|
||||
[Blackbox Merge](https://www.codium.ai/pricing/){:target="_blank"} is a hosted version of the open-source [PR-Agent](https://github.com/Codium-ai/pr-agent){:target="_blank"}.
|
||||
It is designed for companies and teams that require additional features and capabilities.
|
||||
|
||||
Free users receive a quota of 75 monthly PR feedbacks per git organization. Unlimited usage requires a paid subscription. See [details](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users).
|
||||
Free users receive a quota of 75 monthly PR feedbacks per git organization. Unlimited usage requires a paid subscription. See [details](https://Blackbox-merge-docs.Blackbox.ai/installation/Blackbox_merge/#cloud-users).
|
||||
|
||||
|
||||
Qodo Merge provides the following benefits:
|
||||
Blackbox Merge 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 Qodo Merge app to your GitHub\GitLab\BitBucket repo.
|
||||
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 Blackbox Merge app to your GitHub\GitLab\BitBucket repo.
|
||||
|
||||
2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention.
|
||||
2. **Improved privacy** - No data will be stored or used to train models. Blackbox Merge will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention.
|
||||
|
||||
3. **Improved support** - Qodo Merge users will receive priority support, and will be able to request new features and capabilities.
|
||||
3. **Improved support** - Blackbox Merge users will receive priority support, and will be able to request new features and capabilities.
|
||||
|
||||
4. **Supporting self-hosted git servers** - Qodo Merge can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/).
|
||||
4. **Supporting self-hosted git servers** - Blackbox Merge can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://Blackbox-merge-docs.Blackbox.ai/installation/pr_agent_pro/).
|
||||
|
||||
5. **PR Chat** - Qodo Merge allows you to engage in [private chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories.
|
||||
5. **PR Chat** - Blackbox Merge allows you to engage in [private chat](https://Blackbox-merge-docs.Blackbox.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories.
|
||||
|
||||
### Additional features
|
||||
|
||||
Here are some of the additional features and capabilities that Qodo Merge offers, and are not available in the open-source version of PR-Agent:
|
||||
Here are some of the additional features and capabilities that Blackbox Merge offers, and are not available in the open-source version of PR-Agent:
|
||||
|
||||
| Feature | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [**Model selection**](https://qodo-merge-docs.qodo.ai/usage-guide/PR_agent_pro_models/) | Choose the model that best fits your needs |
|
||||
| [**Global and wiki configuration**](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) | Control configurations for many repositories from a single location; <br>Edit configuration of a single repo without committing code |
|
||||
| [**Apply suggestions**](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) | Generate committable code from the relevant suggestions interactively by clicking on a checkbox |
|
||||
| [**Suggestions impact**](https://qodo-merge-docs.qodo.ai/tools/improve/#assessing-impact) | Automatically mark suggestions that were implemented by the user (either directly in GitHub, or indirectly in the IDE) to enable tracking of the impact of the suggestions |
|
||||
| [**CI feedback**](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) | Automatically analyze failed CI checks on GitHub and provide actionable feedback in the PR conversation, helping to resolve issues quickly |
|
||||
| [**Advanced usage statistics**](https://www.codium.ai/contact/#/) | Qodo Merge offers detailed statistics at user, repository, and company levels, including metrics about Qodo Merge usage, and also general statistics and insights |
|
||||
| [**Incorporating companies' best practices**](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) | Use the companies' best practices as reference to increase the effectiveness and the relevance of the code suggestions |
|
||||
| [**Interactive triggering**](https://qodo-merge-docs.qodo.ai/tools/analyze/#example-usage) | Interactively apply different tools via the `analyze` command |
|
||||
| [**Custom labels**](https://qodo-merge-docs.qodo.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for Qodo Merge to assign to the PR |
|
||||
| [**Model selection**](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/PR_agent_pro_models/) | Choose the model that best fits your needs |
|
||||
| [**Global and wiki configuration**](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/) | Control configurations for many repositories from a single location; <br>Edit configuration of a single repo without committing code |
|
||||
| [**Apply suggestions**](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#overview) | Generate committable code from the relevant suggestions interactively by clicking on a checkbox |
|
||||
| [**Suggestions impact**](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#assessing-impact) | Automatically mark suggestions that were implemented by the user (either directly in GitHub, or indirectly in the IDE) to enable tracking of the impact of the suggestions |
|
||||
| [**CI feedback**](https://Blackbox-merge-docs.Blackbox.ai/tools/ci_feedback/) | Automatically analyze failed CI checks on GitHub and provide actionable feedback in the PR conversation, helping to resolve issues quickly |
|
||||
| [**Advanced usage statistics**](https://www.codium.ai/contact/#/) | Blackbox Merge offers detailed statistics at user, repository, and company levels, including metrics about Blackbox Merge usage, and also general statistics and insights |
|
||||
| [**Incorporating companies' best practices**](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#best-practices) | Use the companies' best practices as reference to increase the effectiveness and the relevance of the code suggestions |
|
||||
| [**Interactive triggering**](https://Blackbox-merge-docs.Blackbox.ai/tools/analyze/#example-usage) | Interactively apply different tools via the `analyze` command |
|
||||
| [**Custom labels**](https://Blackbox-merge-docs.Blackbox.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for Blackbox Merge to assign to the PR |
|
||||
|
||||
### Additional tools
|
||||
|
||||
Here are additional tools that are available only for Qodo Merge users:
|
||||
Here are additional tools that are available only for Blackbox Merge users:
|
||||
|
||||
| Feature | Description |
|
||||
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| [**Custom Prompt Suggestions**](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) | Generate code suggestions based on custom prompts from the user |
|
||||
| [**Analyze PR components**](https://qodo-merge-docs.qodo.ai/tools/analyze/) | Identify the components that changed in the PR, and enable to interactively apply different tools to them |
|
||||
| [**Tests**](https://qodo-merge-docs.qodo.ai/tools/test/) | Generate tests for code components that changed in the PR |
|
||||
| [**PR documentation**](https://qodo-merge-docs.qodo.ai/tools/documentation/) | Generate docstring for code components that changed in the PR |
|
||||
| [**Improve Component**](https://qodo-merge-docs.qodo.ai/tools/improve_component/) | Generate code suggestions for code components that changed in the PR |
|
||||
| [**Similar code search**](https://qodo-merge-docs.qodo.ai/tools/similar_code/) | Search for similar code in the repository, organization, or entire GitHub |
|
||||
| [**Code implementation**](https://qodo-merge-docs.qodo.ai/tools/implement/) | Generates implementation code from review suggestions |
|
||||
| [**Custom Prompt Suggestions**](https://Blackbox-merge-docs.Blackbox.ai/tools/custom_prompt/) | Generate code suggestions based on custom prompts from the user |
|
||||
| [**Analyze PR components**](https://Blackbox-merge-docs.Blackbox.ai/tools/analyze/) | Identify the components that changed in the PR, and enable to interactively apply different tools to them |
|
||||
| [**Tests**](https://Blackbox-merge-docs.Blackbox.ai/tools/test/) | Generate tests for code components that changed in the PR |
|
||||
| [**PR documentation**](https://Blackbox-merge-docs.Blackbox.ai/tools/documentation/) | Generate docstring for code components that changed in the PR |
|
||||
| [**Improve Component**](https://Blackbox-merge-docs.Blackbox.ai/tools/improve_component/) | Generate code suggestions for code components that changed in the PR |
|
||||
| [**Similar code search**](https://Blackbox-merge-docs.Blackbox.ai/tools/similar_code/) | Search for similar code in the repository, organization, or entire GitHub |
|
||||
| [**Code implementation**](https://Blackbox-merge-docs.Blackbox.ai/tools/implement/) | Generates implementation code from review suggestions |
|
||||
|
||||
### Supported languages
|
||||
|
||||
Qodo Merge leverages the world's leading code models, such as Claude 4 Sonnet, o4-mini and Gemini-2.5-Pro.
|
||||
Blackbox Merge leverages the world's leading code models, such as Claude 4 Sonnet, o4-mini and Gemini-2.5-Pro.
|
||||
As a result, its primary tools such as `describe`, `review`, and `improve`, as well as the PR-chat feature, support virtually all programming languages.
|
||||
|
||||
For specialized commands that require static code analysis, Qodo Merge offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://qodo-merge-docs.qodo.ai/tools/analyze/#overview).
|
||||
For specialized commands that require static code analysis, Blackbox Merge offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://Blackbox-merge-docs.Blackbox.ai/tools/analyze/#overview).
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Qodo Merge Pull Request Benchmark
|
||||
# Blackbox Merge Pull Request Benchmark
|
||||
|
||||
## Methodology
|
||||
|
||||
Qodo Merge PR Benchmark evaluates and compares the performance of Large Language Models (LLMs) in analyzing pull request code and providing meaningful code suggestions.
|
||||
Blackbox Merge PR Benchmark evaluates and compares the performance of Large Language Models (LLMs) in analyzing pull request code and providing meaningful code suggestions.
|
||||
Our diverse dataset contains 400 pull requests from over 100 repositories, spanning multiple [programming languages](#programming-languages) to reflect real-world scenarios.
|
||||
|
||||
- For each pull request, we have pre-generated suggestions from eleven different top-performing models using the Qodo Merge `improve` tool. The prompt for response generation can be found [here](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/code_suggestions/pr_code_suggestions_prompts_not_decoupled.toml).
|
||||
- For each pull request, we have pre-generated suggestions from eleven different top-performing models using the Blackbox Merge `improve` tool. The prompt for response generation can be found [here](https://github.com/Blackbox-ai/pr-agent/blob/main/pr_agent/settings/code_suggestions/pr_code_suggestions_prompts_not_decoupled.toml).
|
||||
|
||||
- To benchmark a model, we generate its suggestions for the same pull requests and ask a high-performing judge model to **rank** the new model's output against the pre-generated baseline suggestions. We utilize OpenAI's `o3` model as the judge, though other models have yielded consistent results. The prompt for this ranking judgment is available [here](https://github.com/Codium-ai/pr-agent-settings/tree/main/benchmark).
|
||||
|
||||
|
|
@ -461,10 +461,10 @@ Weaknesses:
|
|||
|
||||
Some examples of benchmarked PRs and their results:
|
||||
|
||||
- [Example 1](https://www.qodo.ai/images/qodo_merge_benchmark/example_results1.html)
|
||||
- [Example 2](https://www.qodo.ai/images/qodo_merge_benchmark/example_results2.html)
|
||||
- [Example 3](https://www.qodo.ai/images/qodo_merge_benchmark/example_results3.html)
|
||||
- [Example 4](https://www.qodo.ai/images/qodo_merge_benchmark/example_results4.html)
|
||||
- [Example 1](https://www.Blackbox.ai/images/Blackbox_merge_benchmark/example_results1.html)
|
||||
- [Example 2](https://www.Blackbox.ai/images/Blackbox_merge_benchmark/example_results2.html)
|
||||
- [Example 3](https://www.Blackbox.ai/images/Blackbox_merge_benchmark/example_results3.html)
|
||||
- [Example 4](https://www.Blackbox.ai/images/Blackbox_merge_benchmark/example_results4.html)
|
||||
|
||||
### Models Used for Benchmarking
|
||||
|
||||
|
|
|
|||
|
|
@ -1,23 +1,23 @@
|
|||
# Review and Implement AI Suggestions from Your Terminal
|
||||
|
||||
**Qodo Merge CLI** utilizes [Qodo Command](https://docs.qodo.ai/qodo-documentation/qodo-command) to bring AI-powered code suggestions directly to your terminal.
|
||||
Review, implement, and manage Qodo Merge suggestions without leaving your development environment.
|
||||
**Blackbox Merge CLI** utilizes [Blackbox Command](https://docs.Blackbox.ai/Blackbox-documentation/Blackbox-command) to bring AI-powered code suggestions directly to your terminal.
|
||||
Review, implement, and manage Blackbox Merge suggestions without leaving your development environment.
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
## Mission
|
||||
|
||||
The CLI can bridge the gap between Qodo Merge feedback and code implementation in your local enviroment:
|
||||
The CLI can bridge the gap between Blackbox Merge feedback and code implementation in your local enviroment:
|
||||
|
||||
- **Seamlessly generate and manage PR suggestions** without context switching
|
||||
- Remote Suggestions: Fetches Qodo Merge suggestions from your Git Environment
|
||||
- Remote Suggestions: Fetches Blackbox Merge suggestions from your Git Environment
|
||||
- Local Suggestions: Get real-time suggestions against your local changes
|
||||
- **Interactive review and implementation** of AI feedback directly in your terminal
|
||||
- **Track implementation status** of each suggestion (pending/implemented/declined)
|
||||
|
||||
## Remote Suggestions Flow
|
||||
1. Open a Pull Request on your Git environment and receive Qodo Merge feedback
|
||||
2. Pull the remote suggestions into your terminal with Qodo Merge CLI
|
||||
1. Open a Pull Request on your Git environment and receive Blackbox Merge feedback
|
||||
2. Pull the remote suggestions into your terminal with Blackbox Merge CLI
|
||||
3. Explore, Review, and implement suggestions interactively
|
||||
4. Commit changes back to your branch seamlessly
|
||||
|
||||
|
|
@ -26,9 +26,9 @@ Work in progress - coming soon!
|
|||
|
||||
## Quick Start
|
||||
|
||||
1. **[Install](installation.md)** Qodo Merge CLI
|
||||
1. **[Install](installation.md)** Blackbox Merge CLI
|
||||
2. **[Usage](usage.md)** - Navigate, explore, and implement suggestions
|
||||
|
||||
---
|
||||
|
||||
*Part of the Qodo Merge ecosystem - closing the loop between AI feedback and code implementation.*
|
||||
*Part of the Blackbox Merge ecosystem - closing the loop between AI feedback and code implementation.*
|
||||
|
|
@ -1,43 +1,43 @@
|
|||
# Installation
|
||||
|
||||
> For remote suggestions, Qodo Merge needs to be installed and active on your Git repository (GitHub / GitLab), and provide code suggestions in a table format for your Pull Requests (PRs).
|
||||
> For remote suggestions, Blackbox Merge needs to be installed and active on your Git repository (GitHub / GitLab), and provide code suggestions in a table format for your Pull Requests (PRs).
|
||||
|
||||
## Install Qodo Command
|
||||
## Install Blackbox Command
|
||||
|
||||
Qodo Merge CLI is a review tool within [Qodo Command](https://docs.qodo.ai/qodo-documentation/qodo-command), a command-line interface for running and managing AI agents.
|
||||
Blackbox Merge CLI is a review tool within [Blackbox Command](https://docs.Blackbox.ai/Blackbox-documentation/Blackbox-command), a command-line interface for running and managing AI agents.
|
||||
|
||||
To use Qodo Command, you'll need first Node.js and npm installed.
|
||||
Then, to install Qodo Command, run:
|
||||
To use Blackbox Command, you'll need first Node.js and npm installed.
|
||||
Then, to install Blackbox Command, run:
|
||||
|
||||
```bash
|
||||
npm install -g @qodo/command
|
||||
npm install -g @Blackbox/command
|
||||
```
|
||||
|
||||
**Login and Setup**
|
||||
|
||||
To start using Qodo Command, you need to log in first:
|
||||
To start using Blackbox Command, you need to log in first:
|
||||
|
||||
```bash
|
||||
qodo login
|
||||
Blackbox login
|
||||
```
|
||||
|
||||
Once login is completed, you'll receive an API key in the terminal.
|
||||
The API key is also saved locally in the .qodo folder in your home directory, and can be reused (e.g., in CI).
|
||||
The API key is also saved locally in the .Blackbox folder in your home directory, and can be reused (e.g., in CI).
|
||||
The key is tied to your user account and subject to the same usage limits.
|
||||
|
||||
|
||||
## Using Qodo Merge CLI
|
||||
## Using Blackbox Merge CLI
|
||||
|
||||
After you set up Qodo Command, you can start using Qodo Merge CLI by running:
|
||||
After you set up Blackbox Command, you can start using Blackbox Merge CLI by running:
|
||||
|
||||
```bash
|
||||
qodo merge
|
||||
Blackbox merge
|
||||
```
|
||||
### Set Up Git Client
|
||||
On first run, the CLI will check for your Git client (GitHub CLI or GitLab CLI).
|
||||
If not found, it will guide you through the installation process.
|
||||
|
||||
{width=384}
|
||||
{width=384}
|
||||
|
||||
|
||||
## Quick Usage
|
||||
|
|
@ -48,20 +48,20 @@ There are two ways to specify which PR to review:
|
|||
run this command in your CLI:
|
||||
|
||||
```bash
|
||||
qodo merge
|
||||
Blackbox merge
|
||||
```
|
||||
|
||||
(2) **Specify PR number or URL**
|
||||
|
||||
```bash
|
||||
qodo merge 303
|
||||
Blackbox merge 303
|
||||
|
||||
qodo merge https://github.com/owner/repo/pull/303
|
||||
Blackbox merge https://github.com/owner/repo/pull/303
|
||||
```
|
||||
|
||||
Then the tool will automatically fetch the suggestions from the PR and display them in an interactive table.
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
|
||||
## Next Steps
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Usage Guide for Qodo Merge CLI
|
||||
# Usage Guide for Blackbox Merge CLI
|
||||
|
||||
|
||||
## Understanding the Interface
|
||||
|
|
@ -13,7 +13,7 @@ Users can efficiently prioritize, explore, and implement suggestions through an
|
|||
The interface guides you from high-level overviews to detailed implementation context.
|
||||
This consistent user-friendly structure streamlines the review process, reducing time from feedback to implementation.
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ You can view the proposed code changes in a diff format, jump to the relevant co
|
|||
[//]: # ( === "Details Panel")
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ( {width=768})
|
||||
[//]: # ( {width=768})
|
||||
|
||||
[//]: # ( )
|
||||
[//]: # ( **Enhanced Layout (≥120 columns)**)
|
||||
|
|
@ -58,7 +58,7 @@ You can view the proposed code changes in a diff format, jump to the relevant co
|
|||
=== "Diff View (`D/S`)"
|
||||
=== "Unified Diff View (`D`)"
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
- Press `D` to view proposed code changes
|
||||
- Standard unified diff format with line numbers
|
||||
|
|
@ -67,7 +67,7 @@ You can view the proposed code changes in a diff format, jump to the relevant co
|
|||
|
||||
=== "Side-by-Side View (`S`)"
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
- Press `S` for side-by-side diff view
|
||||
- Enhanced layout for complex changes
|
||||
|
|
@ -87,7 +87,7 @@ You can view the proposed code changes in a diff format, jump to the relevant co
|
|||
|
||||
**Suggestion-Specific Discussion**
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
- Press `C` to discuss the current suggestion
|
||||
- Context automatically included (files, lines, description)
|
||||
|
|
@ -102,7 +102,7 @@ You can implement a single suggestion, multiple selected suggestions, or all sug
|
|||
!!! note "Multiple implementation modes available"
|
||||
|
||||
=== "1. Single Suggestion"
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
**Direct individual implementation**
|
||||
|
||||
|
|
@ -110,7 +110,7 @@ You can implement a single suggestion, multiple selected suggestions, or all sug
|
|||
2. Press `Enter` to implement just that suggestion
|
||||
|
||||
=== "2. Multi-Select"
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
**Select multiple related suggestions**
|
||||
|
||||
|
|
@ -120,7 +120,7 @@ You can implement a single suggestion, multiple selected suggestions, or all sug
|
|||
4. AI implements selected suggestions together
|
||||
|
||||
=== "3. Address All"
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
**Reflect and address all suggestions (Always available as first row)**
|
||||
|
||||
|
|
@ -131,7 +131,7 @@ You can implement a single suggestion, multiple selected suggestions, or all sug
|
|||
|
||||
=== "4. Chat then Implement"
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
**Discuss then implement**
|
||||
|
||||
|
|
@ -151,7 +151,7 @@ After the AI completes the implementation, you receive a **structured output** s
|
|||
- **Reasoning**: Explanation of the implementation approach
|
||||
- **Changes**: Summary of code modifications made
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
Each suggestion gets its own implementation summary, providing full transparency into what was done and why.
|
||||
|
||||
|
|
@ -162,7 +162,7 @@ After implementing the suggestions, you have several options to proceed:
|
|||
!!! note "Post Implementation Actions"
|
||||
=== "Return to Table (`ESC`)"
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
The first option returns you to the main table where you can see:
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ After implementing the suggestions, you have several options to proceed:
|
|||
|
||||
=== "Continue Chatting (`C`)"
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
Discuss the implementation details:
|
||||
|
||||
|
|
@ -183,7 +183,7 @@ After implementing the suggestions, you have several options to proceed:
|
|||
|
||||
=== "Commit Changes (`M`)"
|
||||
|
||||
{width=512}
|
||||
{width=512}
|
||||
|
||||
Auto-generate commit messages:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,24 +1,24 @@
|
|||
# Recent Updates and Future Roadmap
|
||||
|
||||
|
||||
This page summarizes recent enhancements to Qodo Merge.
|
||||
This page summarizes recent enhancements to Blackbox Merge.
|
||||
|
||||
It also outlines our development roadmap for the upcoming three months. Please note that the roadmap is subject to change, and features may be adjusted, added, or reprioritized.
|
||||
|
||||
=== "Recent Updates"
|
||||
| Date | Feature | Description |
|
||||
|---|---|---|
|
||||
| 2025-09-17 | **Qodo Merge CLI** | A new command-line interface for Qodo Merge, enabling developers to implement code suggestions directly in your terminal. ([Learn more](https://qodo-merge-docs.qodo.ai/qodo-merge-cli/)) |
|
||||
| 2025-09-12 | **Repo Metadata** | You can now add metadata from files like `AGENTS.md`, which will be applied to all PRs in that repository. ([Learn more](https://qodo-merge-docs.qodo.ai/usage-guide/additional_configurations/#bringing-additional-repository-metadata-to-qodo-merge)) |
|
||||
| 2025-08-11 | **RAG support for GitLab** | All Qodo Merge RAG features are now available in GitLab. ([Learn more](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/)) |
|
||||
| 2025-07-29 | **High-level Suggestions** | Qodo Merge now also provides high-level code suggestion for PRs. ([Learn more](https://qodo-merge-docs.qodo.ai/core-abilities/high_level_suggestions/)) |
|
||||
| 2025-07-20 | **PR to Ticket** | Generate tickets in your tracking systems based on PR content. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/pr_to_ticket/)) |
|
||||
| 2025-07-17 | **Compliance** | Comprehensive compliance checks for security, ticket requirements, and custom organizational rules. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/compliance/)) |
|
||||
| 2025-06-21 | **Mermaid Diagrams** | Qodo Merge now generates by default Mermaid diagrams for PRs, providing a visual representation of code changes. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/describe/#sequence-diagram-support)) |
|
||||
| 2025-06-11 | **Best Practices Hierarchy** | Introducing support for structured best practices, such as for folders in monorepos or a unified best practice file for a group of repositories. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/improve/#global-hierarchical-best-practices)) |
|
||||
| 2025-06-01 | **CLI Endpoint** | A new Qodo Merge endpoint that accepts a lists of before/after code changes, executes Qodo Merge commands, and return the results. Currently available for enterprise customers. Contact [Qodo](https://www.qodo.ai/contact/) for more information. |
|
||||
| 2025-09-17 | **Blackbox Merge CLI** | A new command-line interface for Blackbox Merge, enabling developers to implement code suggestions directly in your terminal. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/Blackbox-merge-cli/)) |
|
||||
| 2025-09-12 | **Repo Metadata** | You can now add metadata from files like `AGENTS.md`, which will be applied to all PRs in that repository. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/additional_configurations/#bringing-additional-repository-metadata-to-Blackbox-merge)) |
|
||||
| 2025-08-11 | **RAG support for GitLab** | All Blackbox Merge RAG features are now available in GitLab. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/rag_context_enrichment/)) |
|
||||
| 2025-07-29 | **High-level Suggestions** | Blackbox Merge now also provides high-level code suggestion for PRs. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/high_level_suggestions/)) |
|
||||
| 2025-07-20 | **PR to Ticket** | Generate tickets in your tracking systems based on PR content. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/tools/pr_to_ticket/)) |
|
||||
| 2025-07-17 | **Compliance** | Comprehensive compliance checks for security, ticket requirements, and custom organizational rules. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/tools/compliance/)) |
|
||||
| 2025-06-21 | **Mermaid Diagrams** | Blackbox Merge now generates by default Mermaid diagrams for PRs, providing a visual representation of code changes. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/tools/describe/#sequence-diagram-support)) |
|
||||
| 2025-06-11 | **Best Practices Hierarchy** | Introducing support for structured best practices, such as for folders in monorepos or a unified best practice file for a group of repositories. ([Learn more](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#global-hierarchical-best-practices)) |
|
||||
| 2025-06-01 | **CLI Endpoint** | A new Blackbox Merge endpoint that accepts a lists of before/after code changes, executes Blackbox Merge commands, and return the results. Currently available for enterprise customers. Contact [Blackbox](https://www.Blackbox.ai/contact/) for more information. |
|
||||
|
||||
=== "Future Roadmap"
|
||||
- **`Compliance` tool to replace `review` as default**: Planning to make the `compliance` tool the default automatic command instead of the current `review` tool.
|
||||
- **Smarter context retrieval**: Leverage AST and LSP analysis to gather relevant context from across the entire repository.
|
||||
- **Enhanced portal experience**: Improved user experience in the Qodo Merge portal with new options and capabilities.
|
||||
- **Enhanced portal experience**: Improved user experience in the Blackbox Merge portal with new options and capabilities.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
# Table of contents
|
||||
|
||||
* [Overview](index.md)
|
||||
* [💎 Qodo Merge](overview/pr_agent_pro.md)
|
||||
* [💎 Blackbox Merge](overview/pr_agent_pro.md)
|
||||
* [Data Privacy](overview/data_privacy.md)
|
||||
|
||||
## Installation
|
||||
|
||||
* [Installation](installation/index.md)
|
||||
* [PR-Agent](installation/pr_agent.md)
|
||||
* [💎 Qodo Merge](installation/qodo_merge.md)
|
||||
* [💎 Blackbox Merge](installation/Blackbox_merge.md)
|
||||
|
||||
## Usage Guide
|
||||
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
* [Changing a Model](usage-guide/changing_a_model.md)
|
||||
* [Additional Configurations](usage-guide/additional_configurations.md)
|
||||
* [Frequently Asked Questions](faq/index.md)
|
||||
* [Qodo Merge Models](usage-guide/qodo_merge_models.md)
|
||||
* [Blackbox Merge Models](usage-guide/Blackbox_merge_models.md)
|
||||
|
||||
## Tools
|
||||
|
||||
|
|
@ -65,11 +65,11 @@
|
|||
* [Self-reflection](core-abilities/self_reflection.md)
|
||||
* [Static code analysis](core-abilities/static_code_analysis.md)
|
||||
|
||||
## Qodo Merge CLI
|
||||
## Blackbox Merge CLI
|
||||
|
||||
* [Overview](qodo-merge-cli/index.md)
|
||||
* [Installation](qodo-merge-cli/installation.md)
|
||||
* [Usage](qodo-merge-cli/usage.md)
|
||||
* [Overview](Blackbox-merge-cli/index.md)
|
||||
* [Installation](Blackbox-merge-cli/installation.md)
|
||||
* [Usage](Blackbox-merge-cli/usage.md)
|
||||
|
||||
## PR Benchmark
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ The `compliance` tool performs comprehensive compliance checks on PR code change
|
|||
|
||||
___
|
||||
|
||||
[//]: # (???+ note "The following features are available only for Qodo Merge 💎 users:")
|
||||
[//]: # (???+ note "The following features are available only for Blackbox Merge 💎 users:")
|
||||
|
||||
[//]: # ( - Custom compliance checklists and hierarchical compliance checklists)
|
||||
|
||||
|
|
@ -43,9 +43,9 @@ For example, you can enable ticket compliance labels by running:
|
|||
### Automatic Triggering
|
||||
|
||||
|
||||
The tool can be triggered automatically every time a new PR is [opened](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened), or in a [push](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/?h=push#github-app-automatic-tools-for-push-actions-commits-to-an-open-pr) event to an existing PR.
|
||||
The tool can be triggered automatically every time a new PR is [opened](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened), or in a [push](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/automations_and_usage/?h=push#github-app-automatic-tools-for-push-actions-commits-to-an-open-pr) event to an existing PR.
|
||||
|
||||
To run the `compliance` tool automatically when a PR is opened, define the following in the [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/):
|
||||
To run the `compliance` tool automatically when a PR is opened, define the following in the [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/):
|
||||
|
||||
```toml
|
||||
[github_app] # for example
|
||||
|
|
@ -81,10 +81,10 @@ Examples of security issues:
|
|||
### 2. Ticket Compliance
|
||||
|
||||
???+ tip "How to set up ticket compliance"
|
||||
Follow the guide on how to set up [ticket compliance](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) with Qodo Merge.
|
||||
Follow the guide on how to set up [ticket compliance](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/) with Blackbox Merge.
|
||||
|
||||
???+ tip "Auto-create ticket"
|
||||
Follow this [guide](https://qodo-merge-docs.qodo.ai/tools/pr_to_ticket/) to learn how to enable triggering `create tickets` based on PR content.
|
||||
Follow this [guide](https://Blackbox-merge-docs.Blackbox.ai/tools/pr_to_ticket/) to learn how to enable triggering `create tickets` based on PR content.
|
||||
|
||||
{width=256}
|
||||
|
||||
|
|
@ -150,7 +150,7 @@ Each compliance is defined in a YAML file as follows:
|
|||
- Focus on meaningful compliance requirements, not style preferences
|
||||
|
||||
???+ tip "Ready-to-use compliance templates"
|
||||
For production-ready compliance checklist templates organized by programming languages and technology stacks, check out the [PR Compliance Templates repository](https://github.com/qodo-ai/pr-compliance-templates).
|
||||
For production-ready compliance checklist templates organized by programming languages and technology stacks, check out the [PR Compliance Templates repository](https://github.com/Blackbox-ai/pr-compliance-templates).
|
||||
|
||||
### Local Compliance Checklists
|
||||
|
||||
|
|
@ -160,7 +160,7 @@ The AI model will use this `pr_compliance_checklist.yaml` file as a reference, a
|
|||
|
||||
### Global Hierarchical Compliance
|
||||
|
||||
Qodo Merge supports hierarchical compliance checklists using a dedicated global configuration repository.
|
||||
Blackbox Merge supports hierarchical compliance checklists using a dedicated global configuration repository.
|
||||
|
||||
#### Setting up global hierarchical compliance
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ To enable custom labels, you need to apply the [configuration changes](#configur
|
|||
|
||||
#### 3. Handle custom labels from the Repo's labels page 💎
|
||||
|
||||
> This feature is available only in Qodo Merge
|
||||
> This feature is available only in Blackbox Merge
|
||||
|
||||
* GitHub : `https://github.com/{owner}/{repo}/labels`, or click on the "Labels" tab in the issues or PRs page.
|
||||
* GitLab : `https://gitlab.com/{owner}/{repo}/-/labels`, or click on "Manage" -> "Labels" on the left menu.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ If you want to edit [configurations](#configuration-options), add the relevant o
|
|||
|
||||
### Automatic triggering
|
||||
|
||||
To run the `describe` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file):
|
||||
To run the `describe` automatically when a PR is opened, define in a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#wiki-configuration-file):
|
||||
|
||||
```
|
||||
[github_app]
|
||||
|
|
@ -47,10 +47,10 @@ publish_labels = true
|
|||
|
||||
## Preserving the original user description
|
||||
|
||||
By default, Qodo Merge tries to preserve your original PR description by placing it above the generated content.
|
||||
By default, Blackbox Merge tries to preserve your original PR description by placing it above the generated content.
|
||||
This requires including your description during the initial PR creation.
|
||||
|
||||
"Qodo removed the original description from the PR. Why"?
|
||||
"Blackbox removed the original description from the PR. Why"?
|
||||
|
||||
From our experience, there are two possible reasons:
|
||||
|
||||
|
|
@ -146,7 +146,7 @@ This option is enabled by default via the `pr_description.enable_pr_diagram` par
|
|||
</tr>
|
||||
<tr>
|
||||
<td><b>auto_create_ticket</b></td>
|
||||
<td>If set to true, this will <a href="https://qodo-merge-docs.qodo.ai/tools/pr_to_ticket/">automatically create a ticket</a> in the ticketing system when a PR is opened. Default is false.</td>
|
||||
<td>If set to true, this will <a href="https://Blackbox-merge-docs.Blackbox.ai/tools/pr_to_ticket/">automatically create a ticket</a> in the ticketing system when a PR is opened. Default is false.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -214,7 +214,7 @@ becomes
|
|||
The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
|
||||
|
||||
You can define custom labels that are relevant for your repo and use cases.
|
||||
Custom labels can be defined in a [configuration file](https://qodo-merge-docs.qodo.ai/tools/custom_labels/#configuration-options), or directly in the repo's [labels page](#handle-custom-labels-from-the-repos-labels-page).
|
||||
Custom labels can be defined in a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/tools/custom_labels/#configuration-options), or directly in the repo's [labels page](#handle-custom-labels-from-the-repos-labels-page).
|
||||
|
||||
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
|
||||
Each label description should be a **conditional statement**, that indicates if to add the label to the PR or not, according to the PR content.
|
||||
|
|
@ -267,7 +267,7 @@ The description should be comprehensive and detailed, indicating when to add the
|
|||
## Usage Tips
|
||||
|
||||
!!! tip "Automation"
|
||||
- When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app) for the describe tool is:
|
||||
- When you first install Blackbox Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app) for the describe tool is:
|
||||
```
|
||||
pr_commands = ["/describe", ...]
|
||||
```
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Comment `/add_docs` on a PR to invoke it manually.
|
|||
|
||||
## Automatic triggering
|
||||
|
||||
To automatically run the `add_docs` tool when a pull request is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/):
|
||||
To automatically run the `add_docs` tool when a pull request is opened, define in a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/):
|
||||
|
||||
|
||||
```toml
|
||||
|
|
@ -44,7 +44,7 @@ pr_commands = [
|
|||
```
|
||||
|
||||
The `pr_commands` list defines commands that run automatically when a PR is opened.
|
||||
Since this is under the [github_app] section, it only applies when using the Qodo Merge GitHub App in GitHub environments.
|
||||
Since this is under the [github_app] section, it only applies when using the Blackbox Merge GitHub App in GitHub environments.
|
||||
|
||||
## Configuration options
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
## Overview
|
||||
|
||||
The `help` tool provides a list of all the available tools and their descriptions.
|
||||
For Qodo Merge users, it also enables to trigger each tool by checking the relevant box.
|
||||
For Blackbox Merge users, it also enables to trigger each tool by checking the relevant box.
|
||||
|
||||
It can be invoked manually by commenting on any PR:
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ This can be useful, for example, for providing immediate feedback to users who o
|
|||
|
||||
Here's how:
|
||||
|
||||
1) Follow the steps depicted under [Run as a Github Action](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) to create a new workflow, such as:`.github/workflows/help_docs.yml`:
|
||||
1) Follow the steps depicted under [Run as a Github Action](https://Blackbox-merge-docs.Blackbox.ai/installation/github/#run-as-a-github-action) to create a new workflow, such as:`.github/workflows/help_docs.yml`:
|
||||
|
||||
2) Edit your yaml file to the following:
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
|
|||
|
||||
___
|
||||
|
||||
!!! note "The following features are available only for Qodo Merge 💎 users:"
|
||||
!!! note "The following features are available only for Blackbox Merge 💎 users:"
|
||||
- The `Apply / Chat` checkbox, which interactively converts a suggestion into a committable code comment
|
||||
- The `More` checkbox to generate additional suggestions
|
||||
- On Bitbucket (Cloud & Data Center) and GitLab Server (v16 and earlier), you can invoke [More Suggestions manually](#manual-more-suggestions)
|
||||
|
|
@ -52,7 +52,7 @@ To generate more suggestions (distinct from the ones already generated), for git
|
|||
|
||||
### Automatic triggering
|
||||
|
||||
To run the `improve` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file):
|
||||
To run the `improve` automatically when a PR is opened, define in a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#wiki-configuration-file):
|
||||
|
||||
```toml
|
||||
[github_app]
|
||||
|
|
@ -71,7 +71,7 @@ num_code_suggestions_per_chunk = ...
|
|||
|
||||
### Table vs Committable code comments
|
||||
|
||||
Qodo Merge supports two modes for presenting code suggestions:
|
||||
Blackbox Merge supports two modes for presenting code suggestions:
|
||||
|
||||
1) [Table](https://codium.ai/images/pr_agent/code_suggestions_as_comment_closed.png) mode
|
||||
|
||||
|
|
@ -84,9 +84,9 @@ The table format offers several key advantages:
|
|||
- **High-level suggestions**: High-level suggestions that aren't tied to specific code chunks are presented only in the table mode
|
||||
- **Interactive features**: Provides 'more' and 'update' functionality via clickable buttons
|
||||
- **Centralized tracking**: Shows suggestion implementation status in one place
|
||||
- **IDE integration**: Allows applying suggestions directly in your IDE via [Qodo Command](https://github.com/qodo-ai/agents)
|
||||
- **IDE integration**: Allows applying suggestions directly in your IDE via [Blackbox Command](https://github.com/Blackbox-ai/agents)
|
||||
|
||||
Table mode is the default of Qodo Merge, and is recommended approach for most users due to these benefits.
|
||||
Table mode is the default of Blackbox Merge, and is recommended approach for most users due to these benefits.
|
||||
|
||||
{width=512}
|
||||
|
||||
|
|
@ -99,14 +99,14 @@ Teams with specific preferences can enable committable code comments mode in the
|
|||
|
||||
>`💎 feature`
|
||||
|
||||
Qodo Merge tracks two types of implementations for tracking implemented suggestions:
|
||||
Blackbox Merge tracks two types of implementations for tracking implemented suggestions:
|
||||
|
||||
- Direct implementation - when the user directly applies the suggestion by clicking the `Apply` checkbox.
|
||||
- Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Qodo Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented.
|
||||
- Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Blackbox Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented.
|
||||
|
||||
{width=512}
|
||||
|
||||
In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process.
|
||||
In post-process, Blackbox Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process.
|
||||
|
||||
{width=512}
|
||||
|
||||
|
|
@ -116,12 +116,12 @@ In post-process, Qodo Merge counts the number of suggestions that were implement
|
|||
|
||||
>`💎 feature. Platforms supported: GitHub, GitLab`
|
||||
|
||||
Qodo Merge employs a novel detection system to automatically [identify](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) AI code suggestions that PR authors have accepted and implemented.
|
||||
Blackbox Merge employs a novel detection system to automatically [identify](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/impact_evaluation/) AI code suggestions that PR authors have accepted and implemented.
|
||||
|
||||
Accepted suggestions are also automatically documented in a dedicated wiki page called `.pr_agent_accepted_suggestions`, allowing users to track historical changes, assess the tool's effectiveness, and learn from previously implemented recommendations in the repository.
|
||||
An example [result](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions):
|
||||
|
||||
[{width=768}](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
|
||||
[{width=768}](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
|
||||
|
||||
This dedicated wiki page will also serve as a foundation for future AI model improvements, allowing it to learn from historically implemented suggestions and generate more targeted, contextually relevant recommendations.
|
||||
|
||||
|
|
@ -132,7 +132,7 @@ This feature is controlled by a boolean configuration parameter: `pr_code_sugges
|
|||
|
||||
To initialize the wiki: navigate to `Wiki`, select `Create the first page`, then click `Save page`.
|
||||
|
||||
{width=768}
|
||||
{width=768}
|
||||
|
||||
Once a wiki repo is created, the tool will automatically use this wiki for tracking suggestions.
|
||||
|
||||
|
|
@ -168,7 +168,7 @@ Use triple quotes to write multi-line instructions. Use bullet points or numbers
|
|||
|
||||
> `💎 feature. Platforms supported: GitHub, GitLab, Bitbucket`
|
||||
|
||||
Qodo Merge supports both simple and hierarchical best practices configurations to provide guidance to the AI model for generating relevant code suggestions.
|
||||
Blackbox Merge supports both simple and hierarchical best practices configurations to provide guidance to the AI model for generating relevant code suggestions.
|
||||
|
||||
???- tip "Writing effective best practices files"
|
||||
|
||||
|
|
@ -235,7 +235,7 @@ The AI model will use this `best_practices.md` file as a reference, and in case
|
|||
#### Global hierarchical best practices
|
||||
|
||||
|
||||
For organizations managing multiple repositories with different requirements, Qodo Merge supports a hierarchical best practices system using a dedicated global configuration repository.
|
||||
For organizations managing multiple repositories with different requirements, Blackbox Merge supports a hierarchical best practices system using a dedicated global configuration repository.
|
||||
|
||||
**Supported scenarios:**
|
||||
|
||||
|
|
@ -323,7 +323,7 @@ For organizations managing multiple repositories with different requirements, Qo
|
|||
|
||||
???- info "Best practices priority and fallback behavior"
|
||||
|
||||
When global best practices are enabled, Qodo Merge follows this priority order:
|
||||
When global best practices are enabled, Blackbox Merge follows this priority order:
|
||||
|
||||
1\. **Primary**: Global hierarchical best practices from `pr-agent-settings` repository:
|
||||
|
||||
|
|
@ -344,7 +344,7 @@ For organizations managing multiple repositories with different requirements, Qo
|
|||
???- info "Edge cases and behavior"
|
||||
|
||||
- **Missing paths**: If specified paths in `metadata.yaml` don't exist in the file system, those paths are skipped
|
||||
- **Monorepo subproject matching**: For monorepos, Qodo Merge automatically matches PR file paths against subproject paths to apply relevant best practices
|
||||
- **Monorepo subproject matching**: For monorepos, Blackbox Merge automatically matches PR file paths against subproject paths to apply relevant best practices
|
||||
- **Multiple group inheritance**: Repositories can inherit from multiple groups, and all applicable best practices are combined
|
||||
|
||||
[//]: # (#### Best practices for multiple languages)
|
||||
|
|
@ -352,7 +352,7 @@ For organizations managing multiple repositories with different requirements, Qo
|
|||
[//]: # ()
|
||||
[//]: # (For a git organization working with multiple programming languages, you can maintain a centralized global `best_practices.md` file containing language-specific guidelines.)
|
||||
|
||||
[//]: # (When reviewing pull requests, Qodo Merge automatically identifies the programming language and applies the relevant best practices from this file.)
|
||||
[//]: # (When reviewing pull requests, Blackbox Merge automatically identifies the programming language and applies the relevant best practices from this file.)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (To do this, structure your `best_practices.md` file using the following format:)
|
||||
|
|
@ -394,10 +394,10 @@ For organizations managing multiple repositories with different requirements, Qo
|
|||
|
||||
>`💎 feature. Platforms supported: GitHub.`
|
||||
|
||||
`Auto best practices` is a novel Qodo Merge capability that:
|
||||
`Auto best practices` is a novel Blackbox Merge capability that:
|
||||
|
||||
1. Identifies recurring patterns from accepted suggestions
|
||||
2. **Automatically** generates [best practices page](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_auto_best_practices) based on what your team consistently values
|
||||
2. **Automatically** generates [best practices page](https://github.com/Blackbox-ai/pr-agent/wiki/.pr_agent_auto_best_practices) based on what your team consistently values
|
||||
3. Applies these learned patterns to future code reviews
|
||||
|
||||
This creates an automatic feedback loop where the system continuously learns from your team's choices to provide increasingly relevant suggestions.
|
||||
|
|
@ -406,8 +406,8 @@ The system maintains two analysis phases:
|
|||
- Open exploration for new issues
|
||||
- Targeted checking against established best practices
|
||||
|
||||
Note that when a [custom best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) exist, Qodo Merge will still generate an 'auto best practices' wiki file, though it won't use it in the `improve` tool.
|
||||
Learn more about utilizing 'auto best practices' in our [detailed guide](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/).
|
||||
Note that when a [custom best practices](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#best-practices) exist, Blackbox Merge will still generate an 'auto best practices' wiki file, though it won't use it in the `improve` tool.
|
||||
Learn more about utilizing 'auto best practices' in our [detailed guide](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/auto_best_practices/).
|
||||
|
||||
#### Relevant configurations
|
||||
|
||||
|
|
@ -457,7 +457,7 @@ In such cases, we recommend prioritizing the suggestion's detailed description,
|
|||
|
||||
### Dual publishing mode
|
||||
|
||||
Our recommended approach for presenting code suggestions is through a [table](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) (`--pr_code_suggestions.commitable_code_suggestions=false`).
|
||||
Our recommended approach for presenting code suggestions is through a [table](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#overview) (`--pr_code_suggestions.commitable_code_suggestions=false`).
|
||||
This method significantly reduces the PR footprint and allows for quick and easy digestion of multiple suggestions.
|
||||
|
||||
We also offer a complementary **dual publishing mode**. When enabled, suggestions exceeding a certain score threshold are not only displayed in the table, but also presented as committable PR comments.
|
||||
|
|
@ -537,23 +537,23 @@ code_suggestions_self_review_text = "... (your text here) ..."
|
|||
|
||||
### How many code suggestions are generated?
|
||||
|
||||
Qodo Merge uses a dynamic strategy to generate code suggestions based on the size of the pull request (PR). Here's how it works:
|
||||
Blackbox Merge uses a dynamic strategy to generate code suggestions based on the size of the pull request (PR). Here's how it works:
|
||||
|
||||
#### 1. Chunking large PRs
|
||||
|
||||
- Qodo Merge divides large PRs into 'chunks'.
|
||||
- Blackbox Merge divides large PRs into 'chunks'.
|
||||
- Each chunk contains up to `config.max_model_tokens` tokens (default: 32,000).
|
||||
|
||||
#### 2. Generating suggestions
|
||||
|
||||
- For each chunk, Qodo Merge generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 3).
|
||||
- For each chunk, Blackbox Merge generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 3).
|
||||
|
||||
This approach has two main benefits:
|
||||
|
||||
- Scalability: The number of suggestions scales with the PR size, rather than being fixed.
|
||||
- Quality: By processing smaller chunks, the AI can maintain higher quality suggestions, as larger contexts tend to decrease AI performance.
|
||||
|
||||
Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 lines of code), Qodo Merge will be able to process the entire code in a single call.
|
||||
Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 lines of code), Blackbox Merge will be able to process the entire code in a single call.
|
||||
|
||||
#### Maximum coverage configuration
|
||||
> `💎 feature`
|
||||
|
|
@ -679,6 +679,6 @@ This configuration is recommended for:
|
|||
- **Self-reflection:** The suggestions aim to enable developers to _self-reflect_ and improve their pull requests. This process can help to identify blind spots, uncover missed edge cases, and enhance code readability and coherency. Even when a specific code suggestion isn't suitable, the underlying issue it highlights often reveals something important that might deserve attention.
|
||||
- **Bug detection:** The suggestions also alert on any _critical bugs_ that may have been identified during the analysis. This provides an additional safety net to catch potential issues before they make it into production. It's perfectly acceptable to implement only the suggestions you find valuable for your specific context.
|
||||
- **Hierarchy:** Presenting the suggestions in a structured hierarchical table enables the user to _quickly_ understand them, and to decide which ones are relevant and which are not.
|
||||
- **Customization:** To guide the model to suggestions that are more relevant to the specific needs of your project, we recommend using the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) and [`best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) fields.
|
||||
- **Model Selection:** SaaS users can also [choose](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/) between different models. For specific programming languages or use cases, some models may perform better than others.
|
||||
- **Interactive usage:** The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.
|
||||
- **Customization:** To guide the model to suggestions that are more relevant to the specific needs of your project, we recommend using the [`extra_instructions`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#extra-instructions-and-best-practices) and [`best practices`](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#best-practices) fields.
|
||||
- **Model Selection:** SaaS users can also [choose](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/Blackbox_merge_models/) between different models. For specific programming languages or use cases, some models may perform better than others.
|
||||
- **Interactive usage:** The interactive [PR chat](https://Blackbox-merge-docs.Blackbox.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Tools
|
||||
|
||||
Here is a list of Qodo Merge tools, each with a dedicated page that explains how to use it:
|
||||
Here is a list of Blackbox Merge tools, each with a dedicated page that explains how to use it:
|
||||
|
||||
| Tool | Description |
|
||||
|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
|
@ -24,4 +24,4 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how
|
|||
| **💎 [Scan Repo Discussions (`/scan_repo_discussions`](./scan_repo_discussions.md))** | Generates `best_practices.md` file based on previous discussions in the repository |
|
||||
| **💎 [Similar Code (`/similar_code`](./similar_code.md))** | Retrieves the most similar code components from inside the organization's codebase, or from open-source code. |
|
||||
|
||||
Note that the tools marked with 💎 are available only for Qodo Merge users.
|
||||
Note that the tools marked with 💎 are available only for Blackbox Merge users.
|
||||
|
|
@ -12,8 +12,8 @@ When a ticket is created, it appears in the PR description under an `Auto-create
|
|||
{width=512}
|
||||
|
||||
!!! info "Pre-requisites"
|
||||
- To use this tool you need to integrate your ticketing system with Qodo-merge, follow the [Ticket Compliance Documentation](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/).
|
||||
- For Jira Cloud users, please re-integrate your connection through the [qodo merge integration page](https://app.qodo.ai/qodo-merge/integrations) to enable the `update` permission required for ticket creation
|
||||
- To use this tool you need to integrate your ticketing system with Blackbox-merge, follow the [Ticket Compliance Documentation](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/fetching_ticket_context/).
|
||||
- For Jira Cloud users, please re-integrate your connection through the [Blackbox merge integration page](https://app.Blackbox.ai/Blackbox-merge/integrations) to enable the `update` permission required for ticket creation
|
||||
- You need to configure the project key in ticket corresponding to the repository where the PR is created. This is done by adding the `default_project_key`.
|
||||
|
||||
```toml
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
|
|||
|
||||
Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedback and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions.
|
||||
|
||||
(Read more about the different personas in the PR process and how Qodo Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/))
|
||||
(Read more about the different personas in the PR process and how Blackbox Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/))
|
||||
|
||||
## Example usage
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ If you want to edit [configurations](#configuration-options), add the relevant o
|
|||
|
||||
### Automatic triggering
|
||||
|
||||
To run the `review` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file):
|
||||
To run the `review` automatically when a PR is opened, define in a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#wiki-configuration-file):
|
||||
|
||||
```
|
||||
[github_app]
|
||||
|
|
@ -146,7 +146,7 @@ extra_instructions = "..."
|
|||
### Automation
|
||||
|
||||
!!! tip ""
|
||||
When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is:
|
||||
When you first install Blackbox Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is:
|
||||
```
|
||||
pr_commands = ["/review", ...]
|
||||
```
|
||||
|
|
@ -159,8 +159,8 @@ extra_instructions = "..."
|
|||
|
||||
The `review` can tool automatically add labels to your Pull Requests:
|
||||
|
||||
- **`possible security issue`**: This label is applied if the tool detects a potential [security vulnerability](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L103) in the PR's code. This feedback is controlled by the 'enable_review_labels_security' flag (default is true).
|
||||
- **`review effort [x/5]`**: This label estimates the [effort](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L90) required to review the PR on a relative scale of 1 to 5, where 'x' represents the assessed effort. This feedback is controlled by the 'enable_review_labels_effort' flag (default is true).
|
||||
- **`possible security issue`**: This label is applied if the tool detects a potential [security vulnerability](https://github.com/Blackbox-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L103) in the PR's code. This feedback is controlled by the 'enable_review_labels_security' flag (default is true).
|
||||
- **`review effort [x/5]`**: This label estimates the [effort](https://github.com/Blackbox-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L90) required to review the PR on a relative scale of 1 to 5, where 'x' represents the assessed effort. This feedback is controlled by the 'enable_review_labels_effort' flag (default is true).
|
||||
- **`ticket compliance`**: Adds a label indicating code compliance level ("Fully compliant" | "PR Code Verified" | "Partially compliant" | "Not compliant") to any GitHub/Jira/Linea ticket linked in the PR. Controlled by the 'require_ticket_labels' flag (default: false). If 'require_no_ticket_labels' is also enabled, PRs without ticket links will receive a "No ticket found" label.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,10 +3,10 @@
|
|||
## Overview
|
||||
|
||||
The `scan_repo_discussions` tool analyzes code discussions (meaning review comments over code lines) from merged pull requests over the past 12 months.
|
||||
It processes these discussions alongside other PR metadata to identify recurring patterns related to best practices in team feedback and code reviews, generating a comprehensive [`best_practices.md`](https://github.com/qodo-ai/pr-agent/blob/qodo-merge-best-practices_2025-04-16_1018/best_practices.md) document that distills key insights and recommendations.
|
||||
It processes these discussions alongside other PR metadata to identify recurring patterns related to best practices in team feedback and code reviews, generating a comprehensive [`best_practices.md`](https://github.com/Blackbox-ai/pr-agent/blob/Blackbox-merge-best-practices_2025-04-16_1018/best_practices.md) document that distills key insights and recommendations.
|
||||
|
||||
This file captures repository-specific patterns derived from your team's actual workflow and discussions, rather than more generic best practices.
|
||||
It will be utilized by Qodo Merge to provide tailored suggestions for improving code quality in future pull requests.
|
||||
It will be utilized by Blackbox Merge to provide tailored suggestions for improving code quality in future pull requests.
|
||||
|
||||
!!! note "Active repositories are needed"
|
||||
The tool is designed to work with real-life repositories, as it relies on actual discussions to generate meaningful insights.
|
||||
|
|
@ -14,7 +14,7 @@ It will be utilized by Qodo Merge to provide tailored suggestions for improving
|
|||
|
||||
!!! note "Additional customization"
|
||||
Teams are encouraged to further customize and refine these insights to better align with their specific development priorities and contexts.
|
||||
This can be done by editing the `best_practices.md` file directly when the PR is created, or iteratively over time to enhance the 'best practices' suggestions provided by Qodo Merge.
|
||||
This can be done by editing the `best_practices.md` file directly when the PR is created, or iteratively over time to enhance the 'best practices' suggestions provided by Blackbox Merge.
|
||||
|
||||
The tool can be invoked manually by commenting on any PR:
|
||||
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@ A `Global Search` for a method called `chat_completion`:
|
|||
|
||||
{width=768}
|
||||
|
||||
Qodo Merge will examine the code component and will extract the most relevant keywords to search for similar code:
|
||||
Blackbox Merge will examine the code component and will extract the most relevant keywords to search for similar code:
|
||||
|
||||
- `extracted keywords`: the keywords that were extracted from the code by Qodo Merge. the link will open a search page with the extracted keywords, to allow the user to modify the search if needed.
|
||||
- `extracted keywords`: the keywords that were extracted from the code by Blackbox Merge. the link will open a search page with the extracted keywords, to allow the user to modify the search if needed.
|
||||
- `search context`: the context in which the search will be performed, organization's codebase or open-source code (Global).
|
||||
- `similar code`: the most similar code components found. the link will open the code component in the relevant file.
|
||||
- `relevant repositories`: the open-source repositories in which that are relevant to the searched code component and it's keywords.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
## Show possible configurations
|
||||
|
||||
The possible configurations of Qodo Merge are stored in [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml){:target="_blank"}.
|
||||
In the [tools](https://qodo-merge-docs.qodo.ai/tools/) page you can find explanations on how to use these configurations for each tool.
|
||||
The possible configurations of Blackbox Merge are stored in [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml){:target="_blank"}.
|
||||
In the [tools](https://Blackbox-merge-docs.Blackbox.ai/tools/) page you can find explanations on how to use these configurations for each tool.
|
||||
|
||||
To print all the available configurations as a comment on your PR, you can use the following command:
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Will output an additional field showing the actual configurations used for the `
|
|||
|
||||
## Ignoring files from analysis
|
||||
|
||||
In some cases, you may want to exclude specific files or directories from the analysis performed by Qodo Merge. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendor code.
|
||||
In some cases, you may want to exclude specific files or directories from the analysis performed by Blackbox Merge. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendor code.
|
||||
|
||||
You can ignore files or folders using the following methods:
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ regex = ['.*\.py$']
|
|||
|
||||
## Extra instructions
|
||||
|
||||
All Qodo Merge tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
|
||||
All Blackbox Merge tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
|
||||
|
||||
```
|
||||
/update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..."
|
||||
|
|
@ -64,7 +64,7 @@ All Qodo Merge tools have a parameter called `extra_instructions`, that enables
|
|||
|
||||
## Language Settings
|
||||
|
||||
The default response language for Qodo Merge is **U.S. English**. However, some development teams may prefer to display information in a different language. For example, your team's workflow might improve if PR descriptions and code suggestions are set to your country's native language.
|
||||
The default response language for Blackbox Merge is **U.S. English**. However, some development teams may prefer to display information in a different language. For example, your team's workflow might improve if PR descriptions and code suggestions are set to your country's native language.
|
||||
|
||||
To configure this, set the `response_language` parameter in the configuration file. This will prompt the model to respond in the specified language. Use a **standard locale code** based on [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) (country codes) and [ISO 639](https://en.wikipedia.org/wiki/ISO_639) (language codes) to define a language-country pair. See this [comprehensive list of locale codes](https://simplelocalize.io/data/locales/).
|
||||
|
||||
|
|
@ -91,27 +91,27 @@ This will set the response language globally for all the commands to Italian.
|
|||
[//]: # ()
|
||||
[//]: # (However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are two possible solutions:)
|
||||
|
||||
[//]: # (1) [Use a model](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.)
|
||||
[//]: # (1) [Use a model](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.)
|
||||
|
||||
[//]: # (2) For the `/improve` tool, there is an ['extended' mode](https://qodo-merge-docs.qodo.ai/tools/improve/) (`/improve --extended`),)
|
||||
[//]: # (2) For the `/improve` tool, there is an ['extended' mode](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/) (`/improve --extended`),)
|
||||
|
||||
[//]: # (which divides the PR into chunks, and processes each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur))
|
||||
|
||||
|
||||
## Expand GitLab submodule diffs
|
||||
|
||||
By default, GitLab merge requests show submodule updates as `Subproject commit` lines. To include the actual file-level changes from those submodules in Qodo Merge analysis, enable:
|
||||
By default, GitLab merge requests show submodule updates as `Subproject commit` lines. To include the actual file-level changes from those submodules in Blackbox Merge analysis, enable:
|
||||
|
||||
```toml
|
||||
[gitlab]
|
||||
expand_submodule_diffs = true
|
||||
```
|
||||
|
||||
When enabled, Qodo Merge will fetch and attach diffs from the submodule repositories. The default is `false` to avoid extra GitLab API calls.
|
||||
When enabled, Blackbox Merge will fetch and attach diffs from the submodule repositories. The default is `false` to avoid extra GitLab API calls.
|
||||
|
||||
## Log Level
|
||||
|
||||
Qodo Merge allows you to control the verbosity of logging by using the `log_level` configuration parameter. This is particularly useful for troubleshooting and debugging issues with your PR workflows.
|
||||
Blackbox Merge allows you to control the verbosity of logging by using the `log_level` configuration parameter. This is particularly useful for troubleshooting and debugging issues with your PR workflows.
|
||||
|
||||
```
|
||||
[config]
|
||||
|
|
@ -142,9 +142,9 @@ LANGSMITH_PROJECT=<project>
|
|||
LANGSMITH_BASE_URL=<url>
|
||||
```
|
||||
|
||||
## Bringing additional repository metadata to Qodo Merge 💎
|
||||
## Bringing additional repository metadata to Blackbox Merge 💎
|
||||
|
||||
To provide Qodo Merge tools with additional context about your project, you can enable automatic repository metadata detection.
|
||||
To provide Blackbox Merge tools with additional context about your project, you can enable automatic repository metadata detection.
|
||||
|
||||
If you set:
|
||||
|
||||
|
|
@ -153,8 +153,8 @@ If you set:
|
|||
add_repo_metadata = true
|
||||
```
|
||||
|
||||
Qodo Merge automatically searches for repository metadata files in your PR's head branch root directory. By default, it looks for:
|
||||
[AGENTS.MD](https://agents.md/), [QODO.MD](https://docs.qodo.ai/qodo-documentation/qodo-command/getting-started/setup-and-quickstart), [CLAUDE.MD](https://www.anthropic.com/engineering/claude-code-best-practices).
|
||||
Blackbox Merge automatically searches for repository metadata files in your PR's head branch root directory. By default, it looks for:
|
||||
[AGENTS.MD](https://agents.md/), [Blackbox.MD](https://docs.Blackbox.ai/Blackbox-documentation/Blackbox-command/getting-started/setup-and-quickstart), [CLAUDE.MD](https://www.anthropic.com/engineering/claude-code-best-practices).
|
||||
|
||||
You can also specify custom filenames to search for:
|
||||
|
||||
|
|
@ -165,7 +165,7 @@ add_repo_metadata_file_list= ["file1.md", "file2.md", ...]
|
|||
|
||||
## Ignoring automatic commands in PRs
|
||||
|
||||
Qodo Merge allows you to automatically ignore certain PRs based on various criteria:
|
||||
Blackbox Merge allows you to automatically ignore certain PRs based on various criteria:
|
||||
|
||||
- PRs with specific titles (using regex matching)
|
||||
- PRs between specific branches (using regex matching)
|
||||
|
|
@ -234,7 +234,7 @@ Where the `ignore_pr_labels` is a list of labels that when present in the PR, th
|
|||
|
||||
### Ignoring PRs from specific users
|
||||
|
||||
Qodo Merge tries to automatically identify and ignore pull requests created by bots using:
|
||||
Blackbox Merge tries to automatically identify and ignore pull requests created by bots using:
|
||||
|
||||
- GitHub's native bot detection system
|
||||
- Name-based pattern matching
|
||||
|
|
@ -254,7 +254,7 @@ ignore_pr_authors = ["my-special-bot-user", ...]
|
|||
Where the `ignore_pr_authors` is a regex list of usernames that you want to ignore.
|
||||
|
||||
!!! note
|
||||
There is one specific case where bots will receive an automatic response - when they generated a PR with a _failed test_. In that case, the [`ci_feedback`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) tool will be invoked.
|
||||
There is one specific case where bots will receive an automatic response - when they generated a PR with a _failed test_. In that case, the [`ci_feedback`](https://Blackbox-merge-docs.Blackbox.ai/tools/ci_feedback/) tool will be invoked.
|
||||
|
||||
### Ignoring Generated Files by Language/Framework
|
||||
|
||||
|
|
@ -265,12 +265,12 @@ To automatically exclude files generated by specific languages or frameworks, yo
|
|||
ignore_language_framework = ['protobuf', ...]
|
||||
```
|
||||
|
||||
You can view the list of auto-generated file patterns in [`generated_code_ignore.toml`](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/generated_code_ignore.toml).
|
||||
You can view the list of auto-generated file patterns in [`generated_code_ignore.toml`](https://github.com/Blackbox-ai/pr-agent/blob/main/pr_agent/settings/generated_code_ignore.toml).
|
||||
Files matching these glob patterns will be automatically excluded from PR Agent analysis.
|
||||
|
||||
### Ignoring Tickets with Specific Labels
|
||||
|
||||
When Qodo Merge analyzes tickets (JIRA, GitHub Issues, GitLab Issues, etc.) referenced in your PR, you may want to exclude tickets that have certain labels from the analysis. This is useful for filtering out tickets marked as "ignore-compliance", "skip-review", or other labels that indicate the ticket should not be considered during PR review.
|
||||
When Blackbox Merge analyzes tickets (JIRA, GitHub Issues, GitLab Issues, etc.) referenced in your PR, you may want to exclude tickets that have certain labels from the analysis. This is useful for filtering out tickets marked as "ignore-compliance", "skip-review", or other labels that indicate the ticket should not be considered during PR review.
|
||||
|
||||
To ignore tickets with specific labels, add the following to your `configuration.toml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
## Local repo (CLI)
|
||||
|
||||
When running from your locally cloned Qodo Merge repo (CLI), your local configuration file will be used.
|
||||
When running from your locally cloned Blackbox Merge repo (CLI), your local configuration file will be used.
|
||||
Examples of invoking the different tools via the CLI:
|
||||
|
||||
- **Review**: `python -m pr_agent.cli --pr_url=<pr_url> review`
|
||||
|
|
@ -29,12 +29,12 @@ verbosity_level=2
|
|||
|
||||
This is useful for debugging or experimenting with different tools.
|
||||
|
||||
3. **git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by Qodo Merge. Currently, the following providers are supported:
|
||||
3. **git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by Blackbox Merge. Currently, the following providers are supported:
|
||||
`github` **(default)**, `gitlab`, `bitbucket`, `azure`, `codecommit`, `local`, and `gitea`.
|
||||
|
||||
### CLI Health Check
|
||||
|
||||
To verify that Qodo Merge has been configured correctly, you can run this health check command from the repository root:
|
||||
To verify that Blackbox Merge has been configured correctly, you can run this health check command from the repository root:
|
||||
|
||||
```bash
|
||||
python -m tests.health_test.main
|
||||
|
|
@ -52,12 +52,12 @@ At the end of the run.
|
|||
|
||||
Before running the health check, ensure you have:
|
||||
|
||||
- Configured your [LLM provider](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)
|
||||
- Configured your [LLM provider](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/)
|
||||
- Added a valid GitHub token to your configuration file
|
||||
|
||||
## Online usage
|
||||
|
||||
Online usage means invoking Qodo Merge tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR.
|
||||
Online usage means invoking Blackbox Merge tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR.
|
||||
Commands for invoking the different tools via comments:
|
||||
|
||||
- **Review**: `/review`
|
||||
|
|
@ -75,23 +75,23 @@ For example, if you want to edit the `review` tool configurations, you can run:
|
|||
|
||||
Any configuration value in [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file can be similarly edited. Comment `/config` to see the list of available configurations.
|
||||
|
||||
## Qodo Merge Automatic Feedback
|
||||
## Blackbox Merge Automatic Feedback
|
||||
|
||||
### Disabling all automatic feedback
|
||||
|
||||
To easily disable all automatic feedback from Qodo Merge (GitHub App, GitLab Webhook, BitBucket App, Azure DevOps Webhook), set in a configuration file:
|
||||
To easily disable all automatic feedback from Blackbox Merge (GitHub App, GitLab Webhook, BitBucket App, Azure DevOps Webhook), set in a configuration file:
|
||||
|
||||
```toml
|
||||
[config]
|
||||
disable_auto_feedback = true
|
||||
```
|
||||
|
||||
When this parameter is set to `true`, Qodo Merge will not run any automatic tools (like `describe`, `review`, `improve`) when a new PR is opened, or when new code is pushed to an open PR.
|
||||
When this parameter is set to `true`, Blackbox Merge will not run any automatic tools (like `describe`, `review`, `improve`) when a new PR is opened, or when new code is pushed to an open PR.
|
||||
|
||||
### GitHub App
|
||||
|
||||
!!! note "Configurations for Qodo Merge"
|
||||
Qodo Merge for GitHub is an App, hosted by Qodo. So all the instructions below are relevant also for Qodo Merge users.
|
||||
!!! note "Configurations for Blackbox Merge"
|
||||
Blackbox Merge for GitHub is an App, hosted by Blackbox. So all the instructions below are relevant also for Blackbox Merge users.
|
||||
Same goes for [GitLab webhook](#gitlab-webhook) and [BitBucket App](#bitbucket-app) sections.
|
||||
|
||||
#### GitHub app automatic tools when a new PR is opened
|
||||
|
|
@ -109,7 +109,7 @@ pr_commands = [
|
|||
]
|
||||
```
|
||||
|
||||
This means that when a new PR is opened/reopened or marked as ready for review, Qodo Merge will run the `describe`, `review` and `improve` tools.
|
||||
This means that when a new PR is opened/reopened or marked as ready for review, Blackbox Merge will run the `describe`, `review` and `improve` tools.
|
||||
|
||||
**Draft PRs:**
|
||||
|
||||
|
|
@ -122,7 +122,7 @@ feedback_on_draft_pr = true
|
|||
|
||||
**Changing default tool parameters:**
|
||||
|
||||
You can override the default tool parameters by using one the three options for a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/): **wiki**, **local**, or **global**.
|
||||
You can override the default tool parameters by using one the three options for a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/): **wiki**, **local**, or **global**.
|
||||
For example, if your configuration file contains:
|
||||
|
||||
```toml
|
||||
|
|
@ -163,11 +163,11 @@ push_commands = [
|
|||
]
|
||||
```
|
||||
|
||||
This means that when new code is pushed to the PR, the Qodo Merge will run the `describe` and `review` tools, with the specified parameters.
|
||||
This means that when new code is pushed to the PR, the Blackbox Merge will run the `describe` and `review` tools, with the specified parameters.
|
||||
|
||||
### GitHub Action
|
||||
|
||||
`GitHub Action` is a different way to trigger Qodo Merge tools, and uses a different configuration mechanism than `GitHub App`.<br>
|
||||
`GitHub Action` is a different way to trigger Blackbox Merge tools, and uses a different configuration mechanism than `GitHub App`.<br>
|
||||
You can configure settings for `GitHub Action` by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file.
|
||||
Specifically, start by setting the following environment variables:
|
||||
|
||||
|
|
@ -189,9 +189,9 @@ If not set, the default configuration is `["opened", "reopened", "ready_for_revi
|
|||
|
||||
`github_action_config.enable_output` are used to enable/disable github actions [output parameter](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions) (default is `true`).
|
||||
Review result is output as JSON to `steps.{step-id}.outputs.review` property.
|
||||
The JSON structure is equivalent to the yaml data structure defined in [pr_reviewer_prompts.toml](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml).
|
||||
The JSON structure is equivalent to the yaml data structure defined in [pr_reviewer_prompts.toml](https://github.com/Blackbox-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml).
|
||||
|
||||
Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) in the root of your repo
|
||||
Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#global-configuration-file) in the root of your repo
|
||||
|
||||
For example, you can set an environment variable: `pr_description.publish_labels=false`, or add a `.pr_agent.toml` file with the following content:
|
||||
|
||||
|
|
@ -200,7 +200,7 @@ For example, you can set an environment variable: `pr_description.publish_labels
|
|||
publish_labels = false
|
||||
```
|
||||
|
||||
to prevent Qodo Merge from publishing labels when running the `describe` tool.
|
||||
to prevent Blackbox Merge from publishing labels when running the `describe` tool.
|
||||
|
||||
#### Enable using commands in PR
|
||||
|
||||
|
|
@ -214,7 +214,7 @@ on:
|
|||
types: [created, edited]
|
||||
```
|
||||
|
||||
When this is configured, Qodo merge can be invoked by commenting on the PR.
|
||||
When this is configured, Blackbox merge can be invoked by commenting on the PR.
|
||||
|
||||
#### Quick Reference: Model Configuration in GitHub Actions
|
||||
|
||||
|
|
@ -265,7 +265,7 @@ Note that to use the 'handle_push_trigger' feature, you need to give the gitlab
|
|||
|
||||
### BitBucket App
|
||||
|
||||
Similar to GitHub app, when running Qodo Merge from BitBucket App, the default [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) will be initially loaded.
|
||||
Similar to GitHub app, when running Blackbox Merge from BitBucket App, the default [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) will be initially loaded.
|
||||
|
||||
By uploading a local `.pr_agent.toml` file to the root of the repo's default branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
|
||||
|
||||
|
|
@ -279,8 +279,8 @@ extra_instructions = "Answer in japanese"
|
|||
Each time you invoke a `/review` tool, it will use the extra instructions you set in the local configuration file.
|
||||
|
||||
Note that among other limitations, BitBucket provides relatively low rate-limits for applications (up to 1000 requests per hour), and does not provide an API to track the actual rate-limit usage.
|
||||
If you experience a lack of responses from Qodo Merge, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file.
|
||||
This will prevent Qodo Merge from acquiring the full file content, and will only use the diff content. This will reduce the number of requests made to BitBucket, at the cost of small decrease in accuracy, as dynamic context will not be applicable.
|
||||
If you experience a lack of responses from Blackbox Merge, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file.
|
||||
This will prevent Blackbox Merge from acquiring the full file content, and will only use the diff content. This will reduce the number of requests made to BitBucket, at the cost of small decrease in accuracy, as dynamic context will not be applicable.
|
||||
|
||||
#### BitBucket Self-Hosted App automatic tools
|
||||
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ By default, Ollama uses a context window size of 2048 tokens. In most cases this
|
|||
Please note that the `custom_model_max_tokens` setting should be configured in accordance with the `OLLAMA_CONTEXT_LENGTH`. Failure to do so may result in unexpected model output.
|
||||
|
||||
!!! note "Local models vs commercial models"
|
||||
Qodo Merge is compatible with almost any AI model, but analyzing complex code repositories and pull requests requires a model specifically optimized for code analysis.
|
||||
Blackbox Merge is compatible with almost any AI model, but analyzing complex code repositories and pull requests requires a model specifically optimized for code analysis.
|
||||
|
||||
Commercial models such as GPT-5, Claude Sonnet, and Gemini have demonstrated robust capabilities in generating structured output for code analysis tasks with large input. In contrast, most open-source models currently available (as of January 2025) face challenges with these complex tasks.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
The different tools and sub-tools used by Qodo Merge are adjustable via a Git configuration file.
|
||||
The different tools and sub-tools used by Blackbox Merge are adjustable via a Git configuration file.
|
||||
There are three main ways to set persistent configurations:
|
||||
|
||||
1. [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file) configuration page 💎
|
||||
2. [Local](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#local-configuration-file) configuration file
|
||||
3. [Global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration file 💎
|
||||
1. [Wiki](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#wiki-configuration-file) configuration page 💎
|
||||
2. [Local](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#local-configuration-file) configuration file
|
||||
3. [Global](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#global-configuration-file) configuration file 💎
|
||||
|
||||
In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations.
|
||||
|
||||
|
||||
For a list of all possible configurations, see the [configuration options](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml/) page.
|
||||
For a list of all possible configurations, see the [configuration options](https://github.com/Blackbox-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml/) page.
|
||||
In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file.
|
||||
|
||||
!!! tip "Tip1: Edit only what you need"
|
||||
|
|
@ -22,7 +22,7 @@ In addition to general configuration options, each tool has its own configuratio
|
|||
|
||||
`Platforms supported: GitHub, GitLab, Bitbucket`
|
||||
|
||||
With Qodo Merge, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo.
|
||||
With Blackbox Merge, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo.
|
||||
The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**.
|
||||
|
||||
{width=512}
|
||||
|
|
@ -35,7 +35,7 @@ An example content:
|
|||
generate_ai_title=true
|
||||
```
|
||||
|
||||
Qodo Merge will know to remove the surrounding quotes when reading the configuration content.
|
||||
Blackbox Merge will know to remove the surrounding quotes when reading the configuration content.
|
||||
|
||||
## Local configuration file
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ Create a dedicated project to hold a global configuration file that affects all
|
|||
1. Create a new project with both the name and key: PR_AGENT_SETTINGS.
|
||||
2. Inside the PR_AGENT_SETTINGS project, create a repository named pr-agent-settings.
|
||||
3. In this repository, add a `.pr_agent.toml` configuration file—structured similarly to the global configuration file described above.
|
||||
4. Optionally, you can add organizational-level [global best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#global-hierarchical-best-practices).
|
||||
4. Optionally, you can add organizational-level [global best practices](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#global-hierarchical-best-practices).
|
||||
|
||||
Repositories across your entire Bitbucket organization will inherit the configuration from this file.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
|
||||
|
||||
For optimal functionality of Qodo Merge, we recommend enabling a wiki for each repository where Qodo Merge is installed. The wiki serves several important purposes:
|
||||
For optimal functionality of Blackbox Merge, we recommend enabling a wiki for each repository where Blackbox Merge is installed. The wiki serves several important purposes:
|
||||
|
||||
**Key Wiki Features: 💎**
|
||||
|
||||
- Storing a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file)
|
||||
- Track [accepted suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking)
|
||||
- Facilitates learning over time by creating an [auto_best_practices.md](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices) file
|
||||
- Storing a [configuration file](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/#wiki-configuration-file)
|
||||
- Track [accepted suggestions](https://Blackbox-merge-docs.Blackbox.ai/tools/improve/#suggestion-tracking)
|
||||
- Facilitates learning over time by creating an [auto_best_practices.md](https://Blackbox-merge-docs.Blackbox.ai/core-abilities/auto_best_practices) file
|
||||
|
||||
**Setup Instructions (GitHub):**
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ To enable a wiki for your repository:
|
|||
|
||||
### Why Wiki?
|
||||
|
||||
- Your code (and its derivatives, including accepted code suggestions) is yours. Qodo Merge will never store it on external servers.
|
||||
- Your code (and its derivatives, including accepted code suggestions) is yours. Blackbox Merge will never store it on external servers.
|
||||
- Repository changes typically require pull requests, which create overhead and are time-consuming. This process is too cumbersome for auto data aggregation, and is not very convenient even for managing frequently updated content like configuration files.
|
||||
- A repository wiki page provides an ideal balance:
|
||||
- It lives within your repository, making it suitable for code-related documentation
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Usage guide
|
||||
|
||||
This section provides a detailed guide on how to use Qodo Merge.
|
||||
It includes information on how to adjust Qodo Merge configurations, define which tools will run automatically, and other advanced configurations.
|
||||
This section provides a detailed guide on how to use Blackbox Merge.
|
||||
It includes information on how to adjust Blackbox Merge configurations, define which tools will run automatically, and other advanced configurations.
|
||||
|
||||
- [Introduction](./introduction.md)
|
||||
- [Enabling a Wiki](./enabling_a_wiki)
|
||||
|
|
@ -21,6 +21,6 @@ It includes information on how to adjust Qodo Merge configurations, define which
|
|||
- [Ignoring files from analysis](./additional_configurations.md#ignoring-files-from-analysis)
|
||||
- [Extra instructions](./additional_configurations.md#extra-instructions)
|
||||
- [Working with large PRs](./additional_configurations.md#working-with-large-prs)
|
||||
- [Changing a model](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)
|
||||
- [FAQ](https://qodo-merge-docs.qodo.ai/faq/)
|
||||
- [Qodo Merge Models](./qodo_merge_models)
|
||||
- [Changing a model](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/changing_a_model/)
|
||||
- [FAQ](https://Blackbox-merge-docs.Blackbox.ai/faq/)
|
||||
- [Blackbox Merge Models](./Blackbox_merge_models)
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
|
||||
After [installation](https://qodo-merge-docs.qodo.ai/installation/), there are three basic ways to invoke Qodo Merge:
|
||||
After [installation](https://Blackbox-merge-docs.Blackbox.ai/installation/), there are three basic ways to invoke Blackbox Merge:
|
||||
|
||||
1. Locally running a CLI command
|
||||
2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901){:target="_blank"} on a PR
|
||||
3. Enabling Qodo Merge tools to run automatically when a new PR is opened
|
||||
3. Enabling Blackbox Merge tools to run automatically when a new PR is opened
|
||||
|
||||
Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://qodo-merge-docs.qodo.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://qodo-merge-docs.qodo.ai/installation/locally/#run-from-source).
|
||||
Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://Blackbox-merge-docs.Blackbox.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://Blackbox-merge-docs.Blackbox.ai/installation/locally/#run-from-source).
|
||||
|
||||
For online usage, you will need to setup either a [GitHub App](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://qodo-merge-docs.qodo.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLab), or a [BitBucket App](https://qodo-merge-docs.qodo.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket).
|
||||
These platforms also enable to run Qodo Merge specific tools automatically when a new PR is opened, or on each push to a branch.
|
||||
For online usage, you will need to setup either a [GitHub App](https://Blackbox-merge-docs.Blackbox.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://Blackbox-merge-docs.Blackbox.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://Blackbox-merge-docs.Blackbox.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLab), or a [BitBucket App](https://Blackbox-merge-docs.Blackbox.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket).
|
||||
These platforms also enable to run Blackbox Merge specific tools automatically when a new PR is opened, or on each push to a branch.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
|
||||
Unfortunately, it is not possible in GitHub to disable mail notifications from a specific user.
|
||||
If you are subscribed to notifications for a repo with Qodo Merge, we recommend turning off notifications for PR comments, to avoid lengthy emails:
|
||||
If you are subscribed to notifications for a repo with Blackbox Merge, we recommend turning off notifications for PR comments, to avoid lengthy emails:
|
||||
|
||||
{width=512}
|
||||
|
||||
As an alternative, you can filter in your mail provider the notifications specifically from the Qodo Merge bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
|
||||
As an alternative, you can filter in your mail provider the notifications specifically from the Blackbox Merge bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
|
||||
|
||||
{width=512}
|
||||
|
||||
Another option to reduce the mail overload, yet still receive notifications on Qodo Merge tools, is to disable the help collapsible section in Qodo Merge bot comments.
|
||||
Another option to reduce the mail overload, yet still receive notifications on Blackbox Merge tools, is to disable the help collapsible section in Blackbox Merge bot comments.
|
||||
This can done by setting `enable_help_text=false` for the relevant tool in the configuration file.
|
||||
For example, to disable the help text for the `pr_reviewer` tool, set:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
|
||||
The default models used by Qodo Merge 💎 (October 2025) are a combination of GPT-5, Haiku-4.5, and Gemini 2.5 Pro.
|
||||
The default models used by Blackbox Merge 💎 (October 2025) are a combination of GPT-5, Haiku-4.5, and Gemini 2.5 Pro.
|
||||
|
||||
### Selecting a Specific Model
|
||||
|
||||
Users can configure Qodo Merge to use only a specific model by editing the [configuration](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) file.
|
||||
The models supported by Qodo Merge are:
|
||||
Users can configure Blackbox Merge to use only a specific model by editing the [configuration](https://Blackbox-merge-docs.Blackbox.ai/usage-guide/configuration_options/) file.
|
||||
The models supported by Blackbox Merge are:
|
||||
|
||||
- `gpt-5`
|
||||
- `claude-haiku-4.5`
|
||||
|
|
@ -12,28 +12,28 @@ The models supported by Qodo Merge are:
|
|||
- `o4-mini`
|
||||
- `deepseek/r1`
|
||||
|
||||
To restrict Qodo Merge to using only `o4-mini`, add this setting:
|
||||
To restrict Blackbox Merge to using only `o4-mini`, add this setting:
|
||||
|
||||
```toml
|
||||
[config]
|
||||
model="o4-mini"
|
||||
```
|
||||
|
||||
To restrict Qodo Merge to using only `GPT-5`, add this setting:
|
||||
To restrict Blackbox Merge to using only `GPT-5`, add this setting:
|
||||
|
||||
```toml
|
||||
[config]
|
||||
model="gpt-5"
|
||||
```
|
||||
|
||||
To restrict Qodo Merge to using only `gemini-2.5-pro`, add this setting:
|
||||
To restrict Blackbox Merge to using only `gemini-2.5-pro`, add this setting:
|
||||
|
||||
```toml
|
||||
[config]
|
||||
model="gemini-2.5-pro"
|
||||
```
|
||||
|
||||
To restrict Qodo Merge to using only `claude-4-sonnet`, add this setting:
|
||||
To restrict Blackbox Merge to using only `claude-4-sonnet`, add this setting:
|
||||
|
||||
```toml
|
||||
[config]
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
site_name: Qodo Merge (and open-source PR-Agent)
|
||||
repo_url: https://github.com/qodo-ai/pr-agent
|
||||
repo_name: Qodo-ai/pr-agent
|
||||
site_name: Blackbox Merge (and open-source PR-Agent)
|
||||
repo_url: https://github.com/Blackbox-ai/pr-agent
|
||||
repo_name: Blackbox-ai/pr-agent
|
||||
|
||||
nav:
|
||||
- Overview:
|
||||
- 'index.md'
|
||||
- 💎 Qodo Merge: 'overview/pr_agent_pro.md'
|
||||
- 💎 Blackbox Merge: 'overview/pr_agent_pro.md'
|
||||
- Data Privacy: 'overview/data_privacy.md'
|
||||
- Installation:
|
||||
- 'installation/index.md'
|
||||
- PR-Agent: 'installation/pr_agent.md'
|
||||
- 💎 Qodo Merge: 'installation/qodo_merge.md'
|
||||
- 💎 Blackbox Merge: 'installation/Blackbox_merge.md'
|
||||
- Usage Guide:
|
||||
- 'usage-guide/index.md'
|
||||
- Introduction: 'usage-guide/introduction.md'
|
||||
|
|
@ -21,7 +21,7 @@ nav:
|
|||
- Changing a Model: 'usage-guide/changing_a_model.md'
|
||||
- Additional Configurations: 'usage-guide/additional_configurations.md'
|
||||
- Frequently Asked Questions: 'faq/index.md'
|
||||
- Qodo Merge Models: 'usage-guide/qodo_merge_models.md'
|
||||
- Blackbox Merge Models: 'usage-guide/Blackbox_merge_models.md'
|
||||
- Tools:
|
||||
- 'tools/index.md'
|
||||
- Describe: 'tools/describe.md'
|
||||
|
|
@ -62,16 +62,16 @@ nav:
|
|||
- Self-reflection: 'core-abilities/self_reflection.md'
|
||||
- Static code analysis: 'core-abilities/static_code_analysis.md'
|
||||
# - Chrome Extension:
|
||||
# - Qodo Merge Chrome Extension: 'chrome-extension/index.md'
|
||||
# - Blackbox Merge Chrome Extension: 'chrome-extension/index.md'
|
||||
# - Features: 'chrome-extension/features.md'
|
||||
# - Data Privacy: 'chrome-extension/data_privacy.md'
|
||||
# - Options: 'chrome-extension/options.md'
|
||||
- Qodo Merge CLI:
|
||||
- Overview: 'qodo-merge-cli/index.md'
|
||||
- Installation: 'qodo-merge-cli/installation.md'
|
||||
- Usage: 'qodo-merge-cli/usage.md'
|
||||
#- Features & Usage: 'qodo-merge-cli/features.md'
|
||||
# - Troubleshooting: 'qodo-merge-cli/troubleshooting.md'
|
||||
- Blackbox Merge CLI:
|
||||
- Overview: 'Blackbox-merge-cli/index.md'
|
||||
- Installation: 'Blackbox-merge-cli/installation.md'
|
||||
- Usage: 'Blackbox-merge-cli/usage.md'
|
||||
#- Features & Usage: 'Blackbox-merge-cli/features.md'
|
||||
# - Troubleshooting: 'Blackbox-merge-cli/troubleshooting.md'
|
||||
- PR Benchmark:
|
||||
- PR Benchmark: 'pr_benchmark/index.md'
|
||||
- Recent Updates:
|
||||
|
|
@ -174,4 +174,4 @@ markdown_extensions:
|
|||
|
||||
|
||||
copyright: |
|
||||
© 2025 <a href="https://www.codium.ai/" target="_blank" rel="noopener">QodoAI</a>
|
||||
© 2025 <a href="https://www.codium.ai/" target="_blank" rel="noopener">BlackboxAI</a>
|
||||
|
|
|
|||
|
|
@ -82,11 +82,11 @@
|
|||
|
||||
<footer class="wrapper">
|
||||
<div class="container">
|
||||
<p class="footer-text">© 2025 <a href="https://www.qodo.ai/" target="_blank" rel="noopener">Qodo</a></p>
|
||||
<p class="footer-text">© 2025 <a href="https://www.Blackbox.ai/" target="_blank" rel="noopener">Blackbox</a></p>
|
||||
<div class="footer-links">
|
||||
<a href="https://qodo-gen-docs.qodo.ai/">Qodo Gen</a>
|
||||
<a href="https://Blackbox-gen-docs.Blackbox.ai/">Blackbox Gen</a>
|
||||
<p>|</p>
|
||||
<a href="https://qodo-flow-docs.qodo.ai/">AlphaCodium</a>
|
||||
<a href="https://Blackbox-flow-docs.Blackbox.ai/">AlphaCodium</a>
|
||||
</div>
|
||||
<div class="social-icons">
|
||||
<a href="https://github.com/Codium-ai" target="_blank" rel="noopener" title="github.com" class="social-link">
|
||||
|
|
@ -95,16 +95,16 @@
|
|||
<a href="https://discord.com/invite/SgSxuQ65GF" target="_blank" rel="noopener" title="discord.com" class="social-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485.065 485.065 0 0 0 404.081 32.03a1.816 1.816 0 0 0-1.923.91 337.461 337.461 0 0 0-14.9 30.6 447.848 447.848 0 0 0-134.426 0 309.541 309.541 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.689 483.689 0 0 0-119.688 37.107 1.712 1.712 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.016 2.016 0 0 0 .765 1.375 487.666 487.666 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348.2 348.2 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321.173 321.173 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251.047 251.047 0 0 0 9.109-7.137 1.819 1.819 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.812 1.812 0 0 1 1.924.233 234.533 234.533 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.407 301.407 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391.055 391.055 0 0 0 30.014 48.815 1.864 1.864 0 0 0 2.063.7A486.048 486.048 0 0 0 610.7 405.729a1.882 1.882 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541ZM222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241Zm195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241Z"></path></svg>
|
||||
</a>
|
||||
<a href="https://www.youtube.com/@QodoAI" target="_blank" rel="noopener" title="www.youtube.com" class="social-link">
|
||||
<a href="https://www.youtube.com/@BlackboxAI" target="_blank" rel="noopener" title="www.youtube.com" class="social-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"></path></svg>
|
||||
</a>
|
||||
<a href="https://www.linkedin.com/company/qodoai" target="_blank" rel="noopener" title="www.linkedin.com" class="social-link">
|
||||
<a href="https://www.linkedin.com/company/Blackboxai" target="_blank" rel="noopener" title="www.linkedin.com" class="social-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"></path></svg>
|
||||
</a>
|
||||
<a href="https://twitter.com/QodoAI" target="_blank" rel="noopener" title="twitter.com" class="social-link">
|
||||
<a href="https://twitter.com/BlackboxAI" target="_blank" rel="noopener" title="twitter.com" class="social-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg>
|
||||
</a>
|
||||
<a href="https://www.instagram.com/qodo_ai" target="_blank" rel="noopener" title="www.instagram.com" class="social-link">
|
||||
<a href="https://www.instagram.com/Blackbox_ai" target="_blank" rel="noopener" title="www.instagram.com" class="social-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M224.1 141c-63.6 0-114.9 51.3-114.9 114.9s51.3 114.9 114.9 114.9S339 319.5 339 255.9 287.7 141 224.1 141zm0 189.6c-41.1 0-74.7-33.5-74.7-74.7s33.5-74.7 74.7-74.7 74.7 33.5 74.7 74.7-33.6 74.7-74.7 74.7zm146.4-194.3c0 14.9-12 26.8-26.8 26.8-14.9 0-26.8-12-26.8-26.8s12-26.8 26.8-26.8 26.8 12 26.8 26.8zm76.1 27.2c-1.7-35.9-9.9-67.7-36.2-93.9-26.2-26.2-58-34.4-93.9-36.2-37-2.1-147.9-2.1-184.9 0-35.8 1.7-67.6 9.9-93.9 36.1s-34.4 58-36.2 93.9c-2.1 37-2.1 147.9 0 184.9 1.7 35.9 9.9 67.7 36.2 93.9s58 34.4 93.9 36.2c37 2.1 147.9 2.1 184.9 0 35.9-1.7 67.7-9.9 93.9-36.2 26.2-26.2 34.4-58 36.2-93.9 2.1-37 2.1-147.8 0-184.8zM398.8 388c-7.8 19.6-22.9 34.7-42.6 42.6-29.5 11.7-99.5 9-132.1 9s-102.7 2.6-132.1-9c-19.6-7.8-34.7-22.9-42.6-42.6-11.7-29.5-9-99.5-9-132.1s-2.6-102.7 9-132.1c7.8-19.6 22.9-34.7 42.6-42.6 29.5-11.7 99.5-9 132.1-9s102.7-2.6 132.1 9c19.6 7.8 34.7 22.9 42.6 42.6 11.7 29.5 9 99.5 9 132.1s2.7 102.7-9 132.1z"></path></svg>
|
||||
</a>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -173,6 +173,7 @@ MAX_TOKENS = {
|
|||
"mistral/codestral-mamba-latest": 256000,
|
||||
"codestral/codestral-latest": 8191,
|
||||
"codestral/codestral-2405": 8191,
|
||||
"blackboxai/openai/gpt-4.1": 120000,
|
||||
}
|
||||
|
||||
USER_MESSAGE_ONLY_MODELS = [
|
||||
|
|
@ -215,3 +216,5 @@ CLAUDE_EXTENDED_THINKING_MODELS = [
|
|||
STREAMING_REQUIRED_MODELS = [
|
||||
"openai/qwq-plus"
|
||||
]
|
||||
|
||||
MAX_TOKENS["openai/gpt-4.1"] = 128000
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ from pr_agent.log import get_logger
|
|||
import json
|
||||
|
||||
MODEL_RETRIES = 2
|
||||
os.environ["OPENAI_API_BASE"] = "https://api.blackbox.ai"
|
||||
|
||||
|
||||
class LiteLLMAIHandler(BaseAiHandler):
|
||||
|
|
|
|||
4
pr_agent/blackbox_test.py
Normal file
4
pr_agent/blackbox_test.py
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
from pr_agent.config_loader import get_settings
|
||||
settings = get_settings()
|
||||
print("LLM Provider:", settings.LLM_PROVIDER)
|
||||
print("Model:", settings.MODEL)
|
||||
|
|
@ -7,7 +7,7 @@
|
|||
[config]
|
||||
# models
|
||||
model="gpt-5-2025-08-07"
|
||||
fallback_models=["o4-mini"]
|
||||
fallback_models=[]
|
||||
#model_reasoning="o4-mini" # dedicated reasoning model for self-reflection
|
||||
#model_weak="gpt-4o" # optional, a weaker model to use for some easier tasks
|
||||
# CLI
|
||||
|
|
|
|||
|
|
@ -6,13 +6,13 @@ build-backend = "setuptools.build_meta"
|
|||
name = "pr-agent"
|
||||
version = "0.3.1"
|
||||
|
||||
authors = [{ name = "QodoAI", email = "ofir.f@qodo.ai" }]
|
||||
authors = [{ name = "BlackboxAI", email = "ofir.f@Blackbox.ai" }]
|
||||
|
||||
maintainers = [
|
||||
{ name = "Ofir Friedman", email = "ofir.f@qodo.ai" },
|
||||
{ name = "Ofir Friedman", email = "ofir.f@Blackbox.ai" },
|
||||
]
|
||||
|
||||
description = "QodoAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions."
|
||||
description = "BlackboxAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12"
|
||||
keywords = ["AI", "Agents", "Pull Request", "Automation", "Code Review"]
|
||||
|
|
@ -29,8 +29,8 @@ dynamic = ["dependencies"]
|
|||
dependencies = { file = ["requirements.txt"] }
|
||||
|
||||
[project.urls]
|
||||
"Homepage" = "https://github.com/qodo-ai/pr-agent"
|
||||
"Documentation" = "https://qodo-merge-docs.qodo.ai/"
|
||||
"Homepage" = "https://github.com/Blackbox-ai/pr-agent"
|
||||
"Documentation" = "https://Blackbox-merge-docs.Blackbox.ai/"
|
||||
|
||||
[tool.setuptools]
|
||||
include-package-data = true
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ class TestConvertToMarkdown:
|
|||
]
|
||||
}}
|
||||
mock_git_provider = Mock()
|
||||
reference_link = 'https://github.com/qodo/pr-agent/pull/1/files#diff-hashvalue-R174'
|
||||
reference_link = 'https://github.com/Blackbox/pr-agent/pull/1/files#diff-hashvalue-R174'
|
||||
mock_git_provider.get_line_link.return_value = reference_link
|
||||
|
||||
expected_output = textwrap.dedent(f"""\
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@
|
|||
# Test fetch_sub_issues() to ensure an empty set is returned for an issue with no sub-issues.
|
||||
# """
|
||||
# github_provider = GithubProvider()
|
||||
# issue_url = "https://github.com/qodo-ai/pr-agent/issues/1499" # Likely non-existent issue
|
||||
# issue_url = "https://github.com/Blackbox-ai/pr-agent/issues/1499" # Likely non-existent issue
|
||||
# result = github_provider.fetch_sub_issues(issue_url)
|
||||
#
|
||||
# print("Fetched sub-issues for non-existent issue:", result)
|
||||
|
|
|
|||
Loading…
Reference in a new issue