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

# GitHub

> Connect your GitHub repositories to Antimetal

## Overview

This guide walks you through connecting your GitHub repositories to enable the Antimetal integration.

<Card title="Set up in Antimetal" icon="arrow-up-right-from-square" href="https://overlook.antimetal.com/integrations/github">
  Go to the GitHub integration setup in the Antimetal dashboard.
</Card>

## Prerequisites

* A GitHub account with admin access to the repositories you want to connect
* Permission to install GitHub Apps in your organization

## Setup

<Steps>
  <Step title="Install the Antimetal GitHub App">
    Navigate to the Antimetal UI and click **Connect GitHub**. This will redirect you to GitHub to install the Antimetal app.
  </Step>

  <Step title="Select repositories">
    Choose whether to grant access to all repositories or select specific ones.
  </Step>

  <Step title="Authorize the app">
    Review the requested permissions and click **Install & Authorize**.
  </Step>

  <Step title="Confirm in Antimetal">
    You'll be redirected back to the Antimetal UI. Verify that your repositories appear in the integrations page.
  </Step>
</Steps>

## Permissions and Access

The Antimetal GitHub App pulls CI status, deploys, security alerts, and PR activity into investigations. Antimetal only opens a pull request when an engineer asks for one. See [Fixes](/product/fixes) for how that works.

### Repository

| Permission             | Access         |
| ---------------------- | -------------- |
| Actions                | Read           |
| Checks                 | Read and write |
| Code scanning alerts   | Read           |
| Commit statuses        | Read           |
| Contents               | Read and write |
| Dependabot alerts      | Read           |
| Deployments            | Read           |
| Discussions            | Read           |
| Environments           | Read           |
| Issues                 | Read and write |
| Merge queues           | Read           |
| Metadata               | Read           |
| Pull requests          | Read and write |
| Secret scanning alerts | Read           |

### Organization

| Permission                     | Access |
| ------------------------------ | ------ |
| Members                        | Read   |
| Organization custom properties | Read   |

<Snippet file="security-note.mdx" />

<Snippet file="need-help.mdx" />