@testdriverai/mcp 7.9.150-test → 7.9.152-test

package/docs/v7/copilot/setup.mdx

@@ -1,143 +0,0 @@
----
-title: "GitHub Copilot Setup"
-sidebarTitle: "IDE Setup"
-description: "Install the TestDriver extension and configure MCP for GitHub Copilot"
-icon: "wrench"
----
-
-TestDriver integrates with GitHub Copilot through the VS Code extension and MCP server. This guide walks you through the complete setup.
-
-## Prerequisites
-
-Before you begin, you'll need:
-
-- **GitHub Copilot** — A subscription with MCP access. A [free tier](https://github.com/features/copilot/plans) is available.
-- **TestDriver Account** — Create a free account at [console.testdriver.ai](https://console.testdriver.ai/team) to get your API key. 60 free device minutes, no credit card required.
-- **VS Code** — The TestDriver extension provides the best experience with live preview and integrated test running.
-
-## Setup Steps
-
-<Steps>
-  <Step title="Install the TestDriver Extension">
-    <Card
-      horizontal
-      title="Install TestDriver for VS Code"
-      arrow
-      href="vscode:extension/testdriver.testdriver"
-      icon="/images/content/extension/vscode.svg"
-    ></Card>
-
-    The extension provides:
-    - One-click sign-in and project initialization
-    - Live preview panel for watching tests execute
-    - MCP server configuration
-  </Step>
-
-  <Step title="Sign Into TestDriver">
-    Sign in to connect your account and API key.
-
-    1. Open the command palette (`Cmd+Shift+P` or `Ctrl+Shift+P`)
-    2. Run **TestDriver: Login**
-    3. Your browser will open to the TestDriver sign-in page
-    4. Sign in (or create an account)
-    5. You'll be redirected back to VS Code, now signed in
-
-    <Tip>
-      The extension automatically saves your API key to VS Code's secure storage and your workspace `.env` file.
-    </Tip>
-  </Step>
-
-  <Step title="Initialize Your Project">
-    Set up TestDriver in your project with a single command.
-
-    1. Open the command palette (`Cmd+Shift+P` or `Ctrl+Shift+P`)
-    2. Run **TestDriver: Init Project**
-
-    This command:
-    - Creates a `package.json` with TestDriver and Vitest dependencies
-    - Generates a `vitest.config.mjs` with proper timeout settings
-    - Creates example test files in `tests/`
-    - Sets up `.env` with your API key
-    - Creates the TestDriver agent file at `.github/agents/testdriver.agent.md`
-    - Configures the MCP server
-
-    <Note>
-      If you already have a `package.json`, the command will add the necessary dependencies to it.
-    </Note>
-  </Step>
-
-  <Step title="Start the MCP Server">
-    The MCP server enables GitHub Copilot to control TestDriver sandboxes.
-
-    After initialization, the MCP configuration is created at `.vscode/mcp.json`:
-
-    ```json .vscode/mcp.json
-    {
-      "servers": {
-        "testdriver": {
-          "command": "npx",
-          "args": ["-p", "testdriverai", "testdriverai-mcp"],
-          "env": {
-            "TD_PREVIEW": "ide",
-            "TD_API_KEY": "your-api-key"
-          }
-        }
-      }
-    }
-    ```
-
-    **To start the MCP server:**
-
-    1. Open the command palette (`Cmd+Shift+P` or `Ctrl+Shift+P`)
-    2. Run **MCP: List Servers**
-    3. Click on the **testdriver** server
-    4. Select **Start Server**
-
-    You can also click the MCP icon in the status bar to manage servers.
-
-    <Tip>
-      See the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details on managing MCP servers.
-    </Tip>
-
-    <Warning>
-      Make sure your API key is set. The extension uses the key from your sign-in, but you can also set it via the `TD_API_KEY` environment variable.
-    </Warning>
-  </Step>
-
-  <Step title="Install Vitest Extension (Recommended)">
-    For the best experience running tests, install the Vitest extension:
-
-    <Card
-      horizontal
-      title="Vitest Extension"
-      arrow
-      href="vscode:extension/vitest.explorer"
-      icon="flask-vial"
-    >
-      Run tests with GUI mode from the Test Explorer
-    </Card>
-
-    After installation, you'll see a beaker icon in the sidebar for accessing the Test Explorer.
-  </Step>
-</Steps>
-
-## Verify Your Setup
-
-To verify everything is configured correctly:
-
-1. Open the command palette and run **TestDriver: Check Status**
-2. You should see:
-   - ✅ Signed in
-   - ✅ MCP server configured
-   - ✅ Project initialized
-
-## The Agent File
-
-During initialization, TestDriver creates an agent file at `.github/agents/testdriver.agent.md`. This file tells GitHub Copilot how to use TestDriver's MCP tools.
-
-The agent has access to tools like:
-- `session_start` — Launch a sandbox with Chrome or other apps
-- `find` / `click` / `type` — Interact with elements on screen
-- `assert` — Verify conditions using AI vision
-- `screenshot` — Capture the current screen state
-

package/docs/v7/device-config.mdx

@@ -1,317 +0,0 @@
----
-title: "Configuring the Device"
-description: "Launch browsers, desktop apps, and extensions in your TestDriver sandbox"
-icon: "wrench"
----
-
-Provision methods are the starting point for most tests. They launch applications in your sandbox and prepare the environment for testing.
-
-## Chrome Browser
-
-The most common starting point for web testing. Launches Chrome browser and navigates to a URL.
-
-```javascript
-await testdriver.provision.chrome({
-  url: 'https://example.com',
-});
-```
-
-### Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `url` | string | `'http://testdriver-sandbox.vercel.app/'` | URL to navigate to |
-| `maximized` | boolean | `true` | Start browser maximized |
-| `guest` | boolean | `false` | Use guest mode (no profile) |
-
-### Example: Basic Web Test
-
-```javascript
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Login Flow", () => {
-  it("should log in successfully", async (context) => {
-    const testdriver = TestDriver(context);
-    
-    await testdriver.provision.chrome({
-      url: 'https://myapp.com/login',
-    });
-
-    await testdriver.find("Email input").click();
-    await testdriver.type("user@example.com");
-    
-    await testdriver.find("Password input").click();
-    await testdriver.type("password123");
-    
-    await testdriver.find("Sign In button").click();
-    
-    const result = await testdriver.assert("the dashboard is visible");
-    expect(result).toBeTruthy();
-  });
-});
-```
-
-<Info>
-  `provision.chrome()` automatically starts Dashcam recording and waits for Chrome to be ready before returning.
-</Info>
-
----
-
-## Chrome Extensions
-
-Launch Chrome with a custom extension loaded. Supports both local extensions and Chrome Web Store extensions.
-
-### Load from Local Path
-
-Clone or create an extension locally, then load it:
-
-```javascript
-// First, get the extension onto the sandbox
-await testdriver.exec(
-  'sh',
-  'git clone https://github.com/user/my-extension.git /tmp/my-extension',
-  60000
-);
-
-// Launch Chrome with the extension
-await testdriver.provision.chromeExtension({
-  extensionPath: '/tmp/my-extension',
-  url: 'https://example.com'
-});
-```
-
-### Load from Chrome Web Store
-
-Load any published extension by its Chrome Web Store ID:
-
-```javascript
-await testdriver.provision.chromeExtension({
-  extensionId: 'cjpalhdlnbpafiamejdnhcphjbkeiagm', // uBlock Origin
-  url: 'https://example.com'
-});
-```
-
-<Tip>
-  Find the extension ID in the Chrome Web Store URL. For example, `https://chrome.google.com/webstore/detail/ublock-origin/cjpalhdlnbpafiamejdnhcphjbkeiagm` → ID is `cjpalhdlnbpafiamejdnhcphjbkeiagm`
-</Tip>
-
-### Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `extensionPath` | string | - | Local path to unpacked extension directory |
-| `extensionId` | string | - | Chrome Web Store extension ID |
-| `url` | string | - | URL to navigate to after launch |
-| `maximized` | boolean | `true` | Start browser maximized |
-
-<Warning>
-  You must provide either `extensionPath` or `extensionId`, but not both.
-</Warning>
-
-### Example: Testing a Chrome Extension
-
-```javascript
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Chrome Extension Test", () => {
-  it("should load and interact with extension", async (context) => {
-    const testdriver = TestDriver(context);
-
-    // Clone extension from GitHub
-    await testdriver.exec(
-      'sh',
-      'git clone https://github.com/user/my-extension.git /tmp/my-extension',
-      60000,
-      true
-    );
-
-    // Launch Chrome with extension loaded
-    await testdriver.provision.chromeExtension({
-      extensionPath: '/tmp/my-extension',
-      url: 'https://testdriver.ai'
-    });
-
-    // Click extensions puzzle icon
-    const extensionsButton = await testdriver.find("puzzle-shaped icon in Chrome toolbar");
-    await extensionsButton.click();
-
-    // Interact with your extension
-    const myExtension = await testdriver.find("My Extension in the dropdown");
-    await myExtension.click();
-
-    const result = await testdriver.assert("extension popup is visible");
-    expect(result).toBeTruthy();
-  });
-});
-```
-
----
-
-## Desktop Apps
-
-Download and install desktop applications. Supports `.deb`, `.rpm`, `.msi`, `.exe`, `.AppImage`, `.dmg`, `.pkg`, and shell scripts.
-
-```javascript
-const filePath = await testdriver.provision.installer({
-  url: 'https://example.com/app.deb',
-  appName: 'MyApp',  // Focus this app after install
-  launch: true,      // Auto-launch after install
-});
-```
-
-### Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `url` | string | **required** | URL to download the installer from |
-| `filename` | string | auto-detected | Filename to save as |
-| `appName` | string | - | Application name to focus after install |
-| `launch` | boolean | `true` | Launch the app after installation |
-
-### Supported File Types
-
-| Extension | OS | Install Method |
-|-----------|-----|----------------|
-| `.deb` | Linux | `dpkg -i` + `apt-get install -f` |
-| `.rpm` | Linux | `rpm -i` |
-| `.AppImage` | Linux | `chmod +x` |
-| `.sh` | Linux | `chmod +x` + execute |
-| `.msi` | Windows | `msiexec /i /quiet` |
-| `.exe` | Windows | Silent install (`/S`) |
-| `.dmg` | macOS | Mount + copy to Applications |
-| `.pkg` | macOS | `installer -pkg` |
-
-### Example: Install and Test a Desktop App
-
-```javascript
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Desktop App Test", () => {
-  it("should install and launch app", async (context) => {
-    const testdriver = TestDriver(context);
-
-    // Download and install
-    const installerPath = await testdriver.provision.installer({
-      url: 'https://github.com/sharkdp/bat/releases/download/v0.24.0/bat_0.24.0_amd64.deb',
-    });
-
-    // Verify installation
-    const output = await testdriver.exec('sh', 'bat --version', 5000);
-    expect(output).toContain('bat');
-  });
-});
-```
-
-### Example: Windows Installer
-
-```javascript
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("Windows App Test", () => {
-  it("should install on Windows", async (context) => {
-    const testdriver = TestDriver(context, { 
-      os: 'windows'
-    });
-
-    // Download MSI installer
-    const installerPath = await testdriver.provision.installer({
-      url: 'https://example.com/app.msi',
-      launch: false,  // Don't auto-launch
-    });
-
-    // Custom installation if needed
-    await testdriver.exec(
-      'pwsh',
-      `Start-Process msiexec.exe -ArgumentList "/i", "${installerPath}", "/qn" -Wait`,
-      120000
-    );
-
-    // Verify installation
-    const result = await testdriver.assert("application is installed");
-    expect(result).toBeTruthy();
-  });
-});
-```
-
-### Manual Installation
-
-Set `launch: false` to download without auto-installing:
-
-```javascript
-const filePath = await testdriver.provision.installer({
-  url: 'https://example.com/custom-script.sh',
-  launch: false,
-});
-
-// Run custom install commands
-await testdriver.exec('sh', `chmod +x "${filePath}"`, 5000);
-await testdriver.exec('sh', `"${filePath}" --custom-flag`, 60000);
-```
-
----
-
-## VS Code
-
-Launch Visual Studio Code with optional workspace and extensions.
-
-```javascript
-await testdriver.provision.vscode({
-  workspace: '/home/testdriver/my-project',
-  extensions: ['ms-python.python', 'esbenp.prettier-vscode'],
-});
-```
-
-### Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `workspace` | string | - | Workspace folder to open |
-| `extensions` | string[] | `[]` | Extensions to install (by ID) |
-
-### Example: VS Code Extension Test
-
-```javascript
-import { describe, expect, it } from "vitest";
-import { TestDriver } from "testdriverai/vitest/hooks";
-
-describe("VS Code Test", () => {
-  it("should open workspace with extensions", async (context) => {
-    const testdriver = TestDriver(context);
-
-    // Create a test project
-    await testdriver.exec('sh', 'mkdir -p /tmp/test-project && echo "print(1)" > /tmp/test-project/test.py', 10000);
-
-    // Launch VS Code
-    await testdriver.provision.vscode({
-      workspace: '/tmp/test-project',
-      extensions: ['ms-python.python'],
-    });
-
-    // Verify VS Code is ready
-    const result = await testdriver.assert("VS Code is open with the project");
-    expect(result).toBeTruthy();
-
-    // Open the Python file
-    await testdriver.find("test.py in the explorer").click();
-  });
-});
-```
-
----
-
-## Choosing the Right Provision Method
-
-| Use Case | Method |
-|----------|--------|
-| Testing a website | `provision.chrome` |
-| Testing a Chrome extension | `provision.chromeExtension` |
-| Testing a desktop app (needs installation) | `provision.installer` |
-| Testing VS Code or VS Code extensions | `provision.vscode` |
-
-<Tip>
-  All provision methods automatically start Dashcam recording and wait for the application to be ready before returning. You don't need to call `dashcam.start()` manually.
-</Tip>

package/docs/v7/locating-elements.mdx

@@ -1,71 +0,0 @@
----
-title: "Locating Elements"
-description: "Find UI elements using natural language descriptions"
-icon: "crosshairs"
----
-
-## Locating Single Elements
-
-Use natural language to describe elements. Descriptions should be specific enough to locate the element, but not too-specific that they break with minor UI changes. For example:
-
-```javascript
-await testdriver.find('email input field');
-await testdriver.find('first product card in the grid');
-await testdriver.find('dropdown menu labeled "Country"');
-```
-
-<Info>TestDriver will cache found elements for improved performance on subsequent calls. Learn more about [element caching here](/v7/caching).</Info>
-
-## Debugging Found Elements
-
-After finding an element, you can inspect its properties for debugging:
-
-```javascript
-const button = await testdriver.find('submit button');
-console.log(button);
-```
-
-This outputs all element properties:
-
-```javascript
-{
-  description: 'submit button',
-  found: true,
-  x: 150,
-  y: 300,
-  coordinates: { x: 150, y: 300, centerX: 200, centerY: 320 },
-  threshold: 0.8,
-  confidence: 0.95,
-  similarity: 0.92,
-  selector: 'button[type="submit"]',
-  cache: {
-    hit: true,
-    strategy: 'pixel-diff',
-    createdAt: '2025-01-15T10:30:00Z',
-    diffPercent: 0.02,
-    imageUrl: 'https://...'
-  }
-}
-```
-
-## Working with Multiple Elements
-
-Find and interact with multiple elements:
-
-```javascript
-// Find all matching elements
-const products = await testdriver.findAll('product card');
-console.log(`Found ${products.length} products`);
-
-// Interact with each
-for (const product of products) {
-  const title = await product.find('title text');
-  console.log('Product:', title.text);
-
-  await product.find('add to cart button').click();
-}
-
-// Or find specific element
-const firstProduct = products[0];
-await firstProduct.click();
-```