> ## Documentation Index
> Fetch the complete documentation index at: https://personal-ce79cb71.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started with BugViper in 5 Minutes

> Install the BugViper GitHub App, connect your account, and get your first AI-powered code review on a pull request in under 5 minutes.

BugViper requires no configuration files, no CI changes, and no local tooling. You install the GitHub App, sign in to the dashboard once, and then trigger reviews by commenting on any pull request. This guide walks you through each step from installation to your first inline review comment.

<Steps>
  <Step title="Install the GitHub App">
    Go to the [GitHub Marketplace](https://github.com/marketplace) or click **Install GitHub App** in the BugViper dashboard. Choose the organization or personal account where you want BugViper to run, then select the repositories it can access — either all repositories or specific ones.

    BugViper requires the following permissions to operate:

    | Permission      | Access       |
    | --------------- | ------------ |
    | Contents        | Read         |
    | Issues          | Read & Write |
    | Pull requests   | Read & Write |
    | Metadata        | Read         |
    | Commit comments | Read & Write |
    | GitHub Actions  | Read         |
  </Step>

  <Step title="Sign in to the BugViper dashboard">
    Open the BugViper dashboard and click **Sign in with GitHub**. BugViper uses GitHub OAuth to authenticate you and link your account to the GitHub App installation you just completed.
  </Step>

  <Step title="Complete onboarding — link your GitHub App installation">
    After signing in, BugViper's onboarding flow guides you through linking your GitHub App installation to your dashboard account. If you installed the app before signing in, BugViper will have stored your pending installation and will connect it automatically at this step.
  </Step>

  <Step title="Trigger a review on a pull request">
    Open any pull request in a connected repository and leave a comment:

    ```
    @bugviper full review
    ```

    For a faster static-analysis-only pass, use:

    ```
    @bugviper run lint
    ```

    BugViper will acknowledge the command and begin processing immediately.
  </Step>

  <Step title="Review inline comments and the summary">
    BugViper posts high-confidence findings as inline comments directly on the relevant lines of the diff, then adds a structured summary review to the PR. All issues are also logged to your dashboard with full lifecycle tracking — open, resolved, and fixed — and your analytics are updated automatically.
  </Step>
</Steps>

<Tip>
  Comment `@bugviper help` on any pull request to see the full list of available commands and a brief description of each.
</Tip>

## Next steps

Now that BugViper is running, explore everything you can trigger from a PR comment.

<Card title="Bot Commands" icon="robot" href="/guides/bot-commands">
  See all available @bugviper commands and when to use each one.
</Card>
