Skip to main content

​
Quickstart

1

Create an Augment Account

Visit augmentcode.com and click Sign Up. Complete registration with your email address, verify your email, and accept the terms of service during onboarding.
2

Connect GitHub to Configure your Repos for Code Review

Log in to app.augmentcode.com, navigate to Settings → Code Review → Configuration, and click Connect GitHub. You’ll be redirected to GitHub to authorize the app. Select the repositories you want to grant access to (all repositories or specific repos) and click Install & Authorize.
3

Set Code Review to Automatic or Manual

Return to app.augmentcode.com, Under Configuration, Find the repository you want to enable. Under Set Review Trigger, choose Automatic Review for instant feedback on every PR when marked “ready for review”, or Manual Review to trigger reviews by commenting auggie review on PRs.
4

Submit Your First Review

Create a pull request on GitHub in any enabled repository. For automatic reviews, mark the PR as “ready for review” and Augment will analyze it within minutes. For manual reviews, add a comment with auggie review to trigger the analysis.

​
Context powered code reviews focus on high-impact issues

Augment Code Review prioritizes high signal-to-noise ratio by focusing on high-impact issues:
  • Bugs: Logic errors, edge cases, and potential runtime issues
  • Security concerns: Vulnerabilities, unsafe operations, and data exposure risks
  • Correctness: Null handling and error management
  • Cross-system problems: Breaking changes, API compatibility, and integration issues
The agent avoids low-value style nags and focuses on objective issues by gathering context from multiple sources:
  • PR Contents: The agent analyzes the complete code diff to understand what changed and why.
  • Entire Repository: Through Augment’s Context Engine, the agent has access to your full codebase, enabling it to identify cross-system impacts and maintain consistency with existing patterns.
  • PR Title and Description: More detailed PR descriptions help the agent provide better, more targeted reviews. Include information about:
    • What the PR accomplishes
    • Why the changes were made
    • Any special considerations or context

​
Best Practices

Write detailed PR descriptions: The more context you provide in your PR title and description, the better the agent can understand your intent and provide relevant feedback. Use custom guidelines: Define repository-specific review guidelines to help the agent focus on your team’s priorities and domain-specific concerns. Provide feedback: Give feedback on comments using the thumbs up emoji to indicate whether the comment is useful or thumbs down if the comment was not helpful. Ask for a follow-up review: If you make significant changes to the PR and want another review, then ask for a follow-up review by commenting on your PR with the same comments as a manual request: auggie review, augment review, or augmentcode review. The agent will add 👀 to the comment so you know it is reviewing the PR.