testdriverai 6.0.27-canary.30c3346.0 → 6.0.27-canary.ea72c58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/docs.json CHANGED
@@ -38,6 +38,7 @@
38
38
  "group": "CLI",
39
39
  "icon": "terminal",
40
40
  "pages": [
41
+ "/getting-started/cli",
41
42
  "/cli/overview",
42
43
  {
43
44
  "group": "Commands",
@@ -49,8 +50,7 @@
49
50
  ]
50
51
  }
51
52
  ]
52
- },
53
- "/getting-started/vscode"
53
+ }
54
54
  ]
55
55
  },
56
56
  {
@@ -172,7 +172,16 @@
172
172
  "/commands/wait-for-text"
173
173
  ]
174
174
  }
175
- ]
175
+ ],
176
+ "global": {
177
+ "anchors": [
178
+ {
179
+ "anchor": "Book a Demo",
180
+ "href": "https://testdriver.ai/demo",
181
+ "icon": "calendar"
182
+ }
183
+ ]
184
+ }
176
185
  },
177
186
  "modeToggle": {
178
187
  "enabled": false,
@@ -189,17 +198,13 @@
189
198
  "label": "Discord",
190
199
  "icon": "discord",
191
200
  "href": "https://discord.com/invite/cWDFW8DzPm"
192
- },
193
- {
194
- "label": "Book a Demo",
195
- "href": "https://form.typeform.com/to/UECf9rDx?typeform-source=docs.testdriver.ai",
196
- "icon": "calendar"
197
- }, {
198
- "icon": "gauge-high",
201
+ }
202
+ ],
203
+ "primary": {
204
+ "type": "button",
199
205
  "label": "Dashboard",
200
206
  "href": "https://app.testdriver.ai"
201
207
  }
202
- ]
203
208
  },
