Skip to main content

​
About Augment Code Review

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.

​
Getting Started

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 “Install” 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 install 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, the “Install” button 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:
  • 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.

​
Change the GitHub Organization using Augment Code Review

Today, Code Review is limited to one GitHub organization per Enterprise account. Augment will address this limitation in an upcoming release. You can change the organization by reinstalling the Augment GitHub App.
  • To get started you need to review the GitHub Apps installed on an organization:
    • In the top right corner of GitHub, click your profile picture, then click Your organizations.
    • Next to your organization name, click Settings.
    • In the side bar, under “Third-party Access,” click GitHub Apps. A list of the GitHub Apps installed on your organization will be displayed.
    • Next to the GitHub App you want to review or modify, click Configure.
  • To uninstall the Augment GitHub App, click Uninstall.
  • To reinstall, visit: https://github.com/apps/augmentcode/installations/new. Select your organization.

​
Providing feedback

You can provide in product feedback directly in GitHub by reacting with a thumbs up or thumbs down emoji to the inline comment left by Augment Code Review. Code Review Feedback using GitHub Reactions

​
Tell Augment Code Review to check specific areas with guidelines

Domain knowledge that isn’t always evident in the code. Tell Augment Code Review to check specific areas like security vulnerabilities or inside particular directories when relevant. Augment Code Review allows you to outline these special guidelines per repository. Describe any areas of focus using a yaml file entitled code_review_guidelines.yaml inside the .augment folder at the repository root: <repo-root>/.augment/code_review_guidelines.yaml Scope guidelines to the appropriate sub-directories and focus on objective issues that can cause bugs, expose vulnerabilities, etc. and less on stylistic or subjective things.

​
Example Augment Code Review Guidelines

# Guidelines exclusive to augmentcode/auggie

areas:
  databases:
    description: "Data and Database related rules"
    globs:
      - "**"
    rules:
      - id: "no_pii_in_bigquery"
        description: "Never store PII data in BigQuery tables."
        severity: "high"
      - id: "no_guid_keys"
        description: "GUID foreign keys can slow lookups"
        severity: "medium"

  memory_safety:
    description: "Ensure Memory Safety"
    globs:
      - "kernel/**"
    rules:
      - id: "avoid_unsafe_rust"
        description: "Avoid unsafe Rust operations."
        severity: "high"

​
Explanation of the Guideline Format

Areas: Focus domain. Example: focus is “databases” Area Name: Double quoted string written in snake case (ex: memory_safety)
  • Description: Double quoted message summarizing intent of the area
  • Globs (short for global): Double quoted pattern-matching notation. Used to specify sets of filenames or paths using wildcard characters
Common globs or pattern matching syntax:
  • ** - Matches any number of directories (recursive wildcard)
    • Example: **/test.py matches test.py, src/test.py, src/utils/test.py, etc.
  • * - Matches any sequence of characters within a single directory level
    • Example: *.py matches file.py, main.py but not src/main.py
  • ? - Matches exactly one character
    • Example: test?.py matches test1.py, testA.py but not test10.py
  • Rules: Areas can contain more than one rule. Each rule contains:
    • ID: Double quoted title written in snake case (ex: avoid_unsafe_rust)
    • Description: Double quoted message summarizing intent of the rule
    • Severity: Expects double quoted “high”, “medium” or “low”. Sets the priority of review by Augment Code Review

​
User Access

Administrators can specify a list of GitHub users who can trigger Augment Code Review by turning on Allowlist Mode. When Allowlist Mode is active, only users in the allowlist will be able to trigger Augment Code Review. Automatic and manual reviews will be disabled for all other users. This is useful for organizations that want to limit access to the feature to a select group of users. To manage permissions, visit User Access for Code Review.

​
Model Context Protocol (MCP)

Administrators can connect Augment Code Review to external context sources through Model Context Protocol (MCP). Augment Code Review supports both local and remote MCP servers.
  • Remote MCP servers run remotely and are hosted by providers. Once you add a remote MCP server, you may need to complete an OAuth flow to sign in to the server before it can be used by the code review agent.
  • Local MCP servers run in their own environment within the code review agent’s workspace. You can specify environment variables for local servers by clicking + MCP and then clicking + Environment Variable. Once set, environment variables are write-only and can only be overwritten or removed (not viewed) after the server has been added.
To configure MCP servers, visit MCP for Code Review.

​
Code Review Analytics

Use the Code Review Analytics dashboard to track the review load automated by Augment, along with the comments made by Code Review that developers ultimately addressed.
  1. Navigate to Code Review - In your browser, visit Code Review Analytics.
  2. Filter by Date - Refine your Analytics using the tabs for Last 7 Days, Last 30 Days, or Last 60 Days.

​
Metric Definitions

  • Total PRs Reviewed: The number of PRs that have been reviewed by Augment Code Review.
  • Total Reviews Performed: The number of reviews that have been run by Augment Code Review. One PR can have multiple reviews if people manually trigger more reviews.
  • Total Comments: The total number of inline comments left by Augment Code Review.
  • Percentage of Comments Addressed: A comment is addressed if the developer resolved the concerns raised by the Augment Code Review comment. The percentage is calculated by dividing the number of addressed comments by the total number of comments left by Augment Code Review.
  • Percentage of Thumbs Up Reactions: A thumbs up reaction is counted if a user reacts with the Thumbs Up emoji on GitHub on an inline comment left by Augment Code Review. The percentage is calculated by dividing the number of thumbs up reactions by the total number of thumbs up and thumbs down emoji reactions.
  • Estimated Dev Hours Saved: Number of PRs multiplied by 10 minutes

​
Reading the Charts

  • Addressed Comments: A chart detailing total number of comments per day broken down by unaddressed (gray) vs addressed (green). You can interpret the green bar to mean Augment Code Review caught issues that developers fixed and may not have without the comment.
  • Reviewed PRs: A chart detailing the total number of reviewed PRs per day (blue).

​
Troubleshooting

​
Stuck on Install button

If you still see the “Install” button on the Augment Code Review Settings page, then the Augment GitHub App installation failed. You will need to uninstall the Augment GitHub App from your organization and then reinstall it. Make sure the person installing the GitHub app has an Augment account and they see the “All set!” text after installing the app.
1

Navigate to the Augment GitHub App settings page on GitHub

Follow the steps on GitHub Docs to modify the Augment GitHub App installation.
2

Uninstall the Augment GitHub App from your organization

In the Danger zone section, click on “Uninstall”
3

Reinstall the Augment GitHub App

Follow the steps in Getting Started again to install the app