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

# GitHub

> The read-only Xerg GitHub App: how Xerg reads your repos, and its exact permissions.

GitHub is how Xerg finds everything else. You connect it by signing up: **Sign up with GitHub** installs the Xerg App on your organization or account and signs you in. See the [Quickstart](https://xerg.ai/docs/quickstart.md).

## Permissions

The Xerg App asks for read-only access, and nothing else:

| Permission | Access | What for |
| - | - | - |
| Repository contents | Read-only | The file list of each repo, and the config and source files [Xerg reads](https://xerg.ai/docs/what-xerg-reads.md) |
| Metadata | Read-only | Repo names, default branches and visibility (every GitHub App has this) |
| Email addresses | Read-only | Your email, to sign you in |

It can't push code, open pull requests, change settings or see issues.

## Which repos

Xerg maps every repo the app can see. When you install it, GitHub asks whether that's all repos or only the ones you pick. To change the list later, a workspace admin or owner chooses **choose repos** in Xerg's left rail, which opens the app's settings on GitHub.

A repo the app can no longer see comes off the map. Earlier days in [history](https://xerg.ai/docs/map/history.md) still have it.

## Not an owner?

GitHub sends your install to the organization's owners as a request. Xerg picks it up once they approve it. Meanwhile you can map public repos.

## Who joins

The first person in through GitHub is the workspace's owner. Others with access to the install join as viewers when they sign in, and an admin can make them members. See [Teams and roles](https://xerg.ai/docs/teams-and-roles.md).

## Removing it

Uninstall the Xerg App from your organization's **Settings → GitHub Apps** on GitHub. Xerg can no longer read your repos; to delete the workspace and its map, see [Security and data](https://xerg.ai/docs/security.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.