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

# How to connect a GitHub repository

> Install the BattleTest GitHub App to get automated CVE, secret, and AI code review on every pull request, and manage which repositories are connected.

<Note>
  **Free plan:** public repositories only. **Dev plan or higher:** private repositories. [View plans →](https://battletest.dev/pricing)
</Note>

<Note>
  **Signed up with email and password?** Verify your email address before connecting GitHub — the button is disabled until your address is confirmed. Check your inbox for the verification email or resend it from [Settings → Account](https://battletest.dev/settings?tab=account). GitHub OAuth sign-ups are verified automatically.
</Note>

## Install the GitHub App

<Steps>
  <Step title="Open the connect flow">
    Go to [Dashboard → Repositories](https://battletest.dev/dashboard) and click **Connect GitHub**.
  </Step>

  <Step title="Choose account and repositories">
    On the GitHub App installation page, select the account or organisation that owns your repositories. Under **Repository access**, choose **Only select repositories** and tick the repositories you want to connect.
  </Step>

  <Step title="Complete installation">
    Click **Install & Authorize**.

    Repositories appear in the BattleTest Repositories list with a *Connected* status. PR reviews begin immediately on the next pull request event.
  </Step>
</Steps>

## Add or remove repositories from an existing installation

<Steps>
  <Step title="Open repository settings">
    Go to [Dashboard → Repositories](https://battletest.dev/dashboard).
  </Step>

  <Step title="Configure the App">
    Click **Configure GitHub App**.
  </Step>

  <Step title="Update access">
    Under Repository access, add or remove repositories, then click **Save**.
  </Step>
</Steps>

## Connect repositories in a GitHub organisation

To install on an organisation you must have organisation **Owner** permissions, or the organisation must allow members to install Apps. If the install button is greyed out, ask an organisation owner to complete the installation.

To install on all current and future repositories in an organisation, select **All repositories** on the installation page instead of selecting specific repositories.

## Uninstall the GitHub App

Uninstall from GitHub: **Settings → Applications → Installed GitHub Apps → BattleTest Security → Configure → Uninstall**.

BattleTest loses repository access immediately. Historical findings are retained in your account until you delete them.