Quickstart

Instantly Generate and Deploy UI Tests

Last updated 22 days ago

Was this helpful?

Quickstart

Instantly Generate and Deploy UI Tests

With TestDriver’s AI-powered QA Agents, creating and deploying robust UI tests has never been faster or easier. Here's how to get up and running in no time.

Generate your first test suite

The fastest way to create your first set of tests is by running the demo. TestDriver will automatically log into your application, generate a dozen UI, and push them directly to your GitHub repository.

Follow the guide here to generate your first test suite.

Write your own tests with the Computer-Use agent

Getting started with TestDriver is simple. Just download the TestDriver Agent to enable test generation directly from your environment.

Need Help? Watch the Setup Video

Follow along with our step-by-step YouTube setup guide to see how easy it is to install the agent, connect your app, and start generating tests—no guesswork needed.

Set Up Your First TestDriver Project

To get started, install the testdriverai package globally using Yarn. This package enables you to generate tests effortlessly using natural language commands.

yarn add global testdriverai@beta

Next, create a new directory for your test project and initialize it with testdriverai init.

mkdir testdriver-first-project
cd testdriver-first-project
testdriverai init

This will launch the interactive setup process:

Beginning setup...
✔ Use TestDriver Runners? (Recommended) … yes
? API KEY (from https://app.testdriver.ai/team) ›

TestDriver Runners are the fastest way to get started, but you'll need an TestDriver Pro plan. See Getting an API Key.

Every TestDriver Pro plan comes with $100 of free credits

You can use your own computer as a runner for free. See Local Agent Setup

How To Get an API Key

Paste your API key into the prompt when asked, then follow the remaining steps in the setup to complete your project configuration.

Build tests with the Computer-Use Agent

Now comes the fun part—building your tests! To get started, trigger the Computer-Use Agent by running:

testdriverai

This launches TestDriver in interactive mode. The agent will begin listening for commands and automatically generate test steps based on your input. All generated commands will be saved to testdriver/testdriver.yaml

Give Instructions in Plain English

Now, just tell TestDriver what you want it to do. For our example, try click new task.

> click new task

What Happens Next

TestDriver will analyze your screen, interpret your instruction, and generate a full test script for you. It can see your UI, control the mouse and keyboard, and automate complex workflows—all through simple commands.

See the yml TestDriver generated? That's our own schema. You can learn more about it in the Test Steps.

> click new task

    thinking...

    To accomplish the goal of clicking "New Task" on the
    webpage, we need to focus on the browser window and then
    click the "New Task" button.

    Here is the YAML code to achieve this:

    commands:
      - command: focus-application
        name: Google Chrome
      - command: hover-text
        text: New Task
        description: button to create a new task
        action: click

command='focus-application' name='Google Chrome'
command='hover-text' text='New Task' description='button to create a new task' action='click'

    thinking...

    Based on the provided coordinates and text, the element
    that matches "New Task" with the description "button to
    create a new task" is at coordinates (864, 328).

    Here is the YAML code to click on that element:

    commands:
      - command: click
        x: 864
        y: 328
        click: single
        button: left

command='click' x=864 y=328 click='single' button='left'

Keep going!

You can continue instructing TestDriver with natural commands. It will visually inspect your app and generate the next steps for you. Try:

> enter a task title
> enter a task summary
> click create task
> delete the task

Test It Locallay Before Deployment

Before pushing to GitHub, it’s a good idea to validate your test locally. After you’ve saved the test using /save, run:

testdriverai run testdriver/testdriver.yml

Deploy tests to GitHub

NextFAQ

Last updated 22 days ago

Was this helpful?

With TestDriver’s AI-powered QA Agents, creating and deploying robust UI tests has never been faster or easier. Here's how to get up and running in no time.

Generate your first test suite

Follow the guide here to generate your first test suite.

Write your own tests with the Computer-Use agent

Getting started with TestDriver is simple. Just download the TestDriver Agent to enable test generation directly from your environment.

Need Help? Watch the Setup Video

Follow along with our step-by-step YouTube setup guide to see how easy it is to install the agent, connect your app, and start generating tests—no guesswork needed.

Set Up Your First TestDriver Project

To get started, install the testdriverai package globally using Yarn. This package enables you to generate tests effortlessly using natural language commands.

yarn add global testdriverai@beta

Next, create a new directory for your test project and initialize it with testdriverai init.

mkdir testdriver-first-project
cd testdriver-first-project
testdriverai init

This will launch the interactive setup process:

Beginning setup...
✔ Use TestDriver Runners? (Recommended) … yes
? API KEY (from https://app.testdriver.ai/team) ›

TestDriver Runners are the fastest way to get started, but you'll need an TestDriver Pro plan. See Getting an API Key.

Every TestDriver Pro plan comes with $100 of free credits

You can use your own computer as a runner for free. See Local Agent Setup

How To Get an API Key

Subscribe to TestDriver Pro in the to access your API key. Every Pro plan comes with $100 of free credits to help you hit the ground running.

Paste your API key into the prompt when asked, then follow the remaining steps in the setup to complete your project configuration.

Build tests with the Computer-Use Agent

Now comes the fun part—building your tests! To get started, trigger the Computer-Use Agent by running:

testdriverai

Give Instructions in Plain English

Now, just tell TestDriver what you want it to do. For our example, try click new task.

> click new task

What Happens Next

See the yml TestDriver generated? That's our own schema. You can learn more about it in the Test Steps.

> click new task

    thinking...

    To accomplish the goal of clicking "New Task" on the
    webpage, we need to focus on the browser window and then
    click the "New Task" button.

    Here is the YAML code to achieve this:

    commands:
      - command: focus-application
        name: Google Chrome
      - command: hover-text
        text: New Task
        description: button to create a new task
        action: click

command='focus-application' name='Google Chrome'
command='hover-text' text='New Task' description='button to create a new task' action='click'

    thinking...

    Based on the provided coordinates and text, the element
    that matches "New Task" with the description "button to
    create a new task" is at coordinates (864, 328).

    Here is the YAML code to click on that element:

    commands:
      - command: click
        x: 864
        y: 328
        click: single
        button: left

command='click' x=864 y=328 click='single' button='left'

Keep going!

You can continue instructing TestDriver with natural commands. It will visually inspect your app and generate the next steps for you. Try:

> enter a task title
> enter a task summary
> click create task
> delete the task

If something didn't work, you can use to remove all of the test steps added since the last prompt.

Test It Locallay Before Deployment

Before pushing to GitHub, it’s a good idea to validate your test locally. After you’ve saved the test using /save, run:

testdriverai run testdriver/testdriver.yml

Deploy tests to GitHub

Ready to ship your tests? Check out our CI/CD integration guides to learn how to and automate them in your pipeline.