testdriverai 7.8.0-test.0 → 7.8.0-test.10

package/docs/v7/copilot/github.mdx

@@ -0,0 +1,143 @@
+---
+title: "GitHub Integration"
+sidebarTitle: "GitHub"
+description: "Use TestDriver from GitHub's web interface and mobile app"
+icon: "github"
+---
+
+TestDriver works directly in GitHub's web interface and mobile app. The same MCP server that powers VS Code integration also works in GitHub, letting you create and manage tests from anywhere.
+
+## How It Works
+
+When you add a TestDriver agent file to your repository at `.github/agents/testdriver.agent.md`, GitHub Copilot can use TestDriver's MCP tools directly in:
+
+- GitHub.com (web browser)
+- GitHub Mobile app (iOS/Android)
+- Pull request conversations
+- Issue comments
+
+## Using TestDriver in GitHub Web
+
+<Steps>
+  <Step title="Navigate to Your Repository">
+    Open your repository on GitHub.com. Make sure you have the TestDriver agent file at `.github/agents/testdriver.agent.md`.
+  </Step>
+
+  <Step title="Start a Copilot Chat">
+    Click the **Copilot icon** in the GitHub interface to open a chat. You can find this in:
+    - The repository's Code tab
+    - Pull request pages
+    - Issue pages
+  </Step>
+
+  <Step title="Invoke the TestDriver Agent">
+    Start your message with `@testdriver`:
+
+    ```
+    @testdriver Create a test that verifies the homepage loads correctly at https://myapp.com
+    ```
+
+    The agent will spawn a sandbox environment and begin executing, just like in VS Code.
+  </Step>
+
+  <Step title="View Screenshots in Chat">
+    As the test runs, screenshots appear directly in the chat. You can see what the AI sees and provide guidance if needed.
+  </Step>
+</Steps>
+
+## Creating Tests from PR Comments
+
+You can create tests directly from pull request reviews. Comment on a PR and mention Copilot:
+
+```
+@copilot create a TestDriver test that verifies this new feature works.
+Test the checkout flow with a guest user.
+```
+
+Copilot will:
+1. Use the TestDriver MCP server
+2. Create a test based on your description
+3. Commit the test file to the PR branch
+
+This is useful for:
+- Adding test coverage during code review
+- Verifying bug fixes before merging
+- Creating regression tests for new features
+
+## Creating Tests from Issues
+
+You can also create tests from issue comments:
+
+```
+@copilot Use TestDriver to create a test that reproduces this bug.
+Navigate to /settings, change the theme, and verify it persists after refresh.
+```
+
+The test will be created in a new branch and linked to the issue.
+
+## Mobile App Support
+
+The GitHub Mobile app supports Copilot chat, which means you can use TestDriver from your phone:
+
+1. Open the GitHub app
+2. Navigate to your repository
+3. Tap the Copilot icon
+4. Type `@testdriver` followed by your request
+
+Screenshots and test progress appear in the chat, letting you create and debug tests on the go.
+
+## Example: PR Review Workflow
+
+Here's a complete workflow for adding tests during code review:
+
+<Steps>
+  <Step title="Developer Opens PR">
+    A developer opens a pull request with a new feature.
+  </Step>
+
+  <Step title="Reviewer Requests Tests">
+    The reviewer comments:
+    ```
+    @copilot Create a TestDriver test for this user registration flow.
+    Test both successful registration and validation errors.
+    ```
+  </Step>
+
+  <Step title="Copilot Creates Tests">
+    Copilot spawns TestDriver, creates the tests, and commits them to the PR branch.
+  </Step>
+
+  <Step title="Tests Run in CI">
+    The new tests run automatically in CI, validating the feature works as expected.
+  </Step>
+</Steps>
+
+## Agent File Reference
+
+The agent file at `.github/agents/testdriver.agent.md` contains the configuration for GitHub Copilot to use TestDriver. Here's the structure:
+
+```yaml
+---
+name: testdriver
+description: An expert at creating and refining automated tests using TestDriver.ai
+mcp-servers:
+  testdriver:
+    command: npx
+    args:
+      - -p
+      - testdriverai
+      - testdriverai-mcp
+    env:
+      TD_API_KEY: ${TD_API_KEY}
+---
+
+# TestDriver Expert
+
+You are an expert at writing automated tests using TestDriver...
+```
+
+The `TD_API_KEY` is pulled from your repository secrets when running in GitHub Actions or from your environment when using the web interface.
+
+<Warning>
+  Make sure `TD_API_KEY` is set in your repository secrets for CI workflows. Go to **Settings → Secrets and variables → Actions** to add it.
+</Warning>

