> For the complete documentation index, see [llms.txt](https://docs.testvibe.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.testvibe.com/workspace/install-github-app.md).

# Connect GitHub (Optional)

TestVibe does not need GitHub. Projects are created in the app, and all project content — feature files, generated tests, configurations, run history, and evidence — lives in TestVibe's cloud.

GitHub appears in three optional places, and each one is independent:

| Where                                             | What it does                                                                                                                                                                          |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Sign in with GitHub                               | Identity only. TestVibe never asks for repository permissions at sign-in.                                                                                                             |
| Source repository (**Settings → App Repository**) | A per-project, read-only repository the assistant reads to understand your app's code.                                                                                                |
| Test Files Sync (**Settings → Test Files Sync**)  | Two-way mirror of this project's own test files (features, specs, Playwright configs) to a repository TestVibe can write to. Repository scopes are requested only when you enable it. |

## Sign In With GitHub

Signing in with GitHub (or Google, or email and password) only identifies you. No app installation is required, and TestVibe does not list, read, or write repositories just because you signed in with GitHub.

## Link A Source Repository

If the application you are testing has its code on GitHub, you can give the project a source repository URL in **Settings → App Repository**. (When adding an additional project from the workspace switcher, you can also fill this in during creation, under "Advanced settings" — the very first project's single-screen create form doesn't offer it.) The assistant reads the code to understand the app; it does not read it automatically the moment you connect it.

See [Choose a source repository (optional)](/workspace/choose-repository.md).

## Sync Your Test Files

Project content stays canonical in TestVibe's cloud, but you can mirror your generated test files to a GitHub, GitLab, or Azure DevOps repository you own, in **Settings → Test Files Sync**. Once linked, edits flow both ways — this is separate from, and independent of, the read-only App Repository connection above. TestVibe requests repository permissions only at the moment you enable sync — never earlier, and never at sign-in.

## Related Help

* [Choose a source repository (optional)](/workspace/choose-repository.md)
* [Create a new project](/workspace/create-new-project.md)
* [App Repository & Test Files Sync settings](/account-settings/repository-settings.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.testvibe.com/workspace/install-github-app.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.