> For the complete documentation index, see [llms.txt](https://docs.aviator.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aviator.co/verify/how-to-guides/connect-a-repository.md).

# Connect a repository

This guide explains how to connect a GitHub repository to Aviator Verify.

### Prerequisites

* An Aviator account
* Admin or owner access to the GitHub repository
* The Aviator GitHub App installed on your organization

### Steps

#### 1. Install the GitHub App (if not already installed)

Go to **Settings → Integrations → GitHub** in your Aviator dashboard.

If you see “Not connected,” click **Connect GitHub** and follow the OAuth flow to install the Aviator GitHub App on your organization.

Select which repositories the app can access:

* **All repositories** — Aviator can access any repo in your org
* **Select repositories** — Choose specific repos

#### 2. Enable the repository for Verify

Go to **Verify → Repositories**.

Click **Add Repository**.

Select the repository from the dropdown. Only repositories the GitHub App can access will appear.

Click **Enable**.

#### 3. Configure repository settings

After enabling, you can configure:

| Setting           | Description                                              | Default |
| ----------------- | -------------------------------------------------------- | ------- |
| **Exempt paths**  | Glob patterns. PRs touching only these skip verification | Empty   |
| **Preview block** | Per-repo preview configuration in `aviator/verify.yaml`  | None    |

A preview is **not required** to get started — Verify runs code-scan only without one and produces verdicts on structural criteria from the first PR. Add a preview later when behavioral verification matters.

See [Configuration reference](/verify/reference/configuration-reference.md) for the full surface, and [Preview YAML](/verify/reference/preview-yaml.md) for the preview block.

#### 4. Verify the connection

To confirm everything works:

1. Install the [Aviator MCP](/verify/reference/mcp-tools.md) in your coding agent.
2. Make a small change in this repo with the agent.
3. Have the agent call `specSubmit` through the MCP.
4. Open the review URL returned by the tool — you should land on the review document for this repo.
5. Verify the Aviator Verify check appears on the PR (assuming you've opened one).

If the check doesn't appear or the review document fails to load, see [Fixing verification failures](/verify/how-to-guides/fixing-verification-failures.md).

### Adding more repositories

Repeat steps 2-3 for each repository you want to enable.

If a repository doesn’t appear in the dropdown, check that:

* The Aviator GitHub App has access to it
* You have admin access to the repository

### Removing a repository

Go to **Verify → Repositories**, find the repository, and click **Remove**.

This disables Verify for that repository. Existing submissions and verification history are retained.

### See also

* [Configuring branch protection](/verify/how-to-guides/configuring-branch-protection.md)
* [GitHub integration](/verify/reference/github-integration.md)
* [Configuration reference](/verify/reference/configuration-reference.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.aviator.co/verify/how-to-guides/connect-a-repository.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.