package/docs/v7/copilot/running-tests.mdx

@@ -0,0 +1,149 @@
+---
+title: "Running Tests"
+sidebarTitle: "Running Tests"
+description: "Re-run tests with Vitest and use GUI mode for visual debugging"
+icon: "play"
+---
+
+After creating tests with the TestDriver agent, you can re-run them without starting a new MCP session. Tests are saved as standard Vitest files that run independently.
+
+## Running from VS Code (GUI Mode)
+
+For a visual testing experience, use the **Vitest extension**:
+
+<Steps>
+  <Step title="Open Test Explorer">
+    Click the **beaker icon** in the VS Code sidebar to open the Test Explorer. This shows all your test files and test cases.
+  </Step>
+
+  <Step title="Run Tests">
+    Click the **play button** next to any test file or individual test to run it. You can also:
+    - Run all tests with the "Run All" button
+    - Debug tests with the "Debug" button
+  </Step>
+
+  <Step title="View Results">
+    Test results appear inline:
+    - ✅ Green checkmark for passing tests
+    - ❌ Red X for failing tests
+    - Click on a failing test to see error details
+  </Step>
+</Steps>
+
+<Warning>
+  VS Code's Test Explorer only shows output for **failing tests**. To see output from passing tests (including screenshots and console logs), run tests from the terminal instead.
+</Warning>
+
+## Running from Terminal
+
+Use Vitest to run your tests from the command line to see full output:
+
+```bash
+# Run all tests
+vitest run
+
+# Run a specific test file
+vitest run tests/login.test.mjs
+
+# Run in watch mode (re-runs on file changes)
+vitest
+```
+
+See the [running tests guide](/v7/running-tests) for more CLI options and configuration.
+
+## Iterating on Tests
+
+When tests fail or need updates, you have two options:
+
+### Option 1: Ask the MCP Agent (Recommended)
+
+For discovering updated element descriptions or debugging failures, chat with the TestDriver agent:
+
+```
+The login test is failing because the form layout changed.
+Update tests/login.test.mjs to work with the new design.
+```
+
+The agent will:
+1. Start a new session
+2. Navigate to the page
+3. Analyze the current state
+4. Update the test code
+
+This is the best approach when:
+- Element text or layout has changed
+- You need to see what's currently on screen
+- The failure reason isn't obvious from the error message
+
+### Option 2: Edit the Code Directly
+
+For simple changes, edit the test files directly:
+
+```javascript
+// Change the element description
+const button = await testdriver.find("Submit Order button");
+
+// Add a wait
+await testdriver.wait(2000);
+
+// Update assertions
+const result = await testdriver.assert("order confirmation shows order ID");
+```
+
+This is faster for:
+- Updating text strings
+- Adjusting timeouts
+- Fixing typos
+
+## Test Configuration
+
+### Timeouts
+
+TestDriver tests require longer timeouts than typical unit tests. Your `vitest.config.mjs` should have:
+
+```javascript vitest.config.mjs
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    testTimeout: 900000,  // 15 minutes
+    hookTimeout: 900000,  // 15 minutes for setup/teardown
+  },
+});
+```
+
+### Environment Variables
+
+Tests use the `TD_API_KEY` environment variable. Set it in your `.env` file:
+
+```env .env
+TD_API_KEY=your-api-key-here
+```
+
+Or pass it when running tests:
+
+```bash
+TD_API_KEY=your-key vitest run
+```
+
+## Viewing Test Reports
+
+After each test run, TestDriver provides a link to the full test report:
+
+```
+TESTDRIVER_RUN_URL=https://console.testdriver.ai/runs/abc123
+```
+
+The report includes:
+- Video recording of the test
+- Screenshots at each step
+- Network logs and performance metrics
+- Console output and errors
+
+<Card
+  title="View Test Reports"
+  icon="chart-line"
+  href="https://console.testdriver.ai"
+>
+  Access all your test runs and recordings in the TestDriver console
+</Card>

package/docs/v7/copilot/setup.mdx

@@ -0,0 +1,143 @@
+---
+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/enterprise.mdx

@@ -1,116 +1,9 @@
 ---
 title: "Enterprise"
 sidebarTitle: "Enterprise"
-description: "Air-gapped security and full customization for demanding environments"
+description: "Self-hosted enterprise deployments with assisted setup and dedicated support"
 icon: "building"
+redirect: "/v7/self-hosted"
 ---
 
