> ## Documentation Index
> Fetch the complete documentation index at: https://www.greptile.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 5-Minute Quickstart

> Set up Greptile AI code reviews in 5 minutes. Connect GitHub or GitLab, configure review triggers, and get automated feedback on your first pull request.

This guide covers GitHub/GitLab setup, repository configuration, and your first automated code review.

## Installation & Setup

GitHub or GitLab users can follow the outlined steps to successfully enable Greptile within their repositories.

[Log in](https://app.greptile.com/login) to your Greptile account or [sign up](https://app.greptile.com/signup) via email, Google, Github, or GitLab.

Ensure you have the required permissions to allow the AI code reviewer access to all or specific repos. Each platform offers a different procedure for integration.

### GitHub App installation

The GitHub app gives Greptile access to your repositories and lets it post reviews on pull requests.

<Steps>
  <Step title="Open Code Providers">
    Go to **Code Providers**. Click <kbd>Connect GitHub Cloud</kbd> or <kbd>Add Provider</kbd>, then select GitHub.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/code-providers.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=a2063769204adea7e190186ec1ed41b8" alt="GitHub installation page listing accounts and organizations for Greptile Apps" width="2280" height="1408" data-path="images/code-providers.png" />

      <figcaption>Open the Greptile Apps installer in GitHub</figcaption>
    </Frame>
  </Step>

  <Step title="Choose a GitHub account or organization">
    In GitHub, choose the account or organization where you want to install **Greptile Apps**. Use **Configure** for an existing installation.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/github-install-account-selection.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=40fbd37eb1be3104f34817f0ac1933dc" alt="GitHub Greptile Apps install page with account and organization options" width="2270" height="1614" data-path="images/github-install-account-selection.png" />

      <figcaption>Choose a GitHub account or organization</figcaption>
    </Frame>
  </Step>

  <Step title="Grant repository access">
    Select which repositories GitHub lets Greptile access:

    * **All repositories**: Grant access to all current and future repositories in the account or organization.
    * **Only select repositories**: Grant access only to selected repositories. Select at least one repository.

    Click <kbd>Install</kbd> or <kbd>Update access</kbd>.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/github-install-repository-access.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=f2f557a8580e72d2b4fd5c3ebf23a3ba" alt="GitHub App install page with repository access and permissions" width="1950" height="1816" data-path="images/github-install-repository-access.png" />

      <figcaption>Install Greptile Apps in GitHub</figcaption>
    </Frame>
  </Step>

  <Step title="Link the GitHub organization in Greptile">
    After you click <kbd>Install</kbd>, GitHub automatically returns you to Greptile. Select the GitHub organization, then click <kbd>Link</kbd>.

    You can add more organizations later from **Code Providers**.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/github-link-organization.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=c4024d33e9505cec64f6e2da5246e625" alt="Greptile onboarding screen for selecting a GitHub organization to link" width="2758" height="1698" data-path="images/github-link-organization.png" />

      <figcaption>Link a GitHub organization to Greptile</figcaption>
    </Frame>

    <Tip>
      If your GitHub organization is missing from this list, see [Troubleshooting: GitHub organization not listed](/troubleshooting/common-issues#github-organization-not-listed).
    </Tip>
  </Step>

  <Step title="Enable repositories for review">
    Select the repositories you want Greptile to review, then click <kbd>Enable</kbd>.

    Use <kbd>Enable All</kbd> to turn on all repositories that GitHub granted access to.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/github-enable-repositories.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=a47dd73e151fd66665be85375db8a2c0" alt="Greptile onboarding screen for enabling GitHub repositories for review" width="2758" height="1698" data-path="images/github-enable-repositories.png" />

      <figcaption>Enable GitHub repositories for review</figcaption>
    </Frame>
  </Step>
</Steps>

### GitLab Integration

The GitLab integration uses a project or group access token. The token must use the **Developer** role and the `api` scope.

<Steps>
  <Step title="Open GitLab integration">
    Go to **Code Providers** in Greptile and click **Add Provider**, then select GitLab. Greptile shows the token requirements and a field for the generated token.

    <Frame>
      <img src="https://mintcdn.com/greptile/KNJdf4DwzT1-8n6L/images/gitlab-integration-token-modal.png?fit=max&auto=format&n=KNJdf4DwzT1-8n6L&q=85&s=10886a71b2a2ad140d66f4601e937e9d" alt="Greptile modal with GitLab integration token instructions" width="2418" height="1610" data-path="images/gitlab-integration-token-modal.png" />

      <figcaption>Add GitLab integration in Greptile</figcaption>
    </Frame>
  </Step>

  <Step title="Open access tokens in GitLab">
    In GitLab, open your project or group, then go to **Settings** → **Access tokens**.

    <Frame>
      <img src="https://mintcdn.com/greptile/KNJdf4DwzT1-8n6L/images/gitlab-project-access-tokens.png?fit=max&auto=format&n=KNJdf4DwzT1-8n6L&q=85&s=7ff4f7a74b7f017d1b56d938d63602c4" alt="GitLab project access tokens page with Add new token button" width="2748" height="1942" data-path="images/gitlab-project-access-tokens.png" />

      <figcaption>Open GitLab access tokens</figcaption>
    </Frame>
  </Step>

  <Step title="Create the access token">
    Create a token with:

    * **Token name**: `Greptile`
    * **Role**: `Developer`
    * **Scope**: `api`
    * **Expiration date**: the latest allowed date

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/gitlab-create-access-token.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=aaa75355f3efd1b9a41ccc8d2a1648c9" alt="GitLab project access token form with Developer role and api scope selected" width="2748" height="1942" data-path="images/gitlab-create-access-token.png" />

      <figcaption>Create a GitLab access token</figcaption>
    </Frame>
  </Step>

  <Step title="Copy the generated token">
    Copy the token. GitLab only shows it once.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/gitlab-copy-access-token.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=3fd340e10d636bc6c13829846b73b460" alt="GitLab page showing the newly created project access token" width="2748" height="1942" data-path="images/gitlab-copy-access-token.png" />

      <figcaption>Copy the generated GitLab token</figcaption>
    </Frame>
  </Step>

  <Step title="Submit the token in Greptile">
    Paste the token into the GitLab integration modal, then click <kbd>Submit</kbd>.

    <Frame>
      <img src="https://mintcdn.com/greptile/KNJdf4DwzT1-8n6L/images/gitlab-integration-token-modal.png?fit=max&auto=format&n=KNJdf4DwzT1-8n6L&q=85&s=10886a71b2a2ad140d66f4601e937e9d" alt="Greptile GitLab integration modal with token field and Submit button" width="2418" height="1610" data-path="images/gitlab-integration-token-modal.png" />

      <figcaption>Submit the GitLab token in Greptile</figcaption>
    </Frame>
  </Step>

  <Step title="Configure the GitLab webhook">
    Greptile shows the webhook URL, secret token, and required triggers after you submit the token.

    <Frame>
      <img src="https://mintcdn.com/greptile/n1DJD5Cq07WZmn2N/images/greptile-gitlab-details-for-webhook.png?fit=max&auto=format&n=n1DJD5Cq07WZmn2N&q=85&s=13c4e5cb641dc44e5553d11678d97409" alt="Greptile GitLab webhook configuration details with URL, secret token, and required triggers" width="1336" height="331" data-path="images/greptile-gitlab-details-for-webhook.png" />

      <figcaption>GitLab webhook configuration details</figcaption>
    </Frame>

    In GitLab, open your project or group, then go to **Settings** → **Webhooks**. Add a webhook with:

    * **URL**: `https://talon.greptile.com/webhook`
    * **Secret token**: copy from Greptile
    * **Triggers**: Comments, Issues events, Merge request events, Emoji events

    Click <kbd>Add webhook</kbd>, then return to Greptile and click <kbd>Done, I have made the changes</kbd>.
  </Step>

  <Step title="Link the GitLab group">
    Select the GitLab group, then click <kbd>Link</kbd>.

    <Frame>
      <img src="https://mintcdn.com/greptile/KNJdf4DwzT1-8n6L/images/gitlab-link-group.png?fit=max&auto=format&n=KNJdf4DwzT1-8n6L&q=85&s=bd70cb8eb84c8d03e890a1a194480cba" alt="Greptile onboarding screen for selecting a GitLab group to link" width="2450" height="1552" data-path="images/gitlab-link-group.png" />

      <figcaption>Link a GitLab group to Greptile</figcaption>
    </Frame>
  </Step>

  <Step title="Enable repositories for review">
    Select the GitLab repositories you want Greptile to review, then click <kbd>Enable</kbd>.

    Use <kbd>Enable All</kbd> to turn on every listed repository.

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/gitlab-enable-repositories.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=400835f09108912e80b2e630b89ce5fa" alt="Greptile onboarding screen for enabling GitLab repositories for review" width="2456" height="1568" data-path="images/gitlab-enable-repositories.png" />

      <figcaption>Enable GitLab repositories for review</figcaption>
    </Frame>
  </Step>
</Steps>

### Repository Selection & Configuration

The following configuration steps are common to GitHub and GitLab:

<Steps>
  <Step title="Enable repository indexing by Greptile">
    1. Go to your team's **Repositories** page
    2. Click **Manage Repos** (or **Enable Repositories** if no repos are enabled yet)
    3. Select the repos you want reviewed, then click **Enable Repos** (or use **Enable All**)

    To automatically enable future repos, go to **Code Review Settings** and toggle **Auto-enable New Repos**.

    <Frame>
      <img src="https://mintcdn.com/greptile/KNJdf4DwzT1-8n6L/images/repositories-manage-repos-modal.png?fit=max&auto=format&n=KNJdf4DwzT1-8n6L&q=85&s=43468002417a3e1c4164037aab2eb01e" alt="Repo Settings modal for enabling and disabling repositories" width="2192" height="1338" data-path="images/repositories-manage-repos-modal.png" />

      <figcaption>Enable or disable repositories</figcaption>
    </Frame>
  </Step>

  <Step title="Configure PR Summary">
    Customize how Greptile summarizes pull requests:

    * **PR Summary**: Include a text summary of the changes
    * **Confidence Score**: Show confidence levels for each PR
    * **Issue Table**: Show important changed files with ratings
    * **Sequence Diagram**: Add a diagram of the changes

    [Learn more about PR summaries →](/code-review/first-pr-review#pr-summary)

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/code-review-pr-summary-settings.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=54f606f30ef8e5f3dcf59144700bdb50" alt="PR Summary settings in Code Review Settings" width="3164" height="2062" data-path="images/code-review-pr-summary-settings.png" />

      <figcaption>PR summary settings</figcaption>
    </Frame>
  </Step>

  <Step title="Control Review Behavior">
    Configure what Greptile comments on in **Code Review Settings**:

    * **Strictness Level**: Adjust how often Greptile comments
    * **Auto-review on new commits**: Review new commits after a PR is opened
    * **Review draft pull requests**: Review drafts before they are marked ready
    * **File change limit**: Set the largest PR Greptile reviews automatically

    [Learn more about controlling nitpickiness →](/code-review/controlling-nitpickiness)

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/code-review-review-trigger-settings.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=e0cbacc4fd717b2e4d3fc5bdf1347637" alt="When Greptile Reviews settings with strictness level and review trigger options" width="3164" height="2062" data-path="images/code-review-review-trigger-settings.png" />

      <figcaption>When Greptile reviews</figcaption>
    </Frame>
  </Step>

  <Step title="Add Filters">
    Set when Greptile comments in **Code Review Settings** under **Greptile Comments**:

    * **Labels**: Only review PRs with specific labels (e.g., "needs-review")
    * **Authors**: Include/exclude specific developers or bots
    * **Branches**: Target specific branches (e.g., main, develop)
    * **Keywords**: Trigger on PR title/description keywords

    [Learn more about triggers →](/code-review/controlling-nitpickiness#trigger-configuration)

    <Frame>
      <img src="https://mintcdn.com/greptile/8PzYIxBdzrtuAyXk/images/code-review-add-filter.png?fit=max&auto=format&n=8PzYIxBdzrtuAyXk&q=85&s=0410aaf1001eb792ba3e52a18c131ad3" alt="Greptile Comments filter settings with Add Filter button" width="3154" height="1046" data-path="images/code-review-add-filter.png" />

      <figcaption>Add review filters</figcaption>
    </Frame>
  </Step>
</Steps>

After a repository has been indexed (typically 1-2 hours for very large repos), any new pull/merge request will initiate automated code reviews by Greptile.

***

## Create Your First Test PR

Try Greptile on a test pull request to see it in action:

<Steps>
  <Step title="Create a pull request">
    Make a test PR to your indexed repo with some code changes.
  </Step>

  <Step title="Wait for review (~3 minutes)">
    Greptile analyzes your PR with full codebase context and posts a comprehensive review.

    <Frame>
      <img src="https://mintcdn.com/greptile/pPDrEYn7_-Bi_2Mg/images/greptile-pr-comment.png?fit=max&auto=format&n=pPDrEYn7_-Bi_2Mg&q=85&s=b8e0b17c33779d085e4952c302952b43" alt="PR Summary" width="931" height="827" data-path="images/greptile-pr-comment.png" />

      <figcaption>Greptile PR Comment</figcaption>
    </Frame>
  </Step>

  <Step title="Review the feedback">
    You'll see a summary of changes, inline comments on issues, and suggested fixes.

    <Frame>
      <img src="https://mintcdn.com/greptile/sJeefWhR1h6iqsSa/images/pr-summary.png?fit=max&auto=format&n=sJeefWhR1h6iqsSa&q=85&s=6464ca32169feabc1024e9bebd94d643" alt="pr summary" width="914" height="486" data-path="images/pr-summary.png" />

      <figcaption>PR Summary</figcaption>
    </Frame>
  </Step>
</Steps>

When issues are spotted, Greptile suggests potential code fixes:

<Frame>
  <img src="https://mintcdn.com/greptile/sJeefWhR1h6iqsSa/images/issue-fixes.png?fit=max&auto=format&n=sJeefWhR1h6iqsSa&q=85&s=0a0084ab113ad1bb8c39c767c548b44e" alt="code fixes" width="865" height="287" data-path="images/issue-fixes.png" />

  <figcaption>Suggest code fixes</figcaption>
</Frame>

<Note>
  You can trigger a code review manually by tagging **@greptileai** with a comment. This is helpful for reviewing older PRs from before Greptile was integrated.
</Note>

<Tip>
  If Greptile is enabled but does not run on a GitLab merge request, check the GitLab webhook. See [GitLab merge request not reviewed](/troubleshooting/common-issues#gitlab-merge-request-not-reviewed).
</Tip>

***

## What's next?

* **For developers**: Learn how to [work with Greptile reviews →](/code-review/developer-essentials)
* **For team admins**: Set up [organizations and teams →](/code-review/team-setup-basics)
* **Deep dive**: Understand the [anatomy of a review →](/code-review/first-pr-review)
