Documentation

Installation

Install AssureMind and Playwright browsers via npm. Node.js 18+ is required.

# Install AssureMind
npm install assuremind

# Install Playwright browsers (Chromium is sufficient to start)
npx playwright install chromium

# Scaffold folders, config file, and example .env
npx assuremind init

Running init creates the following structure in your project root:

your-project/
├── autotest.config.ts   # Framework configuration
├── .env                 # AI provider keys (gitignored)
├── tests/               # Test suites (JSON)
│   ├── ui/
│   ├── api/
│   └── audit/
├── variables/           # Global & env variables
└── fixtures/uploads/    # Test file fixtures

Quick Start

1. Configure your AI provider

Add your provider credentials to .env in the project root. AssureMind supports 12 providers — pick one:

# Anthropic (Claude) — recommended
AI_PROVIDER=anthropic
ANTHROPIC_API_KEY=sk-ant-...

# OpenAI
AI_PROVIDER=openai
OPENAI_API_KEY=sk-...

# Ollama — local, completely free
AI_PROVIDER=ollama
OLLAMA_BASE_URL=http://localhost:11434
OLLAMA_MODEL=qwen2.5-coder:7b

2. Open the Studio

npx assuremind studio
# Opens http://localhost:4400 in your browser

3. Create a test suite

In the Studio, click Smart Tests → New Suite. Select the suite type (UI, API, or Audit), give it a name, and add your test steps in plain English.

4. Run your tests

# Run all suites
npx assuremind run --all

# Run with visible browser window
npx assuremind run --all --headed

Configuration

AssureMind is configured via autotest.config.ts in the project root. Use the exported defineConfig helper for type safety:

import { defineConfig } from 'assuremind';

export default defineConfig({
  baseUrl: 'http://localhost:3000',
  browsers: ['chromium'],
  headless: true,
  timeout: 30000,
  retries: 1,
  parallel: 2,
  healing: { enabled: true, maxLevel: 5 },
  mcp: { enabled: true },
  rag: { enabled: true },
});

Key options

UI Tests

UI tests automate a real browser using Playwright. Write steps in plain English — AssureMind generates the Playwright code for you.

Example steps

Navigate to /login
Enter "admin@example.com" in the Email field
Enter {{ADMIN_PASSWORD}} in the Password field
Click the "Sign In" button
Verify "Welcome back" is visible
Take a screenshot
Click the user avatar in the top-right corner
Select "Logout" from the dropdown menu

Test recording

Open the Studio → Test Editor → click Record. AssureMind launches a browser you interact with normally — every click and input becomes a test step automatically. Zero AI cost, works with iframes and shadow DOM.

API Tests

API test suites send HTTP requests and assert on responses — all described in plain English.

Example steps

Send GET to {{BASE_URL}}/api/health and verify status is 200
POST to {{BASE_URL}}/api/login with body:
  { "email": "{{ADMIN_EMAIL}}", "password": "{{ADMIN_PASSWORD}}" }
  Save token as AUTH_TOKEN
Verify response field "success" equals true
GET {{BASE_URL}}/api/users with header Authorization: Bearer {{AUTH_TOKEN}}
Verify the response array has at least 1 item

Audit Tests

Audit suites run Playwright to navigate your app, then attach a Lighthouse audit to measure performance, accessibility, and SEO scores at specific points in the user journey.

Example steps

Navigate to /
Wait for the page to fully load
Run Lighthouse audit on performance, accessibility, seo
Verify performance score is above 80
Verify accessibility score is above 90

Fake Data

Use {{FAKE_CATEGORY_METHOD}} tokens anywhere in a test step to inject fresh, random data on every run. No stale emails or duplicate records.

100+ generators across 16 categories: person, internet, phone, location, company, finance, date, lorem, image, hacker, music, vehicle, word, color, database, commerce. Browse them in the Studio under Faker Data.

Variables

Use {{VAR_NAME}} tokens in test steps. Variables are resolved at run time from three sources (in order of precedence):

1. Environment profile — variables/env.dev.json, variables/env.stage.json, etc.
2. Global variables — variables/global.json
3. Runtime captured values — set by steps like "save response token as AUTH_TOKEN"

// variables/global.json
{
  "ADMIN_EMAIL": "admin@example.com",
  "BASE_URL": "http://localhost:3000"
}

// variables/env.stage.json
{
  "BASE_URL": "https://stage.example.com"
}

Run with a specific environment: npx assuremind run --all --env stage

CLI Reference

AI Providers

Set AI_PROVIDER in .env to select the provider. Each provider also needs its corresponding API key or endpoint.

Self-Healing

When a selector fails, AssureMind cascades through up to 5 healing strategies automatically:

Healed selectors are saved as pending events. Review and accept them in the Studio under Self-Healing, or run npx assuremind apply-healing from the CLI. Once accepted, the updated code is written back to your test files — making the fix permanent.

Studio UI

Run npx assuremind studio to open the visual editor at http://localhost:4400. The Studio replaces the need for a terminal during test development.