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

# GitHub

> Install the CodeObsess GitHub App so CodeObsess can read your repositories and open pull requests.

## What it does

The CodeObsess GitHub App lets CodeObsess copy your chosen repositories for a run, push its branch and open pull requests. Its bot is `codeobsess[bot]`. Pull requests are assigned to the person who asked, when their GitHub account is linked.

## Connect GitHub

An owner or admin of your company does this.

1. On **Home**, press **Connect GitHub**. One GitHub screen signs you in with GitHub and installs the CodeObsess app.
2. On GitHub, choose the account or organisation and the repositories CodeObsess may see.
3. Back on Home, wait while CodeObsess reads your repositories from GitHub.
4. Do the **Choose repositories** step: pick each repository's access (**Write** or **Read-only**) and the **Main repository**.

> [!NOTE]
>
> Only an owner of your GitHub organisation can install the app there. If that isn't you, press **Ask your GitHub admin** and send them the link. It works once, for 7 days, and connects GitHub for your company only.

## Add or remove repositories

* **Settings › Repositories** lists every repository the app can see. **Add repository** opens GitHub, where you choose which repositories CodeObsess can see. Then press **Refresh**.

![Settings, Repositories: a table of repositories with team, access, description and base branch](https://mintcdn.com/code-obsess/0ZvNNm_XHMri9byY/images/settings/repositories-light.png?fit=max\&auto=format\&n=0ZvNNm_XHMri9byY\&q=85\&s=38929dccd0c145ba46503d02aa7b173a)

* If CodeObsess can no longer see a repository, it says so and keeps it in the list as **Not visible**. Give the app access to it again, or remove it from your products.
* **Base branch**: by default CodeObsess starts from GitHub's default branch. Owners and admins can set another branch in the repository's settings; it must exist on GitHub.

## What access it needs

On the repositories you choose, the app asks GitHub for:

* **Contents**: read and write, to copy the code and push CodeObsess's branch.
* **Pull requests**: read and write, to open and update its pull requests and read review comments.
* **Issues**: read and write, for [GitHub Issues](https://docs.codeobsess.com/connect/github-issues.md) tickets.
* **Metadata**: read-only.

CodeObsess never merges, never force-pushes, and never makes releases or tags. See [Security and privacy](https://docs.codeobsess.com/security/privacy.md).

## Disconnect

**Settings › Connections** shows GitHub with **Manage on GitHub**. There you can change the repositories the app sees, or uninstall it. Once it is uninstalled, CodeObsess can't publish pull requests for your company. To connect again, use **Reconnect** in **Settings › Connections**.


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