# Quickstart

This quickstart walks you through the shortest successful path in TestVibe:

1. Sign in with GitHub.
2. Select the repository you want to test.
3. Create or connect a TestVibe project.
4. Create your first Gherkin test.
5. Generate Playwright code.
6. Run the test.
7. Review the result.

You can come back later for deeper setup, generation, run, and troubleshooting details. For now, the goal is simple: get one useful test from idea to result.

## Before You Begin

You will need:

* a GitHub account
* access to a repository you want to test
* the TestVibe GitHub App installed for that repository, or permission to request installation
* the URL of the site you want to test
* any required API key or secret for AI generation, if TestVibe asks for one

If you are not sure whether your repository is ready, start anyway. TestVibe will prompt for missing setup as you move through the flow.

## Quickstart Path

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>1. Sign in</strong></td><td>Use GitHub to sign in and give TestVibe access to your workspace.</td><td><a href="/pages/Qj8uC4FMtg6Ddmqlc7k4">/pages/Qj8uC4FMtg6Ddmqlc7k4</a></td></tr><tr><td><strong>2. Select a repository</strong></td><td>Choose the GitHub installation, team, and repository where your tests will live.</td><td><a href="/pages/oJb99QHKe4cosCqImwWf">/pages/oJb99QHKe4cosCqImwWf</a></td></tr><tr><td><strong>3. Create or connect</strong></td><td>Create a new TestVibe project or connect an existing repository.</td><td><a href="/pages/YDyXoHmaJyx0IzhVThDR">/pages/YDyXoHmaJyx0IzhVThDR</a></td></tr><tr><td><strong>4. Create a test</strong></td><td>Add your first Gherkin feature or test instructions in the Test Suite.</td><td><a href="/pages/nRkMMo4g3K9NDlQ9RrsT">/pages/nRkMMo4g3K9NDlQ9RrsT</a></td></tr><tr><td><strong>5. Generate code</strong></td><td>Use AI generation to turn the test intent into Playwright code.</td><td><a href="/pages/syTrwMhuGNSrbokqD1VH">/pages/syTrwMhuGNSrbokqD1VH</a></td></tr><tr><td><strong>6. Run and review</strong></td><td>Run the generated test and inspect the result evidence.</td><td><a href="/pages/7QdI4vUB8sdb0yMQU9UX">/pages/7QdI4vUB8sdb0yMQU9UX</a></td></tr></tbody></table>

## What You Will Have At The End

After the quickstart, you should have:

* a connected TestVibe workspace
* a selected GitHub repository
* one Gherkin feature or test description
* generated Playwright code stored in the repository
* one completed test run
* result evidence you can use to decide what to do next

## If Something Blocks You

Most first-run issues come from setup rather than the test itself.

<table data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Repository is missing</strong></td><td><a href="/pages/FAsrRSBs3r7qY9lUVvR9">Check GitHub App access and repository permissions.</a></td></tr><tr><td><strong>Generation cannot start</strong></td><td><a href="/pages/dKqKlqKjBn3jRDPit9sQ">Check required API keys and repository secrets.</a></td></tr><tr><td><strong>Run fails</strong></td><td><a href="/pages/2QgfJOf3NN6WVR2bzT9g">Open the result evidence before changing the test.</a></td></tr></tbody></table>

## Next

Start with [Sign in with GitHub](/quickstart/sign-in-with-github.md).


---

# Agent Instructions: 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:

```
GET https://docs.testvibe.com/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
