Quickstart

The fastest way to generate and deploy E2E UI tests!

TestDriver's AI QA Agents make it easy and fast to generate and deploy powerful tests. Here's how you can get started quickly with TestDriver.

Bootstrap a test suite

The quickest way to create your first tests is with the Test Generation demo. TestDriver will log into your app, generate a dozen tests, and upload them to GitHub.

Test Generation

Get the Computer-Use agent

Setup the TestDriver Project

The testdriverai node package makes it super easy to generate tests using natural language instructions.

Install the testdriveraipackage with npmor yarn .

npm install testdriverai@beta -g

Then, run testdriverai init in the directory you want to make your new test project.

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

TestDriver will launch interactive setup:

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

The TestDriver Running Tests are the fastest and easiest way to get started with TestDriver, but you'll need an API key. You can get one by subscribing to TestDriver Pro in the TestDriver dashboard. See Getting an API Key.

Every TestDriver Pro plan comes with $100 of free credits

Paste the API key from your dashboard into the interactive setup. Complete the rest of the questions.

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

Build tests with the Computer-Use Agent

Now it's time for the fun part, building tests. Run testdriverai [file]to trigger the agent.

Tell TestDriver what you want it to do. See Prompting.

Teach TestDriver

It's time to test! The following command will launch TestDriver in interactive mode. TestDriver will generate test commands and save them totestdriver/test.yml.

testdriverai testdriver/test.yml

Instruct TestDriver

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

> click new task

TestDriver Generates a Test

TestDriver will look at your screen and generate a test script. TestDriver can see the screen, control the mouse, keyboard, and more!

> 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'

TestDriver executes the test script

TestDriver will execute the commands found in the yml codeblocks of the response.

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

Take your hands off the mouse and keyboard while TestDriver executes! TestDriver is not a fan of backseat drivers.

Keep going!

Feel free to ask TestDriver to perform some more tasks. Every time you prompt TestDriver it will look at your screen and generate more test step to complete your goal.

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

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

Test the test locally

Now it's time to make sure the test plan works before we deploy it. Use testdriver run to run the test file you just created with /save .

testdriverai run testdriver/test.yml

Deploy tests to GitHub

Check out Running Testsand GitHub Actionto deploy tests within CI/CD.