@testdriverai/agent 7.11.240-test → 7.11.241-test

package/ai/skills/testdriver-quickstart-github/SKILL.md

@@ -1,53 +1,83 @@
 ---
 name: testdriver:quickstart-github
-description: Drop-in UI tests for any GitHub repository.
+description: Get an AI code review on every pull request, backed by a real run of your app.
 ---
 <!-- 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.
+Install the TestDriver GitHub app, and the TestDriver agent reviews every pull request in your repository.
 
-<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>
+- It reads the diff for bugs.
+- When a user would see the change, it runs your app in a real sandbox to prove what it finds.
+- It writes and maintains end-to-end tests whenever you ask.
+
+There's nothing to install locally.
+
+## Before you begin
+
+- **A GitHub repository** where you can install apps (you own it, or you're an admin of its organization).
+- **A TestDriver account.** You create one or sign in during installation.
+- **A paid plan or trial for automatic reviews.** On the free plan, the agent still reviews a pull request when you @mention it. See [pricing](https://testdriver.ai/pricing).
 
 <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 title="Install the GitHub app">
+
+    Open [TestDriver on GitHub](https://go.testdriver.ai/github). Install the app on the repositories you want reviewed, and sign in to TestDriver when prompted.
+
+    You can add more repositories later from your GitHub settings.
+
+  </Step>
+  <Step title="Get your first tests">
+
+    Choose a repository to set up. TestDriver opens a **Set up TestDriver** issue in it.
+
+    The agent picks up the issue, writes a few sample tests for your app, and runs them. It opens a pull request with the tests and their recordings. Review it and merge it like any other pull request.
+
   </Step>
+  <Step title="Open a pull request">
 
-  <Step title="Mention @testdriverai">
-    Open a pull request or an issue and describe the test you want in a comment:
+    From now on, every pull request you open gets a review without anyone asking. The agent reads the change and runs it when there's something to drive.
+
+    It posts a single review comment with:
+
+    - A summary
+    - A walkthrough of the changed files
+    - Any bugs it found, each labelled `observed` (seen during a run) or `suspected` (inferred from the code)
+
+    Pushing new commits triggers a fresh review.
+
+    The review is a comment, so it never approves or blocks a merge. To fail a pull request when a test breaks, [run your tests in CI](/ci-cd).
+
+  </Step>
+  <Step title="Ask for more with @testdriverai">
+
+    Mention the agent on any issue or pull request to ask a follow-up question or request a new test:
 
     ```text
-    @testdriverai Write a test that verifies the homepage loads and the signup button works.
+    @testdriverai Write a test that logs in, adds the first product to the cart, and confirms the cart badge shows 1.
     ```
 
-    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.
+    The agent replies in the thread and posts screenshots as it works. When it's done, it opens a pull request with the test.
 
     <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`".
+      Describe what a user does and what they should see, not how the page is built. "Confirm the cart badge shows 1" works better than "check `#cart-count`".
     </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>
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="How the agent works" icon="hand-horns" href="/agent">
+    What the agent does on pull requests, issues, and mentions.
+  </Card>
+  <Card title="Prevent regressions" icon="shield-check" href="/copilot/auto-healing">
+    Run tests in CI and have the agent fix them when your app changes.
+  </Card>
+  <Card title="Run tests in CI/CD" icon="code-branch" href="/ci-cd">
+    Run your TestDriver tests in GitHub Actions.
+  </Card>
+  <Card title="Set up a project" icon="wrench" href="/quickstart-manual">
+    Write and run tests yourself in your own repository.
+  </Card>
+</CardGroup>

package/ai/skills/testdriver-quickstart-manual/SKILL.md

@@ -1,27 +1,48 @@
 ---
 name: testdriver:quickstart-manual
-description: Add TestDriver to an existing project by hand.
+description: Add TestDriver to your own project and run your first Vitest test.
 ---
 <!-- Generated from quickstart-manual.mdx. DO NOT EDIT. -->
 
-Add TestDriver to an existing project without the `init` scaffold. This is useful when you already have a Vitest setup or want full control over each file.
+Add TestDriver to a new or existing project, then run your first test.
+
+- **Fastest:** run `npx testdriverai init` and let it create every file for you.
+- **By hand:** follow the steps below to see exactly what each file does.
 
 <Tip>
-If you only want to drive TestDriver from chat, [MCP Setup](/mcp-setup) is a single URL with nothing to install.
+  Only want to drive TestDriver from chat? [MCP setup](/mcp-setup) needs one URL and nothing installed.
 </Tip>
 
+## Set up with init
+
+Run `init` in your project folder:
+
+```bash
+npx testdriverai init
+```
+
+It signs you in and saves your API key to `.env`. It then adds:
+
+- A `package.json`, if you don't have one
+- `vitest.config.js` with the TestDriver reporter
+- An example test in `tests/`
+- A GitHub Actions workflow
+- The TestDriver agent and MCP server for your AI client
+
+`init` keeps your existing `package.json`, Vitest config, tests, and workflow. It only adds to `.gitignore` and to MCP config files.
+
+Then run the example:
+
+```bash
+npx vitest run
+```
+
+## Set up by hand
+
 <Steps>
-  <Step title="Get an API key">
-
-    <Card
-      title="Get an API Key"
-      icon="user-plus"
-      href="https://console.testdriver.ai/settings"
-      arrow
-      horizontal
-    >
-      Start with 60 free device minutes, no credit card required.
-    </Card>
+  <Step title="Add your API key">
+
+    Create an API key at [console.testdriver.ai/team/api-keys](https://console.testdriver.ai/team/api-keys). The free plan includes 30 testing minutes and needs no credit card.
 
     Save the key in a `.env` file at your project root. The SDK loads it automatically:
 
@@ -29,7 +50,7 @@ If you only want to drive TestDriver from chat, [MCP Setup](/mcp-setup) is a sin
     TD_API_KEY=your_api_key
     ```
 
-    Add `.env` to `.gitignore` so the key is not committed.
+    Add `.env` to `.gitignore` so the key isn't committed.
 
   </Step>
   <Step title="Install dependencies">
@@ -40,14 +61,12 @@ If you only want to drive TestDriver from chat, [MCP Setup](/mcp-setup) is a sin
     npm install --save-dev vitest testdriverai
     ```
 
-    <Note>
-    TestDriver requires Node.js 20.19 or later and only runs on [Vitest](https://vitest.dev). Jest, Mocha, and other runners are not supported.
-    </Note>
+    TestDriver needs Node.js 20.19 or later. It only runs on [Vitest](https://vitest.dev), not Jest, Mocha, or other runners.
 
   </Step>
   <Step title="Configure Vitest">
 
-    Create `vitest.config.js` at your project root (or add these settings to an existing one):
+    Create `vitest.config.js` at your project root, or add these settings to your existing config:
 
     ```js vitest.config.js
     import { defineConfig } from 'vitest/config';
@@ -64,9 +83,9 @@ If you only want to drive TestDriver from chat, [MCP Setup](/mcp-setup) is a sin
     });
     ```
 
-    - `TestDriver()` reporter uploads results, recordings, and screenshots to the console.
-    - `setupFiles` registers the hooks that connect each test to a sandbox and clean it up.
-    - Without `hookTimeout`, cleanup fails at Vitest's default 10-second limit.
+    - **`TestDriver()`** is the reporter. It records each run in the TestDriver console, with its recording.
+    - **`setupFiles`** links your tests to the reporter, so each test's recording attaches to the run.
+    - **The timeouts** must be long. Vitest's defaults (5 seconds for tests, 10 for hooks) are too short for a real machine.
 
   </Step>
   <Step title="Write a test">
@@ -98,37 +117,45 @@ If you only want to drive TestDriver from chat, [MCP Setup](/mcp-setup) is a sin
     });
     ```
 
-    If your project does not have `"type": "module"` in `package.json`, name the file `search.test.mjs` instead.
+    If your `package.json` doesn't set `"type": "module"`, name the file `search.test.mjs` instead.
 
   </Step>
   <Step title="Run the test">
 
     ```bash
-    vitest run
+    npx vitest run
     ```
 
-    A sandbox starts, Chrome opens, and a live preview appears in your browser. When the run finishes, open the `TESTDRIVER_RUN_URL` printed at the end of the output to see the recording and step-by-step screenshots.
+    A sandbox starts, Chrome opens, and a live preview appears in your browser.
+
+    When the run finishes, open the `TESTDRIVER_RUN_URL` link at the end of the output. It shows the recording and each step.
 
   </Step>
 </Steps>
 
-## Optional: AI client setup
+## Connect an AI assistant
 
-If you want to write tests with an AI assistant, connect the TestDriver agent and MCP server. You can do this without re-scaffolding the project:
+To write tests with an AI assistant, add the TestDriver agent and MCP server to your project. `--no-sample-test` skips the example test files:
 
 ```bash
 npx testdriverai init --client cursor,claude-code,vscode --no-sample-test
 ```
 
-See [MCP Setup](/mcp-setup) for the configuration of each client.
+Your existing config and tests stay as they are. For Claude Code or VS Code, you can use the [plugin](/quickstart-claude) or [extension](/quickstart-vscode) instead.
 
 ## Next steps
 
 <CardGroup cols={2}>
-  <Card title="Walkthrough" icon="map" href="/provision" arrow horizontal>
-    Provision apps, locate elements, perform actions, and make assertions.
+  <Card title="Launch apps" icon="rocket" href="/provision">
+    Start Chrome, extensions, VS Code, or desktop apps.
+  </Card>
+  <Card title="Perform actions" icon="arrow-pointer" href="/performing-actions">
+    Click, type, scroll, and wait for a changing UI.
+  </Card>
+  <Card title="Make assertions" icon="circle-check" href="/making-assertions">
+    Check what's on screen in plain language.
   </Card>
-  <Card title="CI/CD" icon="github" href="/ci-cd" arrow horizontal>
-    Run tests on every pull request with GitHub Actions or another provider.
+  <Card title="Run in CI/CD" icon="code-branch" href="/ci-cd">
+    Run your tests on every pull request.
   </Card>
 </CardGroup>

package/ai/skills/testdriver-quickstart-vscode/SKILL.md

@@ -0,0 +1,96 @@
+---
+name: testdriver:quickstart-vscode
+description: Set up TestDriver in your editor and watch tests run in a live preview panel.
+---
+<!-- Generated from quickstart-vscode.mdx. DO NOT EDIT. -->
+
+Install the TestDriver extension, and your editor's AI assistant can write and run end-to-end tests. You watch the sandbox in a panel beside your code.
+
+The extension:
+
+- Signs you in.
+- Sets up your project and MCP server.
+- Opens the live preview automatically whenever a test runs.
+
+## Before you begin
+
+- **VS Code 1.85 or later with GitHub Copilot**, or **Cursor**.
+- **Node.js 20.19 or later**, which runs the MCP server and your tests.
+- **A workspace folder open** in the editor, since the extension sets up TestDriver in it.
+
+<Steps>
+  <Step title="Install the extension">
+
+    Install [TestDriver.ai from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=testdriver.testdriver), or search for **TestDriver.ai** in the Extensions view.
+
+    In Cursor, the extension may not appear in search. If so, download it with **Download Extension** on the Marketplace page. Then run **Extensions: Install from VSIX** from the Command Palette and choose the file.
+
+  </Step>
+  <Step title="Sign in">
+
+    Run **TestDriver: Sign In** from the Command Palette. It opens your browser, signs you in to TestDriver, and saves your API key in the editor.
+
+  </Step>
+  <Step title="Set up your project">
+
+    Run **TestDriver: Initialize Project**. It writes your API key to `.env` and runs `npx testdriverai init`, which installs the SDK and adds:
+
+    - An example test
+    - The TestDriver agent and skills
+    - A Vitest config
+    - A GitHub Actions workflow
+
+  </Step>
+  <Step title="Connect the MCP server">
+
+    Run **TestDriver: Install MCP Server** and choose where to save it: `.vscode/mcp.json` for VS Code or `.cursor/mcp.json` for Cursor.
+
+    If it asks whether to overwrite an existing TestDriver entry, choose **Yes**. This version of the config turns on the live preview panel.
+
+  </Step>
+  <Step title="Write your first test">
+
+    In VS Code, run **TestDriver: Chat with Agent**. It opens Copilot chat with the TestDriver agent and a sample prompt.
+
+    In Cursor, open the chat and ask:
+
+    ```text
+    Use TestDriver to write a test that logs in to https://testdriver-sandbox.vercel.app/login and adds an item to the cart.
+    ```
+
+    The live preview panel opens as the agent starts the sandbox. The agent writes the test under `tests/` as it goes.
+
+  </Step>
+</Steps>
+
+## Extension commands
+
+| Command | What it does |
+| --- | --- |
+| **TestDriver: Sign In** | Signs in through your browser and saves your API key |
+| **TestDriver: Set API Key** | Saves an API key you paste in instead |
+| **TestDriver: Initialize Project** | Runs `npx testdriverai init` in the workspace |
+| **TestDriver: Install MCP Server** | Adds the TestDriver MCP server to `.vscode/mcp.json` or `.cursor/mcp.json` |
+| **TestDriver: Chat with Agent** | Opens the TestDriver agent in Copilot chat (VS Code) |
+| **TestDriver: Turn into Repeatable Test** | Asks Copilot to turn your session into a test with a GitHub Actions workflow |
+| **TestDriver: Open Live Preview** / **Close Live Preview** | Opens or closes the sandbox preview panel |
+| **TestDriver: Open Getting Started** | Opens the extension's setup walkthrough |
+
+The preview panel opens automatically when a test starts. To turn that off, set `testdriverai.autoOpenPreview` to `false` in your settings.
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Generate tests with AI" icon="compass" href="/generating-tests">
+    Prompt the agent and steer it while it works.
+  </Card>
+  <Card title="Run tests" icon="play" href="/copilot/running-tests">
+    Run tests from the editor or the terminal.
+  </Card>
+  <Card title="Make assertions" icon="circle-check" href="/making-assertions">
+    Check what's on screen in plain language.
+  </Card>
+  <Card title="Run in CI/CD" icon="code-branch" href="/ci-cd">
+    Run your tests on every pull request.
+  </Card>
+</CardGroup>