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 and log in. Click “Settings.” Augment Code Review is only availble to Enterprise plan customers. Settings are only accessible for Administrators of the Enterprise plan. If you aren’t sure if you are an Administrator, please contact your solutions team. NOTE: Members of the Enterprise plan do not have access to Settings and cannot Configure the Augment Code Review Settings.

​
Configure Repo Access inside of the Augment GitHub App

The first time you visit the Settings page, it will ask you to install the Augment GitHub App and redirect you to GitHub to provide permissions for all the repos you grant Augment Code Review to engage. 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

Install Augment GitHub App

Augment GitHub App

​
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. As the Administrator, you control when Augment Code Review triggers via Settings:
  • Review on PR Opened: Augment Code Review will automatically review and post a comment as soon as the PR is opened in GitHub. Use it when your teams want immediate feedback on all pull requests.
  • Manually triggered: 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.
To run a second round of review on a subsequent commit of any PR (regardless of which trigger type is configured), 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.

​
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

​
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 Augment Code, and then select the “Code Review” tab
  2. Filter by Date - Refine your Analytics using the tabs for Last 7 Days, Last 30 Days, or Last 60 Days.

​
Metric Definitions

  • Total Reviewed PRs: The number of PRs that have been reviewed 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.
  • Estimated Dev Hours Saved: Number of PRs multiplied by 10 minutes

​
Reading the Charts

  • Addressed Comments: A 7-day 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 7-day chart detailing the total number of reviewed PRs per day (blue).

​
Troubleshooting

​
Stuck on “Connect GitHub to Get Started”

If you still see the “Connect GitHub to Get Started” button, then the Augment GitHub App installation failed. You will need to uninstall the Augment GitHub App from your organization and then reinstall it. Once installed, you will see the Augment Code Review Settings. Here you’ll be able to configure the repositories that the Augment GitHub App can access. Return to Settings at anytime to see the list of repositories.
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