204
209
  "footer": {
205
210
  "socials": {
@@ -1,81 +1,75 @@
1
1
  ---
2
2
  title: "Install the TestDriver VS Code Extension"
3
- sidebarTitle: "VS Code (Beta)"
3
+ sidebarTitle: "VS Code Setup"
4
4
  description: "Comprehensive guide to installing and setting up TestDriver for VS Code"
5
5
  icon: "file-code"
6
6
  ---
7
7
 
8
- <iframe
9
- className="w-full aspect-video rounded-xl"
10
- src="https://www.youtube.com/embed/dell_2tI6nc"
11
- title="YouTube video player"
12
- frameBorder="0"
13
- allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
14
- allowFullScreen
15
- ></iframe>
8
+ <Card
9
+ title="Get the VS Code Extension"
10
+ icon="link"
11
+ href="https://marketplace.visualstudio.com/items?itemName=testdriver.testdriver"
12
+ >
13
+ Turn your IDE into a powerful computer-use automation tool with our VS Code
14
+ extension.
15
+ </Card>
16
16
 
17
- The TestDriver VS Code extension is a powerful tool that integrates TestDriver's AI-driven test generation capabilities directly into your development environment:
18
-
19
- - Get started with example scripts for different platforms
20
- - Get syntax highlighting and autocompletion for [TestDriver YAML](/getting-started/editing)
21
- - Chat with the TestDriver agent to generate tests based on your requirements
22
- - Save and manage your tests directly within your project
23
- - Run and debug tests directly from the IDE
24
- - View test results and logs within the IDE
17
+ <Steps>
18
+ <Step title="Initialize Your Project" stepNumber={1}>
19
+ Set up your project with:
25
20
 
26
- <Tip>The TestDriver VS Code Extension is currently in beta. If you encounter any issues or have feedback, please let us know [in Discord](https://discord.com/invite/cWDFW8DzPm)</Tip>
21
+ ```bash
22
+ npx testdriverai@latest init
23
+ ```
27
24
 
28
- <Steps>
29
- <Step title="Install the VS Code Extension">
30
-
31
- Click the button below to install the TestDriver extension for your preferred IDE. Then, follow the setup guide and chat with TestDriver to create your first test.
32
-
33
- <Card
34
- horizontal
35
- title="VS Code"
36
- arrow
37
- href="vscode:extension/testdriver.testdriver"
38
- icon="/images/content/extension/vscode.svg"
39
- ></Card>
40
-
41
- <Card
42
- horizontal
43
- title="Cursor"
44
- arrow
45
- href="cursor:extension/testdriver.testdriver"
46
- icon="/images/content/extension/cursor.svg"
47
-
48
- > </Card>
49
-
50
- <Card
51
- horizontal
52
- title="Windsurf"
53
- arrow
54
- href="windsurf:extension/testdriver.testdriver"
55
- icon="/images/content/extension/windsurf.svg"
56
- ></Card>
25
+ This creates a `.env` file and sample workflow files.
57
26
 
58
27
  </Step>
59
- <Step title="Set Your TestDriver API Key">
60
-
61
- After installing the extension, you'll need to set your TestDriver API key in the extension settings.
28
+ <Step title="Run TestDriver in Interactive Mode" stepNumber={2}>
29
+ Start TestDriver in interactive mode to create and refine tests dynamically:
62
30
 
63
- 1. Open the command palette (Cmd+Shift+P or Ctrl+Shift+P).
64
- 2. Search for "Preferences: Open Settings (UI)" and select it.
65
- 3. In the search bar, type "TestDriver" to filter the settings.
66
- 4. Find the "TestDriver: Set API Key" field and enter your API key from [the TestDriver dashboard](https://app.testdriver.ai/team).
31
+ ```bash
32
+ npx testdriverai@latest
33
+ ```
34
+
35
+ Once started, you can use commands like `/explore`, `/run`, and `/save` to interactively build and test your flows.
67
36
 
68
- <Tip>You can also set the `TD_API_KEY` environment variable in your system if you prefer not to enter it directly in the extension settings.</Tip>
69
-
70
37
  </Step>
71
- <Step title="Choose a Platform">
72
- Click on the TestDriver icon in the sidebar to open the extension panel and choose a platform to get started (Web, Desktop, or Mobile).
38
+ <Step title="Define Your Test Steps" stepNumber={3}>
39
+ Use natural language to describe what you want to test. For example:
40
+
41
+ ```
42
+ > Open Google Chrome and search for "testdriverai"
43
+ ```
44
+
45
+ TestDriver will generate steps like:
46
+
47
+ ```yaml
48
+ - command: focus-application
49
+ name: Google Chrome
50
+ - command: hover-text
51
+ text: Search Google or type a URL
52
+ description: main search bar
53
+ action: click
54
+ - command: type
55
+ text: testdriverai
56
+ - command: press-keys
57
+ keys:
58
+ - enter
59
+ ```
60
+
73
61
  </Step>
74
- <Step title="Create Your First Test">
75
- Now chat with the TestDriver agent to create your first test! Describe what you want to test, and the agent will generate the test steps for you.
62
+ <Step title="Refine and Save Your Test" stepNumber={4}>
63
+ - Save your test with `/save` to generate a reusable YAML file.
64
+ - Use `/run` to run the test.
76
65
  </Step>
77
- <Step title="Run your test">
78
- Run your test by clicking the "Run" button in the extension panel. You can view the test results and logs directly within VS Code's Test Explorer. [Learn more about running tests in VS Code](https://code.visualstudio.com/docs/debugtest/testing).
66
+ <Step title="Run Saved Tests" stepNumber={5}>
67
+ Once saved, you can run your test file anytime:
68
+
69
+ ```bash
70
+ npx testdriverai@latest run path/to/test.yaml
71
+ ```
72
+
79
73
  </Step>
80
74
  </Steps>
81
75
 
@@ -13,8 +13,6 @@ TestDriver operates a full desktop environment, so it can run any application.
13
13
  | Application | TestDriver | Playwright | Selenium |
14
14
  |:-----------------:|:---------:|:-----------:|:--------:|
15
15
  | Web Apps | ✅ | ✅ | ✅ |
16
- | Mobile Apps | ✅ | ✅ | ✅ |
17
- | VS Code | ✅ | ✅ | ✅ |
18
16
  | Desktop Apps | ✅ | | |
19
17
  | Chrome Extensions | ✅ | | |
20
18
  </div>
@@ -98,4 +96,4 @@ TestDriver currently supports Mac and Windows!
98
96
  | Windows | ✅ | ✅ | ✅ |
99
97
  | Mac | ✅ | ✅ | ✅ |
100
98
  | Linux | | ✅ | ✅ |
101
- </div>
99
+ </div>
@@ -6,106 +6,53 @@ icon: "gauge-high"
6
6
  mode: "wide"
7
7
  ---
8
8
 
9
+ <Tip>
10
+ You will need a [TestDriver Pro](https://app.testdriver.ai/team) account
11
+ ($20/m) to complete setup.
12
+ </Tip>
9
13
 
10
14
  <Steps>
11
- <Step title="Create a TestDriver Account">
12
-
13
- You will need a [TestDriver Pro](https://app.testdriver.ai/team) account ($20/m) to complete setup.
14
-
15
+ <Step title="Install TestDriver">
16
+
17
+ Click the button below to install the TestDriver extension for your preferred IDE. Then, follow the setup guide and chat with TestDriver to create your first test.
18
+
15
19
  <Card
16
- title="Sign Up for TestDriver"
17
- icon="user-plus"
18
- href="https://app.testdriver.ai/signup"
19
- arrow
20
20
  horizontal
21
+ title="VS Code"
22
+ arrow
23
+ href="vscode:extension/testdriver.testdriver"
24
+ icon="/images/content/extension/vscode.svg"
21
25
  ></Card>
22
26
 
23
- </Step>
24
- <Step title="Set up your environment">
25
-
26
- Copy your API key from [the TestDriver dashboard](https://app.testdriver.ai/team), and set it as an environment variable.
27
-
28
- <Tabs>
29
- <Tab title="macOS / Linux">
30
- ```bash Export an environment variable on macOS or Linux systems
31
- export TD_API_KEY="your_api_key_here"
32
- ```
33
- </Tab>
34
- <Tab title="Windows">
35
- ```powershell Export an environment variable in PowerShell
36
- setx TD_API_KEY "your_api_key_here"
37
- ```
38
- </Tab>
39
- </Tabs>
40
-
41
- <Tip>Using VS Code, Cursor, or Windsurf? [Try our VS Code Extension (beta)](/getting-started/vscode).</Tip>
42
-
43
- </Step>
44
- <Step title="Check out an example test">
45
-
46
- Download the TestDriver GitHub repository and run the example test.
47
-
48
- ```bash
49
- git clone --depth 0 https://github.com/testdriverai/cli testdriverai
50
- cd testdriverai/testdriver/acceptance
51
- ```
27
+ <Card
28
+ horizontal
29
+ title="Cursor"
30
+ arrow
31
+ href="cursor:extension/testdriver.testdriver"
32
+ icon="/images/content/extension/cursor.svg"
52
33
 
53
- TestDriver tests are written in YAML, a human-readable data format. The `prompt.yaml` file contains an example series of steps for the agent to execute.
34
+ > </Card>
54
35
 
55
- ```yaml testdriver/acceptance/prompt.yaml
56
- steps:
57
- - prompt: log in
58
- - prompt: add an item to the cart
59
- - prompt: click on the cart icon
60
- - prompt: complete checkout
61
- ```
36
+ <Card
37
+ horizontal
38
+ title="Windsurf"
39
+ arrow
40
+ href="windsurf:extension/testdriver.testdriver"
41
+ icon="/images/content/extension/windsurf.svg"
42
+ ></Card>
62
43
 
63
- Each step has a `prompt` that describes what the agent should do. The agent will use the prompt to generate [commands](/commands/assert) that make the tests faster and more reliable the next time you run the test.
44
+ The extension will generate most of your tests for you, but you'll probably want to customize them. [Learn more about editing tests](/getting-started/editing).
64
45
 
65
46
  </Step>
66
- <Step title="Generate regression test from prompts">
47
+ <Step title="Run your tests in CI/CD">
67
48
 
68
- Run the following command to run the test file. TestDriver will spawn a virtual machine, launch the sandbox test page, and execute the steps defined in the `prompt.yaml` file.
49
+ Next, use `testdriverai` to run your tests in CI/CD pipelines.
69
50
 
70
51
  ```bash
71
- npx testdriverai@latest run prompt.yaml --write --heal
52
+ TD_API_KEY=YOUR_KEY npx testdriverai@latest run testdriver/test.yaml
72
53
  ```
73
54
 
74
- The `--write` flag tells TestDriver to save any generated commands to the test file, and the `--heal` flag allows TestDriver to recover from unexpected issues during the test run.
75
-
76
- <Tip>You can use an interactive CLI to generate test steps with the [explore command](/interactive/explore)</Tip>
77
-
78
- </Step>
79
- <Step title="Run the generated regression test">
80
-
81
- After TestDriver has run the exploratory test, you'll see that the `prompt.yaml` file has been updated with commands generated by the agent to make the test faster and more reliable.
82
-
83
- ```yaml
84
- version: 6.0.0
85
- steps:
86
- - prompt: focus chrome
87
- commands:
88
- - command: focus-application
89
- name: Google Chrome
90
- - prompt: enter a username
91
- commands:
92
- - command: hover-text
93
- text: Username
94
- description: username input field
95
- action: click
96
- - command: type
97
- text: standard_user
98
- - prompt: enter a password
99
- commands:
100
- - command: hover-text
101
- text: Password
102
- description: password input field
103
- action: click
104
- - command: type
105
- text: secret_password
106
- ```
107
-
108
- The `--write` command tells the agent to save the generated commands to the test file, and the `--heal` command gives the agent permission to recover if something goes wrong.
55
+ Note that you'll want to store your API key within secret storeage. [Learn more about running tests in CI/CD pipelines](/action/setup).
109
56
 
110
57
  </Step>
111
58
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "testdriverai",
3
- "version": "6.0.27-canary.30c3346.0",
3
+ "version": "6.0.27-canary.ea72c58.0",
4
4
  "description": "Next generation autonomous AI agent for end-to-end testing of web & desktop",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -1,10 +1,7 @@
1
1
  version: 6.0.0
2
2
  session: 6869c3e61445b2acbbdc0018
3
3
  steps:
4
- - prompt: log in
5
- - prompt: add an item to the cart
6
- - prompt: click on the cart icon
7
- - prompt: complete checkout
4
+ - prompt: enter a valid username, password, and sign in
8
5
  - prompt: assert
9
6
  commands:
10
7
  - command: assert