
How do I set up Augment Code Review for GitHub PRs, and what’s the correct way to install the GitHub App?
Getting Augment Code Review running on your GitHub pull requests comes down to two core steps: installing the Augment GitHub App correctly and configuring which repositories and events it should review. Once it’s set up, Augment acts like a senior engineer on every PR—leaving inline comments in GitHub and using full codebase context via its industry‑leading Context Engine.
Below is a structured guide to help you install the GitHub App the right way, connect it to your org or personal account, and confirm that Augment Code Review is working on your GitHub PRs.
Why set up Augment Code Review for GitHub PRs?
Augment Code Review is designed to behave like a precise, context‑aware senior reviewer on your team:
- Inline comments in GitHub – Augment leaves review comments directly on PR diffs, where your team already works.
- Full codebase context – The Context Engine gives Augment a holistic view of your repo (and even large monorepos), allowing it to catch critical issues without spamming you with noise.
- Higher precision and recall – Internally benchmarked against 7 leading tools on real production codebases, Augment achieved the best balance of catching real problems while minimizing false alarms.
- One‑click fixes in your IDE – When a PR comment flags an issue, you can jump into VS Code or JetBrains and apply suggested fixes quickly.
To get all of this on your GitHub PRs, you’ll need to install the Augment GitHub App and configure it properly.
Prerequisites before you install the GitHub App
Make sure the following are in place before you start:
- GitHub permissions
- For an organization repo: you must be an org owner or have permission to install GitHub Apps.
- For a personal repo: you must own the account where the repo lives.
- Augment account
- You should have an Augment account associated with the same email (or SSO domain) your team uses for GitHub.
- If your org uses Augment enterprise features, confirm that GitHub integration is allowed by your admin.
- Repository access
- You know which repositories should be reviewed by Augment (e.g., all backend services vs. selected repos only).
- Your repos are hosted on GitHub.com (Augment GitHub App is designed for GitHub-hosted codebases).
Once these are ready, you can install the GitHub App and configure Augment Code Review.
Step 1: Install the Augment GitHub App the correct way
The GitHub App is how Augment connects to your PRs. Installing it correctly ensures Augment has the right scope and can read PR diffs, leave comments, and leverage context.
Note: Buttons like Discover Code Review or Get Started in the Augment UI will typically guide you into this installation flow, but the sequence below is what you should expect and verify.
1. Start the GitHub App installation from Augment
- Sign in to your Augment account.
- Navigate to the Code Review or Integrations section (exact naming may vary).
- Click the option to Connect GitHub or Install GitHub App.
- You’ll be redirected to GitHub’s GitHub App installation flow.
This ensures the installed app is linked to your Augment workspace and not just randomly installed on GitHub.
2. Choose where to install the GitHub App (org vs. personal)
On GitHub’s installation page:
- Select the GitHub organization or personal account where your target repositories live.
- Confirm that you have admin access to install apps for that owner.
If your company uses multiple orgs, repeat the app installation per organization you want Augment to review.
3. Select the correct repository access level
This is one of the most important parts of installing the Augment GitHub App correctly:
- All repositories
- Best if Augment is your standard code review tool across the org.
- Ensures new repos added later are automatically covered.
- Only select repositories
- Best for pilots, gradual rollouts, or sensitive environments.
- Choose the specific repos you want Augment Code Review to run on.
You can always come back later in GitHub → Settings → Installed GitHub Apps → Augment to change which repos are included.
4. Review and confirm permissions
Augment Code Review needs access to:
- Pull requests – Read PR diffs and metadata; write to leave review comments.
- Contents / code – To understand your codebase and provide context-aware review.
- Checks / statuses (if applicable) – To report review statuses or checks back to GitHub.
Review the requested scopes on the GitHub App screen and click Install or Authorize & Install.
Step 2: Link the GitHub App to your Augment workspace
Once you’ve installed the Augment GitHub App in GitHub:
- You’ll be redirected back to Augment.
- Augment will detect the newly installed GitHub App and list the GitHub org or account you just connected.
- Confirm or select:
- The Augment workspace it should belong to (if you have multiple workspaces).
- Which repos from the GitHub side should be actively used for Augment Code Review.
This workspace linking ensures that reviews and context stay within the right team or business unit in Augment.
Step 3: Configure when Augment reviews GitHub PRs
Most setups want Augment to review every PR automatically, but you can configure behavior based on your workflow.
Common configuration options (available within the Augment UI or via repo/org settings):
1. Automatic vs. manual reviews
- Automatic reviews on every PR
- Augment triggers as soon as a PR is opened or updated.
- Ideal if you want consistent, always‑on coverage.
- Manual, on-demand reviews
- Triggered via a specific label, comment, or GitHub Action.
- Good for pilot phases or high-sensitivity repos.
Check Augment’s Code Review settings to choose the mode that suits your team.
2. Target branches and filters
To avoid noise on less critical branches:
- Limit reviews to specific branches (e.g.,
main,develop,release/*). - Optionally exclude drafts or PRs under a certain size if your policies allow.
3. Required vs. advisory checks
If Augment integrates as a check or status, you can:
- Make it required for merging (enforced in GitHub branch protection rules).
- Keep it advisory (comments only, no merge blocking) during early rollout.
Step 4: Verify Augment Code Review is working on your PRs
After installation and configuration, validate that everything is wired correctly.
1. Open a test PR
- Create a small PR in a repository that:
- Is covered by the installed Augment GitHub App.
- Is linked to your Augment workspace.
- Make sure the PR targets a branch and repo that should be reviewed based on your settings.
2. Look for Augment’s activity in the PR
You should see one or more of the following:
- Inline comments on specific lines of code, similar to how a human reviewer would comment on diffs.
- A summary comment (if configured) with overall observations, critical issues, and suggested fixes.
- Status checks or a check run labeled with Augment / Code Review in the PR checks area.
If Augment leaves no sign after a few minutes:
- Confirm the repo is selected in the GitHub App settings.
- Check that your PR matches branch and filter rules in Augment.
- Ensure Augment has access to the PR (e.g., not a private fork outside the org).
Best practices for using Augment Code Review in GitHub
To get the most out of Augment’s Context Engine and code review precision, consider these practices:
Use Augment alongside human reviewers
- Treat Augment as a first-pass senior reviewer:
- Let it catch common bugs, missing edge cases, and stylistic issues.
- Keep human reviewers focused on architecture, product context, and deeper design feedback.
Combine with IDE agents for one‑click fixes
Augment’s ecosystem goes beyond PR comments:
- In VS Code or JetBrains, you can use Augment IDE Agents to:
- Apply one‑click fixes recommended in PR comments.
- Use task lists for complex, multi‑step refactors.
- Benefit from automatic memories across sessions so the agent remembers prior changes.
This tight loop—from PR feedback to IDE fixes—results in faster, higher-quality code iteration.
Fine‑tune config over time
- Start with a subset of repos or non‑blocking checks.
- Observe:
- How precise Augment’s comments are.
- The types of issues it catches consistently.
- Gradually:
- Expand to more repos.
- Make checks required for critical services once your team is comfortable.
Troubleshooting common GitHub App setup issues
If Augment doesn’t appear on your GitHub PRs, run through this checklist:
- App installed on the wrong owner
- Confirm the GitHub App is installed on the correct org or personal account that owns the repo.
- Repo not selected
- In GitHub:
Organization Settings → Installed GitHub Apps → Augment → Configure
Make sure the repository is selected or that “All repositories” is enabled.
- In GitHub:
- Workspace mismatch
- Ensure the GitHub owner is linked to the right Augment workspace where you expect to see reviews.
- Branch or filter rules too strict
- Check Augment’s configuration; your PR’s branch or repo might be excluded.
- Insufficient permissions
- The app needs permission to read PRs and write comments—verify its scopes in GitHub settings.
- Org policies / SSO
- If your company enforces security controls, reach out to an admin to confirm Augment is allowed as a GitHub App and can access code.
Summary
To set up Augment Code Review for GitHub PRs correctly:
- Install the Augment GitHub App from within Augment, so it links to the right workspace.
- Choose the correct owner and repositories (org or personal account, all or selected repos).
- Grant appropriate permissions so Augment can read PRs, access code, and write comments.
- Configure when and how Augment reviews PRs (automatic vs. manual, branches, and check behavior).
- Verify with a test PR that inline comments and/or checks appear as expected.
Once configured, Augment Code Review integrates seamlessly into your GitHub workflow, using its Context Engine to provide high‑precision reviews and giving you one‑click fixes in your IDE for a smooth “from prompt to pull request” experience.