Documentation

Everything you need to get started

Quick start

1. Create a project

Add your staging URL. No SDK, no code changes needed.

2. Define flows

Three ways to create flows: AI Generate (crawls your site and suggests flows with real selectors), Import Playwright (paste a .spec.ts file), or Create Manually (step by step).

3. Run tests

Click "Run Tests" to run all flows, or the Play button on a single flow. Tests execute in a real Chromium browser against your staging environment.

4. Review results

View screenshots, traces, classified failures, baseline comparison, and AI-powered error explanations.

Flow types

Each flow is a sequence of steps. Available step types:

  • navigate — go to a URL
  • click — click an element by selector
  • fill — type text into an input
  • assert — verify an element exists on the page
  • api — make an HTTP request (for setup, auth, cleanup, or status assertions). Shares cookies with the browser session.

Each step supports optional timeout (custom wait time) and wait after (pause after execution).

Testing authenticated flows

Many critical flows (dashboard, settings, checkout) require a logged-in user. Use an API step as the first step in your flow to log in via your app's API. Cookies are shared with the browser, so subsequent steps run as an authenticated user.

Example: test the dashboard behind login

Step 1  api       POST /api/auth/login
                   Headers: {"Content-Type": "application/json"}
                   Body:    {"email": "[email protected]", "password": "testpass123"}
                   Assert:  status:200

Step 2  navigate  /dashboard
Step 3  assert    h1:has-text("Welcome")
Step 4  click     a:has-text("Settings")
Step 5  assert    form.settings-form

The API step makes a real HTTP request using Playwright's request context. The session cookie from the login response is automatically used by all following browser steps — no manual cookie handling needed.

Tip: create a dedicated test user in your staging environment so tests don't interfere with real data.

AI features

  • AI Generate — crawls your real site, extracts DOM elements, and suggests 3-6 flows with working CSS selectors
  • Natural language flows — type what to test (e.g. "check footer links") and AI creates a single flow by crawling your site
  • Explain with AI — click on any failed step to get an AI explanation of the root cause and what to fix
  • Smart locator healing — when a selector breaks, AI analyzes the page and suggests a better selector
  • Flaky detection — automatically identifies steps that pass sometimes and fail others, with severity badges on flow cards

Scheduled runs

Set up automatic regression runs on a schedule:

  • Daily — runs every day at your chosen time
  • Weekly — runs on a specific day and time

Configure in the project page under Schedule. Times are in your local timezone.

CI/CD integration

Trigger runs from your deployment pipeline using your API key:

curl -X POST https://regresco.com/api/webhook/trigger \
     -H "x-api-key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"projectId": "your-project-id"}'

Generate your API key in Settings → API Keys. See Settings → Webhook Config for full examples (GitHub Actions, GitLab CI, Vercel, bash).

Failure classification

Every failed step is automatically classified:

  • Likely regression — the page loaded but behavior changed from the baseline
  • Broken locator — the element wasn't found, likely due to a UI change
  • Flaky — intermittent failure, not consistently reproducible

Failed steps are automatically retried once before being marked as failed. Failing elements are highlighted with a red outline in screenshots.

Baseline comparison

Each run is automatically compared to the previous completed run:

  • New failures — steps that passed before but now fail
  • Fixed — steps that were failing but now pass
  • Still failing — steps that continue to fail

Artifacts

Every run produces:

  • Screenshots — captured after navigate, click, and fill steps (JPEG, ~100-200KB each)
  • Playwright traces — replay locally with npx playwright show-trace trace.zip
  • Flow history — stability trend per flow across runs

Email notifications

Get notified when runs complete. Emails include status, passed/failed count, and a link to the run dashboard.

Toggle on/off in Settings → Profile → Notifications.

Reliability features

  • Auto cookie banner dismissal — automatically closes common consent popups
  • Scroll into view — elements below the fold are scrolled into view before interaction
  • Adaptive timeouts — timeout adjusts based on page load speed (3x first navigate time)
  • Retry on failure — transient failures are retried once before marking as failed
  • Parallel execution — up to 3 flows run concurrently per test run
  • Click fallback — hidden elements (dropdown items) are clicked with force as fallback

Need help?

Reach out at [email protected]