Closed ajitesh123 closed 2 months ago
/help
Here are the available commands you can use:
@archieai help
(or /help
) - Show this help message@archieai ask [question]
(or /ask
) - Ask a question about the PR@archieai describe
(or /describe
) - Generate a description of the PR@archieai walkthrough
(or /walkthrough
) - Generate an interactive walkthrough of the PR changes@archieai complete-review
(or /complete-review
) Generate a complete review of the pull request@archieai incremental_review
(or /incremental-review
) - Generate an incremental review of new changes since the last review@archieai find-similar-issue
(or /find-similar-issue
) - Find and display issues similar to the current PR [Experimental]@archieai turbo-review
(or /turbo-review
) - Perform a Turbo Review, an advanced and fully-agentic PR review that includes parallel analysis multitudes of factors [Experimental]You can use either the @archieai
prefix or the shorter /
prefix for each command. For example, both @archieai ask
and /ask
will work.
Additionally, in review comments on specific lines of code:
@archieai code
(or /code
) - Start a review comment with this to get a code suggestion that can be committed directlyPR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.
Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more.
Here is a list of tools you can use to interact with the PR Agent:
Tool | Description | Trigger Interactively :gem: |
---|---|---|
[DESCRIBE](https://pr-agent-docs.codium.ai/tools/describe/) | Generates PR description - title, type, summary, code walkthrough and labels | - [ ] Run |
[REVIEW](https://pr-agent-docs.codium.ai/tools/review/) | Adjustable feedback about the PR, possible issues, security concerns, review effort and more | - [ ] Run |
[IMPROVE](https://pr-agent-docs.codium.ai/tools/improve/) | Code suggestions for improving the PR | - [ ] Run |
[UPDATE CHANGELOG](https://pr-agent-docs.codium.ai/tools/update_changelog/) | Automatically updates the changelog | - [ ] Run |
[ADD DOCS](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | Generates documentation to methods/functions/classes that changed in the PR | - [ ] Run |
[TEST](https://pr-agent-docs.codium.ai/tools/test/) 💎 | Generates unit tests for a specific component, based on the PR code change | - [ ] Run |
[IMPROVE COMPONENT](https://pr-agent-docs.codium.ai/tools/improve_component/) 💎 | Code suggestions for a specific component that changed in the PR | - [ ] Run |
[ANALYZE](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component | - [ ] Run |
[ASK](https://pr-agent-docs.codium.ai/tools/ask/) | Answering free-text questions about the PR | [*] |
[GENERATE CUSTOM LABELS](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | Generates custom labels for the PR, based on specific guidelines defined by the user | [*] |
[CI FEEDBACK](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | Generates feedback and analysis for a failed CI job | [*] |
[CUSTOM PROMPT](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | Generates custom suggestions for improving the PR code, derived only from a specific guidelines prompt defined by the user | [*] |
[SIMILAR ISSUE](https://pr-agent-docs.codium.ai/tools/similar_issues/) | Automatically retrieves and presents similar issues | [*] |
(1) Note that each tool be triggered automatically when a new PR is opened, or called manually by commenting on a PR.
(2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the /ask
tool, you need to comment on a PR: /ask "<question content>"
. See the relevant documentation for each tool for more details.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share
- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)Tips
### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit