testdriverai 6.0.26 → 6.0.27-canary.062dddf.0

package/.vscode/settings.json

@@ -3,5 +3,8 @@
     "source.organizeImports": "explicit"
   },
   "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/testdriverai/testdriverai/main/schema.json": "file:///Users/kid/Desktop/td/internal/testdriverai/testdriver.yaml"
+  }
 }

package/agent/index.js

@@ -1139,21 +1139,8 @@ ${yml}
 
     // Create diff if file exists and content has changed
     let diffResult = null;
-    console.log("Checking for diff. File exists:", fileExists);
-    console.log(
-      "Content changed:",
-      fileExists && existingContent !== regression,
-    );
-    if (fileExists) {
-      console.log(
-        "Existing content preview:",
-        existingContent.substring(0, 100),
-      );
-      console.log("New content preview:", regression.substring(0, 100));
-    }
 
     if (fileExists && existingContent !== regression) {
-      console.log("Creating diff - content has changed");
       const patches = diff.structuredPatch(
         filepath,
         filepath,
@@ -1241,8 +1228,6 @@ ${yml}
           diff: diffResult,
           timestamp: endTime,
         });
-      } else {
-        console.log("No diff result to emit");
       }
 
       // Emit file save completion event

package/agent/lib/commander.js

@@ -134,6 +134,7 @@ commands:
             object.description,
             object.action,
             object.method,
+            object.timeout,
           );
           break;
         case "hover-image":

package/agent/lib/commands.js

