Skip to main content

Using Augment Code Review natively inside of GitHub

Augment Code Review helps professional software teams complete code-reviews faster inside GitHub while also catching more critical bugs before they hit production. Backed by Augment’s industry-leading Context Engine, the agent understands your codebase at a deep level, providing reviews that are more meaningful and account for codebase-wide effects. Augment prioritizes high signal-to-noise ratio by focusing on high-impact issues like bugs, security concerns, correctness, and cross-system problems while avoiding low-value style nags.
Augment Code Review relies on the Augment GitHub App which is only compatible with GitHub Enterprise Cloud and github.com. GitHub Enterprise Server is not currently supported.

About the installation process

Visit app.augmentcode.com/settings/code-review and log in. Augment Code Review is only available as an add-on to Enterprise plan customers. Settings are accessible to all members of the Enterprise plan, but only configurable for Administrators of the Enterprise plan. If you aren’t sure if you are an Administrator, please contact your solutions team.

Configure Repo Access inside of the Augment GitHub App

Before you can configure repositories, click on “Connect GitHub” to install the Augment GitHub App. This will redirect you to GitHub to provide permissions for all the repos you grant Augment Code Review to engage. Code Review Settings Configure button If your firewall configuration, allowlist or network policy requires a static IP for this integration, please refer to our static IP address documentation.
To install the Augment GitHub App, you will need to be an Administrator of your GitHub organization. To find who the Administrators are, visit your GitHub organization settings page and click on “People.” Administrators are listed under “Owners.”GitHub Admins
Once you finish installing the GitHub app, you should see a green checkmark with the text “All set!”. Then, back in the Augment Code Review Settings, should now show a green “Installed” badge. If you do not see either of these, you may need to uninstall the app through GitHub and reinstall it. See Troubleshooting for more help. GitHub App Installed

Permissions requested by the Augment GitHub App:

  • Contents, read-only: Clone repositories
  • Pull Requests, read and write: Read pull requests and post comments to pull requests
  • Issues, read-only: Read top-level PRs / Issues
  • Organization Members, read-only: Read members of an organization, to distinguish internal and external users and their access levels to Augment features
Organization owners and repository admins can install the app directly; others will need owner approval. See GitHub documentation for details. If your organization uses Augment for Slack, the same selections will apply to both Augment for Slack and Augment Code Review. Installing the GitHub app on a single repository You can modify repository access anytime in the Augment GitHub App settings.

Configuring Triggers Per Repository

As the Administrator, you control when Augment Code Review triggers via Settings. Look for “Set Review Trigger” to the right of the repository name.
  • Automatic: Augment Code Review will automatically review and post a comment as soon as the PR is opened for review in GitHub. Use it when your teams want immediate feedback on all pull requests.
  • Manual Command: Augment Code Review is only triggered when someone comments on the PR with any of the following: auggie review, augment review, or augmentcode review on GitHub. Use it when you want full control over when a review happens.
  • Disabled: Augment Code Review will not run on the repository.
Trigger Types If the repo is set to “Automatic” or “Manual Command”, to run additional rounds of reviews on a subsequent commit of any PR, you can use the same manual trigger keywords (auggie review, augment review, or augmentcode review). On public repositories, reviews are only triggered for PRs whose authors are members of the GitHub organization, outside collaborators to the organization or repository, or contributors to that repository.

Next Steps

Now that you’ve completed the basic setup, explore these additional features to get the most out of Augment Code Review:

Need Help?

If you encounter any issues during setup, check out our Troubleshooting guide.