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

# Connect GitHub

> Install and configure the Darkplane GitHub App for your organization.

Darkplane connects to GitHub through a GitHub App installation. The app listens for pull request and check run events and acts on your behalf when automation is enabled.

## Installation is onboarding

Darkplane is a public GitHub App. Installing it on an account is what grants that account access: when you install the App on an organization or your personal account, Darkplane records that account as a tenant and the people who belong to it can sign in. There is no separate allowlist or approval step. Uninstalling the App (or suspending it from your GitHub settings) withdraws that access.

During the alpha the install link is shared privately with design partners rather than listed on the GitHub Marketplace. Treat the link as the gate to onboarding.

## Add repositories yourself

Once you can sign in, the **Repositories** page has an **Add repository** action that takes you to the App's install/configuration page for this environment. Use it to install Darkplane on a new account or to add repositories to an existing installation. You can install on:

* an **organization** you administer, or
* your **personal account**, to run Darkplane on your own repositories.

After installing, return to Darkplane and sign in (if you are not already). Newly connected repositories appear on the Repositories page once GitHub delivers the first webhook for them.

<Note>
  Signing in before installing the App shows a "not installed" message with a direct install link. Install the App on an account you belong to, then sign in again.
</Note>

## What you can see

Signing in only admits you; it does not widen what you can see. You see exactly the repositories owned by accounts you belong to **and** that your own GitHub account can read, checked live against GitHub on every load. Other tenants' repositories are never visible to you.

## Required permissions

* **Contents (read):** Needed to read repository files during ingestion and evaluation.
* **Contents (write):** Needed only if auto-merge is enabled, so Darkplane can merge qualifying pull requests.
* **Pull requests (write):** Needed to post approvals and review comments.
* **Checks (write):** Needed to publish evaluation results as check runs.

<Note>
  If you change the app's permissions after installation, GitHub requires the installation to re-consent before the new permissions take effect.
</Note>

## Installation scope

You can install Darkplane on all repositories or a selected subset. Start with a small set of low-risk repositories and expand as your readiness scores improve.

## Troubleshooting

* **"Resource not accessible by integration":** The app is missing a permission for the action it attempted. Check the installation's granted permissions before debugging code.
* **No data after installation:** Verify that `contents:read` was granted and that the installation consented to it.