@@ -339,11 +339,12 @@ const createCommands = (
       description = null,
       action = "click",
       method = "turbo",
+      timeout = 5000, // we pass this to the subsequent wait-for-text block
     ) => {
       text = text ? text.toString() : null;
 
       // wait for the text to appear on screen
-      await commands["wait-for-text"](text, 5000);
+      await commands["wait-for-text"](text, timeout);
 
       description = description ? description.toString() : null;
 

package/docs/cli/overview.mdx

@@ -30,6 +30,7 @@ npx testdriverai@latest <command> [options]
 | `--headless`        | Run test without opening a browser window (useful for CI/CD environments)                  |
 | `--new`             | Create a new sandbox environment for the test run.                                         |
 | `--summary=<value>` | Output file where AI summary should be saved.                                              |
+| `--junit=<value>`   | Output file where junit report should be saved.                                              |
 
 ## Example usage
 

package/docs/commands/hover-text.mdx

@@ -18,12 +18,13 @@ The `hover-text` command is used to locate text on the screen based on a descrip
 
 ## Arguments
 
-|   Argument    |   Type   | Description                                                                                                                                                                                                                 |
-| :-----------: | :------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-|    `text`     | `string` | The text to find on the screen. Longer and unique is better.                                                                                                                                                                |
-| `description` | `string` | A description of the text and what it represents. The actual text itself shouldn't be included here.                                                                                                                        |
+|   Argument    |   Type   | Description                                             |
+| :-----------: | :------: | :------------------------------------------------------ |
+|    `text`     | `string` | The text to find on the screen. Longer and unique is better.   |
+| `description` | `string` | A description of the text and what it represents. The actual text itself shouldn't be included here. |
 |   `action`    | `string` | The action to take when the text is found. Available actions are: `click`, `right-click`, `double-click`, `hover`. Also supports `drag-start` and `drag-end` for [dragging text](/commands/hover-image#drag-functionality). |
-|   `method`    |  `enum`  | The matching algorithm to use. Possible values are `turbo` (default) and `ai`.                                                                                                                                              |
+|   `method`    |  `enum`  | The matching algorithm to use. Possible values are `turbo` (default) and `ai`.|
+| `timeout`     | `number` | **(Optional)** The duration in milliseconds to wait for the text to appear. Default is `5000` (5 seconds).|
 
 ## Example usage
 
@@ -32,11 +33,12 @@ command: hover-text
 text: Sign Up
 description: link in the header
 action: click
+timeout: 10000 # 10 seconds
 ```
 
 ## Gotchas
 
-- If the text can't be located, the command will fail. Ensure the text is visible on the screen and matches exactly.
+- If the text can't be located, it will internally call the [wait-for-text](/commands/wait-for-text) command and wait for the text to appear. The wait `timeout` is 5 seconds by default, and the command fails if the text is not found.
 - Variations in font size, style, or screen resolution may affect detection accuracy.
 
 ## Notes

package/docs/docs.json

@@ -38,7 +38,6 @@
             "group": "CLI",
             "icon": "terminal",
             "pages": [
-              "/getting-started/cli",
               "/cli/overview",
               {
                 "group": "Commands",
@@ -50,7 +49,8 @@
                 ]
               }
             ]
-          }
+          },
+          "/getting-started/vscode"
         ]
       },
       {
@@ -172,16 +172,7 @@
           "/commands/wait-for-text"
         ]
       }
-    ],
-    "global": {
-      "anchors": [
-        {
-          "anchor": "Book a Demo",
-          "href": "https://testdriver.ai/demo",
-          "icon": "calendar"
-        }
-      ]
-    }
+    ]
   },
   "modeToggle": {
     "enabled": false,
@@ -198,13 +189,17 @@
         "label": "Discord",
         "icon": "discord",
         "href": "https://discord.com/invite/cWDFW8DzPm"
-      }
-    ],
-    "primary": {
-      "type": "button",
+      }, 
+      {
+        "label": "Book a Demo",
+        "href": "https://form.typeform.com/to/UECf9rDx?typeform-source=docs.testdriver.ai",
+        "icon": "calendar"
+      }, {
+      "icon": "gauge-high",
       "label": "Dashboard",
       "href": "https://app.testdriver.ai"
     }
+    ]
   },
   "footer": {
     "socials": {

package/docs/getting-started/vscode.mdx

@@ -1,75 +1,81 @@
 ---
 title: "Install the TestDriver VS Code Extension"
-sidebarTitle: "VS Code Setup"
+sidebarTitle: "VS Code (Beta)"
 description: "Comprehensive guide to installing and setting up TestDriver for VS Code"
 icon: "file-code"
 ---
 
-<Card
-  title="Get the VS Code Extension"
-  icon="link"
-  href="https://marketplace.visualstudio.com/items?itemName=testdriver.testdriver"
->
-  Turn your IDE into a powerful computer-use automation tool with our VS Code
-  extension.
-</Card>
+<iframe
+  className="w-full aspect-video rounded-xl"
+  src="https://www.youtube.com/embed/dell_2tI6nc"
+  title="YouTube video player"
+  frameBorder="0"
+  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
+  allowFullScreen
+></iframe>
 
-<Steps>
-  <Step title="Initialize Your Project" stepNumber={1}>
-    Set up your project with:
-
-    ```bash
-    npx testdriverai@latest init
-    ```
+The TestDriver VS Code extension is a powerful tool that integrates TestDriver's AI-driven test generation capabilities directly into your development environment:
 
-    This creates a `.env` file and sample workflow files.
+- Get started with example scripts for different platforms
+- Get syntax highlighting and autocompletion for [TestDriver YAML](/getting-started/editing)
+- Chat with the TestDriver agent to generate tests based on your requirements
+- Save and manage your tests directly within your project
+- Run and debug tests directly from the IDE
+- View test results and logs within the IDE
 
-  </Step>
-  <Step title="Run TestDriver in Interactive Mode" stepNumber={2}>
-    Start TestDriver in interactive mode to create and refine tests dynamically:
+<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>
 
-    ```bash
-    npx testdriverai@latest
-    ```
-
-    Once started, you can use commands like `/explore`, `/run`, and `/save` to interactively build and test your flows.
+<Steps>
+  <Step title="Install the VS Code Extension">
+    
+    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.
+
+    <Card
+      horizontal
+      title="VS Code"
+      arrow
+      href="vscode:extension/testdriver.testdriver"
+      icon="/images/content/extension/vscode.svg"
+    ></Card>
+
+    <Card
+      horizontal
+      title="Cursor"
+      arrow
+    href="cursor:extension/testdriver.testdriver"
+    icon="/images/content/extension/cursor.svg"
+
+    > </Card>
+
+    <Card
+      horizontal
+      title="Windsurf"
+      arrow
+      href="windsurf:extension/testdriver.testdriver"
+      icon="/images/content/extension/windsurf.svg"
+    ></Card>
 
   </Step>
-  <Step title="Define Your Test Steps" stepNumber={3}>
-    Use natural language to describe what you want to test. For example:
+  <Step title="Set Your TestDriver API Key">
+    
+    After installing the extension, you'll need to set your TestDriver API key in the extension settings.
 
-    ```
-    > Open Google Chrome and search for "testdriverai"
-    ```
-
-    TestDriver will generate steps like:
-
-    ```yaml
-    - command: focus-application
-      name: Google Chrome
-    - command: hover-text
-      text: Search Google or type a URL
-      description: main search bar
-      action: click
-    - command: type
-      text: testdriverai
-    - command: press-keys
-      keys:
-        - enter
-    ```
+    1. Open the command palette (Cmd+Shift+P or Ctrl+Shift+P).
+    2. Search for "Preferences: Open Settings (UI)" and select it.
+    3. In the search bar, type "TestDriver" to filter the settings.
+    4. Find the "TestDriver: Set API Key" field and enter your API key from [the TestDriver dashboard](https://app.testdriver.ai/team).
 
+    <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>
+    
   </Step>
-  <Step title="Refine and Save Your Test" stepNumber={4}>
-    - Save your test with `/save` to generate a reusable YAML file.
-    - Use `/run` to run the test.
+  <Step title="Choose a Platform">
+    Click on the TestDriver icon in the sidebar to open the extension panel and choose a platform to get started (Web, Desktop, or Mobile).
   </Step>
-  <Step title="Run Saved Tests" stepNumber={5}>
-    Once saved, you can run your test file anytime:
-
-    ```bash
-    npx testdriverai@latest run path/to/test.yaml
-    ```
-
+  <Step title="Create Your First Test">
+    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.
+  </Step>
+  <Step title="Run your test">
+    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). 
   </Step>
 </Steps>
 

package/docs/overview/comparison.mdx

@@ -13,6 +13,8 @@ TestDriver operates a full desktop environment, so it can run any application.
 | Application       | TestDriver | Playwright | Selenium |
 |:-----------------:|:---------:|:-----------:|:--------:|
 | Web Apps          | ✅            | ✅       | ✅       |
+| Mobile Apps       | ✅            | ✅       | ✅       |
+| VS Code           | ✅            | ✅       | ✅       |
 | Desktop Apps      | ✅            |          |         |
 | Chrome Extensions | ✅            |          |         |
 </div>
@@ -96,4 +98,4 @@ TestDriver currently supports Mac and Windows!
 | Windows  | ✅            | ✅       | ✅       |
 | Mac      | ✅            | ✅       | ✅       |
 | Linux    |               | ✅       | ✅       |
-</div>
+</div>

package/docs/overview/quickstart.mdx

@@ -6,53 +6,106 @@ icon: "gauge-high"
 mode: "wide"
 ---
 
-<Tip>
-  You will need a [TestDriver Pro](https://app.testdriver.ai/team) account
-  ($20/m) to complete setup.
-</Tip>
 
 <Steps>
-  <Step title="Install TestDriver">
-
-    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.
-
+  <Step title="Create a TestDriver Account">
+      
+  You will need a [TestDriver Pro](https://app.testdriver.ai/team) account ($20/month) to get an API key. 
+    
     <Card
-      horizontal
-      title="VS Code"
+      title="Sign Up for TestDriver"
+      icon="user-plus"
+      href="https://app.testdriver.ai/team"
       arrow
-      href="vscode:extension/testdriver.testdriver"
-      icon="/images/content/extension/vscode.svg"
+      horizontal
     ></Card>
 
-    <Card
-      horizontal
-      title="Cursor"
-      arrow
-    href="cursor:extension/testdriver.testdriver"
-    icon="/images/content/extension/cursor.svg"
+  </Step>
+  <Step title="Set up your environment">
+      
+    Copy your API key from [the TestDriver dashboard](https://app.testdriver.ai/team), and set it as an environment variable.
+    
+    <Tabs>
+      <Tab title="macOS / Linux">
+        ```bash Export an environment variable on macOS or Linux systems
+        export TD_API_KEY="your_api_key_here"
+        ```
+      </Tab>
+      <Tab title="Windows">
+      ```powershell Export an environment variable in PowerShell
+      setx TD_API_KEY "your_api_key_here"
+      ```
+      </Tab>
+    </Tabs>
+
+    <Tip>Using VS Code, Cursor, or Windsurf? [Try our VS Code Extension (beta)](/getting-started/vscode).</Tip>
 
-    > </Card>
+  </Step>
+  <Step title="Check out an example test">
+      
+    Download the TestDriver GitHub repository and run the example test.
 
-    <Card
-      horizontal
-      title="Windsurf"
-      arrow
-      href="windsurf:extension/testdriver.testdriver"
-      icon="/images/content/extension/windsurf.svg"
-    ></Card>
+    ```bash
+    git clone --depth 1 https://github.com/testdriverai/cli testdriverai
+    cd testdriverai/testdriver/acceptance
+    ```
 
-    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).
+    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.
+
+    ```yaml testdriver/acceptance/prompt.yaml
+    steps:
+      - prompt: log in
+      - prompt: add an item to the cart
+      - prompt: click on the cart icon
+      - prompt: complete checkout
+    ```
+
+    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.
 
   </Step>
-  <Step title="Run your tests in CI/CD">
+  <Step title="Generate regression test from prompts">
     
-    Next, use `testdriverai` to run your tests in CI/CD pipelines.
+    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.
 
     ```bash
-    TD_API_KEY=YOUR_KEY npx testdriverai@latest run testdriver/test.yaml
+    npx testdriverai@latest run prompt.yaml --write --heal
     ```
 
-    Note that you'll want to store your API key within secret storeage. [Learn more about running tests in CI/CD pipelines](/action/setup).
+    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.
+
+    <Tip>You can use an interactive CLI to generate test steps with the [explore command](/interactive/explore)</Tip>
+
+  </Step>
+  <Step title="Run the generated regression test">
+
+    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. 
+
+    ```yaml
+      version: 6.0.0
+      steps:
+        - prompt: focus chrome
+          commands:
+            - command: focus-application
+              name: Google Chrome
+        - prompt: enter a username
+          commands:
+            - command: hover-text
+              text: Username
+              description: username input field
+              action: click
+            - command: type
+              text: standard_user
+        - prompt: enter a password
+          commands:
+            - command: hover-text
+              text: Password
+              description: password input field
+              action: click
+            - command: type
+              text: secret_password
+      ```
+
+      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.
 
   </Step>
 

package/interfaces/readline.js

@@ -110,7 +110,7 @@ class ReadlineInterface {
 
     try {
       // Parse interactive commands (starting with /)
-      if (input.startsWith("/")) {
+      if (input.startsWith("/") && !input.startsWith("/explore")) {
         const parts = input.slice(1).split(" ");
         const commandName = parts[0];
         const args = parts.slice(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testdriverai",
-  "version": "6.0.26",
+  "version": "6.0.27-canary.062dddf.0",
   "description": "Next generation autonomous AI agent for end-to-end testing of web & desktop",
   "main": "index.js",
   "bin": {

package/schema.json

@@ -415,6 +415,9 @@
               "ai",
               "turbo"
             ]
+          },
+          "timeout": {
+            "type": "integer"
           }
         }
       },

package/testdriver/acceptance/hover-text.yaml

@@ -1,4 +1,4 @@
-version: 5.7.7
+version: 6.0.0
 session: 682f5aab811bd5a322c0e5a1
 steps:
   - prompt: click on sign in
@@ -9,5 +9,6 @@ steps:
         text: Sign In
         description: black button below the password field
         action: click
+        timeout: 5000
       - command: assert
         expect: an error shows that fields are required

package/testdriver/acceptance/prompt.yaml

@@ -1,7 +1,10 @@
 version: 6.0.0
 session: 6869c3e61445b2acbbdc0018
 steps:
-  - prompt: enter a valid username, password, and sign in
+  - prompt: log in
+  - prompt: add an item to the cart
+  - prompt: click on the cart icon
+  - prompt: complete checkout
   - prompt: assert
     commands:
       - command: assert

package/testdriver/lifecycle/provision.yaml

@@ -6,7 +6,7 @@ steps:
       - command: exec
         lang: pwsh
         code: |
-          Start-Process "C:\Program Files\Google\Chrome\Application\chrome.exe" -ArgumentList "--start-maximized --disable-infobars --disable-fre --no-default-browser-check --no-first-run --guest --load-extension=$(pwd)/node_modules/dashcam-chrome/build", "${TD_WEBSITE}"
+          Start-Process "C:\Program Files\Google\Chrome\Application\chrome.exe" -ArgumentList "--start-maximized --disable-infobars --disable-fre --no-default-browser-check --no-first-run --guest --load-extension=$(pwd)/node_modules/dashcam-chrome/build", "https://testdriver-sandbox.vercel.app/"
       - command: wait-for-text
         text: ${TD_WEBSITE}
         timeout: 60000