-
-## Why Enterprise?
-
-<CardGroup cols={2}>
-  <Card title="Air-Gapped Security" icon="shield-check">
-    Deploy everything in your environment. No data leaves your network. Complete isolation from external services.
-  </Card>
-  <Card title="Full Customization" icon="gear">
-    Custom integrations, dedicated infrastructure, and tailored solutions for your unique requirements.
-  </Card>
-  <Card title="Self-Hosted Dashboard & API" icon="server">
-    Run the entire TestDriver stack — dashboard, API, and test infrastructure — within your own environment.
-  </Card>
-  <Card title="Dedicated Support" icon="headset">
-    Direct access to our engineering team for implementation, customization, and ongoing support.
-  </Card>
-</CardGroup>
-
-## Who Needs Enterprise?
-
-Enterprise is designed for organizations that:
-
-- **Require air-gapped deployments** — Regulated industries, government, defense, or strict compliance requirements
-- **Cannot use external APIs** — Data must never leave your network perimeter
-- **Need custom integrations** — Unique CI/CD systems, internal tools, or specialized workflows
-- **Want dedicated support** — Direct engineering support for complex implementations
-
-## What's Included
-
-### Fully Self-Hosted Stack
-
-Unlike [Self-Hosted](/v7/self-hosted) (which uses TestDriver's hosted dashboard and API), Enterprise deploys everything in your environment:
-
-| Component | Self-Hosted | Enterprise |
-|-----------|-------------|------------|
-| Test Sandboxes | Your infrastructure | Your infrastructure |
-| Dashboard | TestDriver hosted | Your infrastructure |
-| API | TestDriver hosted | Your infrastructure |
-| AI Processing | Your API keys | Your infrastructure |
-| Data Storage | Your AWS account | Your infrastructure |
-
-### Custom Contract Terms
-
-- Volume-based pricing
-- Custom SLAs
-- Dedicated support channels
-- Professional services for implementation
-- Training for your team
-
-## Implementation Process
-
-<Steps>
-  <Step title="Discovery Call">
-    Discuss your requirements, security constraints, and integration needs with our team.
-  </Step>
-  
-  <Step title="Architecture Review">
-    Our engineers design a deployment architecture that meets your security and compliance requirements.
-  </Step>
-  
-  <Step title="Deployment">
-    We work with your team to deploy TestDriver within your environment, including dashboard, API, and test infrastructure.
-  </Step>
-  
-  <Step title="Integration">
-    Connect TestDriver to your CI/CD pipelines, internal tools, and workflows.
-  </Step>
-  
-  <Step title="Training & Handoff">
-    Comprehensive training for your team on operating and maintaining the deployment.
-  </Step>
-</Steps>
-
-## Security & Compliance
-
-Enterprise deployments support:
-
-- **SOC 2** compliance requirements
-- **HIPAA** for healthcare applications
-- **FedRAMP** for government deployments
-- **PCI DSS** for payment processing
-- **Custom compliance frameworks** as needed
-
-<Note>
-  All data remains within your network perimeter. TestDriver has no access to your test results, application data, or infrastructure.
-</Note>
-
-## Comparison: Self-Hosted vs Enterprise
-
-| Feature | Self-Hosted | Enterprise |
-|---------|-------------|------------|
-| **Test Infrastructure** | Your AWS | Your infrastructure (any) |
-| **Dashboard** | TestDriver cloud | Your infrastructure |
-| **API** | TestDriver cloud | Your infrastructure |
-| **Data Location** | Your AWS + TestDriver | 100% your infrastructure |
-| **Network Requirements** | Internet access | Can be fully air-gapped |
-| **Cloud Providers** | AWS only | Any (AWS, Azure, GCP, on-prem) |
-| **Support** | Standard | Dedicated engineering |
-| **Contract** | Standard licensing | Custom terms |
-
-## Get Started
-
-<Card
-  title="Schedule a Consultation"
-  icon="calendar"
-  href="https://calendly.com/d/cq23-qyn-3v6/testdriver-ai-demo"
->
-  Discuss your requirements with our team and get a custom proposal for your Enterprise deployment.
-</Card>
+This page has moved to [Self-Hosted](/v7/self-hosted).

package/docs/v7/{cloud.mdx → hosted.mdx}

@@ -1,18 +1,56 @@
 ---
-title: "Cloud Plan"
-sidebarTitle: "Cloud"
+title: "Hosted"
+sidebarTitle: "Hosted"
 description: "The fastest way to get started with TestDriver. Just set your API key and start testing."
 icon: "cloud"
+mode: "wide"
 ---
 
-Cloud pricing is based on **device-seconds**: the amount of time your tests run on **our infrastructure**.
+Hosted pricing is based on **device-seconds**: the amount of time your tests run on **our infrastructure**.
 
 - **Zero Setup** — Start testing immediately. No DevOps required.
 - **Free Tier** — Get started with a limited preview at no cost.
 - **Pay As You Go** — Only pay for the device-seconds you use.
 
+## Hosted Plans
+
+<CardGroup cols={3}>
+  <Card title="Free Trial" icon="gift" href="https://docs.testdriver.ai">
+    **$0/month**
+    
+    - 1 Concurrent Sandbox
+    - 60 Minutes Included
+    - 1 Team User
+    - Community Support
+  </Card>
+  
+  <Card title="Pro" icon="rocket" href="https://console.testdriver.ai/checkout/pro">
+    **$20/month**
+    
+    - 2 Concurrent Sandboxes
+    - 600 Minutes Included
+    - Overage: $0.002/second
+    - 1 Team User
+    - Test Recordings
+    - Community Support
+  </Card>
+  
+  <Card title="Team" icon="users" href="https://console.testdriver.ai/checkout/team">
+    **$600/month**
+    
+    - 8 Concurrent Sandboxes
+    - 10,000 Minutes Included
+    - Overage: $0.001/second
+    - 5 Team Users
+    - Test Recordings
+    - Private Support
+    - Test Analytics
+    - CPU, RAM, & Network Profiles
+  </Card>
+</CardGroup>
+
 ## Get Started
-Cloud is the default when you follow the Quickstart guide. 
+Hosted is the default when you follow the Quickstart guide. 
 <Card
   title="Try the Quickstart"  
   icon="play"
@@ -102,7 +140,7 @@ To prevent tests from failing due to exceeding your license slot limit, we recom
 
 ## When to Consider Self-Hosted
 
-Cloud is perfect for getting started and for teams that want zero infrastructure management. However, you might consider [Self-Hosted](/v7/self-hosted) if you:
+Hosted is perfect for getting started and for teams that want zero infrastructure management. However, you might consider [Self-Hosted](/v7/self-hosted) if you:
 
 - Want to escape per-second billing with a flat license fee
 - Require greater concurrency than offered in Cloud plans

package/docs/v7/mcp.mdx

@@ -0,0 +1,9 @@
+---
+title: "GitHub Copilot Guide"
+sidebarTitle: "GitHub Copilot Guide"
+description: "Execute natural language tasks using AI"
+icon: "github"
+---
+
+## Overview
+

package/docs/v7/quickstart.mdx

@@ -10,7 +10,7 @@ TestDriver makes it easy to write automated computer-use tests for web browsers,
 <Tip><a href="https://discord.com/invite/cWDFW8DzPm" target="_blank" rel="noreferrer">Join our Discord</a> if you have any questions or need help getting started!</Tip>
 
 <Tabs>
-  <Tab title="Automatic Setup">
+  <Tab title="CLI" icon="terminal">
 
     Get started quickly with the TestDriver CLI.
 
@@ -40,7 +40,35 @@ TestDriver makes it easy to write automated computer-use tests for web browsers,
       </Step>
     </Steps>
   </Tab>
-  <Tab title="Manual Setup">
+  <Tab title="GitHub Copilot" icon="github">
+
+    Use the TestDriver VS Code extension with GitHub Copilot for an AI-powered testing workflow.
+
+    <Card
+      title="Install TestDriver for VS Code"
+      icon="/images/content/extension/vscode.svg"
+      href="vscode:extension/testdriver.testdriver"
+      arrow
+      horizontal
+    >
+    </Card>
+
+    The extension provides one-click sign-in, project initialization, a live preview panel for watching tests execute, and MCP server configuration for GitHub Copilot.
+
+    Once installed, follow the full setup guide to configure MCP and start building tests with AI assistance:
+
+    <Card
+      title="VS Code + Copilot Setup Guide"
+      icon="arrow-right"
+      href="/v7/copilot/setup"
+      arrow
+      horizontal
+    >
+      Sign in, initialize your project, and configure MCP for GitHub Copilot.
+    </Card>
+
+  </Tab>
+  <Tab title="Manual" icon="wrench">
 
     Install TestDriver and manually create the files yourself.
 

package/docs/v7/running-tests.mdx

@@ -133,7 +133,7 @@ export default defineConfig({
 <Card
   title="View Plans & Pricing"
   icon="credit-card"
-  href="/v7/cloud"
+  href="/v7/hosted"
 >
   Compare plans and find the right level of parallelization for your team.
 </Card>