Testdriver:Client logo

Testdriver:Client

Organization
testdriverai
testdriver:client

Initialize and configure the TestDriver SDK client

Overview

Publishertestdriverai
Repositorytestdriverai
Skill nametestdriver:client
Stars
465
Forks
39
Bundled files
Instructions only
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by testdriverai on GitHub. Read the source before you install it.

Installation

Install the Testdriver:Client AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/testdriverai/testdriverai/tree/main/ai/skills/testdriver:client
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Use it in TypingMind

Enable Testdriver:Client in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Testdriver:Client on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Testdriver:Client is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Overview

The TestDriver client is the main entry point for the SDK. It handles authentication, sandbox connection, and provides access to all testing methods.

Constructor

javascript
const testdriver = new TestDriver(apiKey, options)

Parameters

<ParamField path="resolution" type="string" default="1366x768">
  Screen resolution for the sandbox (e.g., `'1920x1080'`, `'1366x768'`)
</ParamField>

<ParamField path="apiRoot" type="string">
  API endpoint URL (typically only changed for self-hosted deployments)
</ParamField>

<ParamField path="analytics" type="boolean" default="true">
  Enable or disable usage analytics
</ParamField>

<ParamField path="logging" type="boolean" default="true">
  Enable or disable console logging
</ParamField>

<ParamField path="autoScreenshots" type="boolean" default="false">
  Automatically capture screenshots before and after each command. Screenshots are saved to `.testdriver/screenshots/<test>/` with descriptive filenames that include the line number and action name. Format: `<seq>-<action>-<phase>-L<line>-<description>.png`
</ParamField>

<ParamField path="newSandbox" type="boolean" default="true">
  Force creation of a new sandbox instead of reusing an existing one
</ParamField>

<ParamField path="reconnect" type="boolean" default="false">
  Reconnect to the last used sandbox instead of creating a new one. When `true`, provision methods (`chrome`, `vscode`, `installer`, etc.) will be skipped since the application is already running. Throws error if no previous sandbox exists.
</ParamField>

<ParamField path="preview" type="string" default="browser">
  Preview mode for live test visualization:
  - `"browser"` — Opens debugger in default browser (default)
  - `"ide"` — Opens preview in IDE panel (VSCode, Cursor - requires TestDriver extension)
  - `"none"` — Headless mode, no visual preview
</ParamField>

<ParamField path="headless" type="boolean" default="false">
  **Deprecated**: Use `preview: "none"` instead. Run in headless mode without opening the debugger.
</ParamField>

<ParamField path="debugOnFailure" type="boolean" default="false">
  Keep the sandbox alive when a test fails so you can reconnect and debug interactively. The sandbox ID is printed to the console.
</ParamField>

<ParamField path="ip" type="string">
  Direct IP address to connect to a running sandbox instance (for self-hosted deployments)
</ParamField>

<ParamField path="sandboxAmi" type="string">
  Custom AMI ID for the sandbox instance (AWS deployments, e.g., `'ami-1234'`)
</ParamField>

<ParamField path="sandboxInstance" type="string">
  EC2 instance type for the sandbox (AWS deployments, e.g., `'i3.metal'`)
</ParamField>

<ParamField path="cache" type="boolean | object" default="true">
  Enable or disable element caching, or provide advanced threshold configuration.
  
  <Expandable title="advanced config">
    <ParamField path="enabled" type="boolean" default="true">
      Enable or disable caching
    </ParamField>
    
    <ParamField path="thresholds" type="object">
      Fine-tune cache matching
      
      <Expandable title="properties">
        <ParamField path="find" type="object">
          Thresholds for `find()` operations
          
          <Expandable title="properties">
            <ParamField path="screen" type="number" default="0.05">
              Pixel diff threshold for screen comparison (0-1). `0.05` = 5% diff allowed.
            </ParamField>
            
            <ParamField path="element" type="number" default="0.8">
              OpenCV template match threshold for element matching (0-1). `0.8` = 80% correlation.
            </ParamField>
          </Expandable>
        </ParamField>
        
        <ParamField path="assert" type="number" default="0.05">
          Pixel diff threshold for `assert()` operations (0-1). `0.05` = 5% diff allowed.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="cacheKey" type="string">
  Cache key for element finding operations. If provided, enables caching tied to this key.
</ParamField>

<ParamField path="verify" type="boolean" default="false">
  Global default for AI verification of located elements. When `true`, every `find()` runs a second AI check to confirm the returned coordinates actually match the requested element (catching hallucinated or incorrect positions), at the cost of extra latency. Can be overridden per call via `find(description, { verify: true | false })`.
</ParamField>

<ParamField path="dashcam" type="boolean" default="true">
  Enable or disable Dashcam video recording
</ParamField>

<ParamField path="redraw" type="boolean | object" default="true">
  Enable or disable screen-change (redraw) detection, or provide advanced configuration.
  
  <Expandable title="advanced config">
    <ParamField path="enabled" type="boolean" default="true">
      Enable or disable redraw detection
    </ParamField>
    
    <ParamField path="thresholds" type="object">
      Threshold configuration
      
      <Expandable title="properties">
        <ParamField path="screen" type="number | false" default="0.05">
          Pixel diff threshold (0-1). Set to `false` to disable screen redraw detection.
        </ParamField>
        
        <ParamField path="network" type="boolean" default="false">
          Enable or disable network activity monitoring
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="environment" type="object">
  Additional environment variables to pass to the sandbox
</ParamField>

<ParamField path="ai" type="object">
  Global AI sampling configuration. Controls how the AI model generates responses for `find()` verification and `assert()` calls. Can be overridden per call.
  
  <Expandable title="properties">
    <ParamField path="temperature" type="number">
      Controls randomness in AI responses. `0` = deterministic (best for verification), higher values = more creative. Default: `0` for find verification, model default for assert.
    </ParamField>
    
    <ParamField path="top" type="object">
      Nucleus and top-k sampling parameters
      
      <Expandable title="properties">
        <ParamField path="p" type="number">
          Top-P (nucleus sampling). Limits token choices to the smallest set whose cumulative probability exceeds P. Lower values = more focused responses. Range: 0-1.
        </ParamField>
        
        <ParamField path="k" type="number">
          Top-K sampling. Limits token choices to the top K most likely tokens. `1` = always pick the most likely token. `0` = disabled (consider all tokens).
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

Example

javascript
import TestDriver from 'testdriverai';

// API key is automatically loaded from TD_API_KEY in .env
const testdriver = new TestDriver({
  os: 'windows',
  resolution: '1920x1080',
  logging: true,
  analytics: true
});

// With AI config for stricter verification
const testdriver = new TestDriver({
  ai: { temperature: 0, top: { p: 0.9, k: 40 } }
});

// Or pass API key explicitly
const testdriver = new TestDriver('your-api-key', {
  os: 'windows'
});

Authentication

auth()

Authenticate with the TestDriver API.

javascript
await testdriver.auth()

Returns: Promise<string> - Authentication token

Example:

javascript
await testdriver.auth();

Connection Management

connect()

Connect to a sandbox environment. This creates or reconnects to a virtual machine where your tests will run.

javascript
await testdriver.connect(options)
Parameters
<ParamField path="sandboxId" type="string">
  Existing sandbox ID to reconnect to
</ParamField>

<ParamField path="ip" type="string">
  Direct IP address to connect to (for self-hosted sandboxes)
</ParamField>

<ParamField path="sandboxAmi" type="string">
  AMI to use for the sandbox (AWS deployments)
</ParamField>

<ParamField path="sandboxInstance" type="string">
  Instance type for the sandbox (AWS deployments)
</ParamField>

<ParamField path="preview" type="string" default="browser">
  Preview mode for live test visualization:
  - `"browser"` - Opens debugger in default browser (default)
  - `"ide"` - Opens preview in IDE panel (VSCode, Cursor - requires TestDriver extension)
  - `"none"` - Headless mode, no visual preview
</ParamField>

<ParamField path="headless" type="boolean" default="false">
  **Deprecated**: Use `preview: "none"` instead. Run in headless mode without opening the debugger.
</ParamField>

<ParamField path="keepAlive" type="number" default="60000">
  Keep sandbox alive for the specified number of milliseconds after disconnect. Set to `0` to terminate immediately on disconnect. Useful for debugging or reconnecting to the same sandbox.
</ParamField>

Returns: Promise&lt;Object&gt; - Sandbox instance details including instanceId, ip, vncPort, etc.

Examples

Basic connection:

javascript
await testdriver.connect();

Reconnect to existing sandbox:

javascript
const instance = await testdriver.connect({ 
  sandboxId: 'existing-sandbox-id-123' 
});

Self-hosted sandbox:

javascript
await testdriver.connect({ 
  ip: '192.168.1.100'
});

disconnect()

Disconnect from the sandbox and clean up resources.

javascript
await testdriver.disconnect()

Returns: Promise<void>

Example:

javascript
afterAll(async () => {
  await testdriver.disconnect();
});

Instance Information

getInstance()

Get the current sandbox instance details.

javascript
const instance = testdriver.getInstance()

Returns: Object | null - Sandbox instance information

Example:

javascript
const instance = testdriver.getInstance();
console.log('Instance ID:', instance.instanceId);
console.log('IP Address:', instance.ip);

getSessionId()

Get the current session ID for tracking and debugging.

javascript
const sessionId = testdriver.getSessionId()

Returns: string | null - Session ID

Example:

javascript
const sessionId = testdriver.getSessionId();
console.log('Session:', sessionId);

Logging & Events

setLogging()

Enable or disable console logging at runtime.

javascript
testdriver.setLogging(enabled)

Parameters:

  • enabled (boolean) - Whether to enable logging

Example:

javascript
// Disable logging for cleanup operations
testdriver.setLogging(false);
await testdriver.disconnect();
testdriver.setLogging(true);

getEmitter()

Get the event emitter for custom event handling.

javascript
const emitter = testdriver.getEmitter()

Returns: EventEmitter2 - Event emitter instance

Example:

javascript
const emitter = testdriver.getEmitter();

emitter.on('command:start', (data) => {
  console.log('Command started:', data);
});

emitter.on('command:success', (data) => {
  console.log('Command succeeded:', data);
});

emitter.on('command:error', (error) => {
  console.error('Command failed:', error);
});

Complete Example

javascript
import { beforeAll, afterAll, describe, it } from 'vitest';
import TestDriver from 'testdriverai';

describe('My Test Suite', () => {
  let testdriver;

  beforeAll(async () => {
    // Initialize client - API key loaded automatically from .env
    testdriver = new TestDriver({
      os: 'windows',
      resolution: '1366x768',
      logging: true
    });
    
    // Set up event listeners
    const emitter = testdriver.getEmitter();
    emitter.on('log:info', (msg) => console.log('[INFO]', msg));
    
    // Authenticate and connect
    await testdriver.auth();
    const instance = await testdriver.connect();
    
    console.log('Connected to sandbox:', instance.instanceId);
  });

  afterAll(async () => {
    await testdriver.disconnect();
  });

  it('runs a test', async () => {
    // Your test code here
  });
});

Best Practices

```javascript
try {
  await testdriver.connect();
} catch (error) {
  console.error('Failed to connect:', error.message);
  throw error;
}
```
```bash .env
TD_API_KEY=your_api_key_here
```

```javascript
// API key is loaded automatically - no need to pass it!
const testdriver = new TestDriver();
```

Frequently asked questions

What does the Testdriver:Client AI skill do?

Initialize and configure the TestDriver SDK client

Why use Testdriver:Client on TypingMind?

Because you install it once and use it with any model. Testdriver:Client is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Testdriver:Client in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/testdriverai/testdriverai/tree/main/ai/skills/testdriver:client. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Testdriver:Client?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Testdriver:Client?

As many as you like. As long as a model supports skills, you can use Testdriver:Client with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Testdriver:Client AI skill free?

It is published on GitHub by testdriverai. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