Testdriver Quickstart Github

---
name: testdriver:quickstart-github
description: Drop-in UI tests for any GitHub repository.
---
<!-- Generated from quickstart-github.mdx. DO NOT EDIT. -->

Drop-in UI tests for any GitHub repository. Mention `@testdriverai` in a pull request or issue and it writes, runs, and commits UI tests, then catches regressions before they merge. No local install required.

<Card
  title="Add to GitHub"
  icon="github"
  href="https://go.testdriver.ai/github"
  arrow
  horizontal
>
  Install the TestDriver GitHub App and start testing in minutes.
</Card>

<Steps>
  <Step title="Install the GitHub App">
    Click **Add to GitHub** above and choose the repositories you want to test. You can add more repositories later from your GitHub organization settings.
  </Step>

  <Step title="Mention @testdriverai">
    Open a pull request or an issue and describe the test you want in a comment:

    ```text
    @testdriverai Write a test that verifies the homepage loads and the signup button works.
    ```

    TestDriver replies in the thread, starts a sandbox, writes the test, runs it, and posts the result with a link to the recording. It then opens a pull request that adds the test file to your repository.

    <Tip>
    Describe what a user does and what they should see, not implementation details. "Log in, add the first product to the cart, and confirm the cart badge shows 1" gives better results than "click `#add-btn`".
    </Tip>
  </Step>

  <Step title="Catch regressions automatically">
    Once tests are committed, TestDriver runs them on every pull request that changes something a user would see and posts a review with what it observed, including a recording. Mention `@testdriverai` on any PR to ask follow-up questions or request more tests.
  </Step>
</Steps>

Want to use TestDriver from GitHub Copilot or the GitHub Mobile app? Read the full GitHub guide:

<Card
  title="GitHub Integration Guide"
  icon="arrow-right"
  href="/copilot/auto-healing#use-testdriver-in-github"
  arrow
  horizontal
>
  Use TestDriver from GitHub web, Copilot chat, PR reviews, and mobile.
</Card>