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

# GitHub

> Connect the Kana GitHub App so agents can read your repositories and open pull requests.

Kanaeru works on your repositories through the **Kana GitHub App**. The app decides which repositories agents can reach. Your own GitHub account, if you link it, decides who authors the commits.

## Install the Kana GitHub App

An owner or admin of your Kanaeru organization does this once:

1. Open **Profile** from the user menu (your name at the bottom of the left sidebar) and connect **GitHub** in its connectors section. Inside a workspace, you can also use **Connected Services** → **Connect a Service** in the workspace's **Settings**.
2. Choose **Install Kana GitHub App**, or **Install on an organization** to add a GitHub organization.
3. Pick the repositories Kanaeru may use. If you install on an organization you don't own, an organization owner may need to approve it.

If the app is installed on more than one GitHub account, Kanaeru asks which installation to connect.

From the terminal, `kana connectors install-url` prints the install page.

### What the app can access

| Permission | Access |
| - | - |
| Contents | Write |
| Pull requests | Write |
| Issues | Write |
| Workflows | Write |
| Actions | Write |
| Administration | Write (used only to create a new private repository when an outcome needs one, and never handed to agents) |
| Checks | Read |
| Commit statuses | Read |
| Metadata | Read |

The app subscribes to pull request, review, review comment, review thread, issue comment, check run, and check suite events. Those events wake the agent caring for a pull request.

## Link your personal GitHub account

In your **Profile**, connect **Personal GitHub** to have commits from your own sessions authored by you, with the agent added as a co-author. This never widens access: agents can still only reach the repositories in your organization's app installation.

You can disconnect it at any time from your profile, or revoke it in GitHub under **Settings → Applications**.

## How pull requests flow

1. **Task pull requests.** Each task works on its own branch in its own worktree. When its pipeline finishes, it opens a pull request from the task branch into the outcome branch.
2. **Pull request care.** The agent stays with its pull request. It fixes CI failures and review findings, and passes questions it can't answer back to you.
3. **Delivery pull requests.** When the last task's pull request merges, Kanaeru opens one pull request per repository from the outcome branch into your integration branch. The outcome's explanation is in the description.
4. **Acceptance.** When the delivery pull requests merge, you sign off with **Start retrospective** and the outcome moves to its retrospective. After the retrospective, **Accept delivery and complete outcome** completes it.

You review and merge on GitHub as you normally would. Kanaeru picks up merges, reviews, and CI results from GitHub events.


## Related topics

- [Settings and profile](/guides/settings.md)
- [Command reference](/cli/reference.md)
- [Compared with other tools](/concepts/comparison.md)


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