Code Review Bot
Greptile reviews your pull/merge requests with codebase context-aware comments
Greptile’s code review bot does two things:
-
summarizes the changes in the pull/merge request
-
comments on specific file changes suggests potential issues and unforeseen consequences of the change.
Why is it useful?
Greptile’s code review bot writes comments that:
- Are context-aware, so can discuss the implications of the changes to the wider codebase.
- Can address potential security or compliance issues produced by the changes.
- Summarize the changes with codebase context, making it far easier for a human reviewer to contextualize and parse the changes.
- Reference similar code or abstractions related to the changes that are already in the codebase, to prevent repitition.
This means less time spent reviewing PRs or awaiting review, and more time spent writing code.
Click here to see a sample PR review on twentyhq/twenty
! ->
Example PR diff comment ->
![](https://mintlify.s3-us-west-1.amazonaws.com/greptile/images/cr.png)
Installation
Click here to install the PR Review bot. Once you have installed the bot, you can use the same link to configure the bot.
To install the bot, follow these steps.
- Create an account at Greptile.com and navigate to the Integrations page. (Or Click on “Setup Code Review Bot”).
![](https://mintlify.s3-us-west-1.amazonaws.com/greptile/images/bt-bot-setup-1.png)
- On the Integration/Apps page in the Enable Integrations section click on “Get Started” to add your payment information for API charges. If you run a OSS community you can get access to this product for free by applying here.
![](https://mintlify.s3-us-west-1.amazonaws.com/greptile/images/bt-bot-setup-2.png)
- Select the GitHub or GitLab extension.
![](https://mintlify.s3-us-west-1.amazonaws.com/greptile/images/bt-bot-setup-3.png)
- In the final two steps, you’ll be asked in which account and in which repository you’d like to install the bot.
![](https://mintlify.s3-us-west-1.amazonaws.com/greptile/images/bt-bot-setup-4.png)
![](https://mintlify.s3-us-west-1.amazonaws.com/greptile/images/bt-bot-setup-5.png)
Configuration
Configuration options include:
- Setting up triggers, for example
@mentions
, or certain filters like workspace, project, team, or label. - Setting target repositories for the bot to review PRs for.
- Providing “special instructions” for the bot to follow, for example, “Include a section on compliance implications of the changes in the PR.”
- Selecting certain criterion for the bot to evaluate each diff on, for example syntax issues, or style guide violations.
Greptile can be configured to trigger a review:
- For all PRs
- For PRs in certain workspaces, projects, teams, or with certainlabels
- For PRs that mention
@greptileai
in the body - Every time a new commit is made on a PR branch
Click here to install the PR bot.