Documentation
Getting Started

Quick Start Guide

First project scanned and first tests running in about five minutes. Covers free scan, auto-scan on project creation, multi-browser runs, and self-healing tests.

Quick Start Guide

Welcome to AegisRunner. You'll have your first project scanned and your first tests running in about five minutes.

What AegisRunner does

You give AegisRunner the URL of your web app. It opens the site in a real browser, walks through pages and forms the way a user would, and writes a test suite for what it finds. You can then run those tests on Chromium, Firefox, or WebKit, on a schedule, or from CI. When a test breaks because something on the page moved or got renamed, AegisRunner tries to repair the test on its own.

🔍
Scan
Open your site in a real browser and map out the pages
🤖
Generate
Turn each discovered page into a test suite automatically
▶️
Run
Execute on Chromium, Firefox, or WebKit — or all three
🛠️
Self-heal
When the page changes, tests update themselves where they can

Before you sign up: try a free scan

If you'd like a preview before creating an account, head to aegisrunner.com/free-scan, drop in a URL and your email, and we'll scan one page and email you the generated tests. No credit card. See the Free Scan guide for details.

Step 1: Create your first project

1
Open the new project page

From the dashboard, click Projects in the sidebar, then + New Project.

2
Fill in the basics

Name your project, paste in your site's URL (e.g. https://example.com), and add a short description if you want one.

3
Leave "Scan immediately" checked

By default, AegisRunner kicks off the first scan as soon as the project is created — you don't need to do it manually. If you'd rather configure things first, uncheck the box.

4
Create the project

Click Create Project. You'll land on the project detail page and the first scan will be running.

Logged-in already and just want to scan? If you've already created a project, click Scan in the sidebar to start a new scan against any of your projects.

Step 2: Watch the scan and review what was found

The scan runs in the background and the page updates live. Most small sites finish in a couple of minutes. Once it's done, the scan detail page shows:

  • Pages discovered — every distinct page the scanner reached, with screenshots.
  • AI coverage banner — a summary at the top: "AI tests cover X of Y discovered pages". On the free plan we generate tests for one page; paid plans cover everything reachable.
  • Per-page recommendations — accessibility issues, broken links, slow performance, anything else worth fixing.

Scan options worth knowing about

When you start a scan from the Scan page (not the auto-scan on project creation), the modal lets you tune what gets covered:

  • Full site vs. single page — full site follows links from your starting URL; single page tests just one URL.
  • Max pages and link depth — caps how far the scanner walks. Free plans have a small cap; paid plans effectively don't.
  • Device — paid plans can scan as a phone or tablet to catch mobile-only bugs. Tests generated from a mobile scan run in mobile viewport automatically.
  • Fill forms / Submit forms — let the scanner fill and submit forms with safe test data so it can discover what's behind them.
  • Accessibility — runs WCAG checks (axe-core) on every discovered page.
  • Pro/Business extras — accessibility snapshots, JS-error capture, reduced-motion, high-contrast, memory-leak detection, and live-connection (WebSocket) monitoring.

Step 3: Run the tests

1
Open a test suite

Click Test Suites in the sidebar. Each suite corresponds to a page the scanner found. Open one to see the individual test cases.

2
Pick browsers and click Run

Hit Run on a suite. You can pick one browser or several (Chromium, Firefox, WebKit) — AegisRunner runs each in parallel and shows them as separate browser tabs in the run view.

3
Read the results

The run page streams results live. When it finishes you'll see passed / failed / skipped counts, a recording, full logs, and per-step screenshots. Click any test to see its steps and what it asserted.

4
Re-run a single failure

If only one test failed, you don't have to re-run the whole suite — open the failing test and click Re-run. Useful while you're iterating on a fix.

Step 4: When something fails

Failed tests show up with a red badge and a Triage tab on the run page. Two things happen automatically:

  • Auto-heal — if a button got renamed or moved, AegisRunner tries to find it again using accessibility roles and surrounding text. If it succeeds, the test passes and the suite is updated.
  • AI triage — for failures we can't repair, the Triage tab explains what likely broke (real regression vs. flaky test vs. environment issue) and links you to the exact step.

See Debugging Failed Tests for the full workflow.

Step 5: Run on a schedule (optional)

Once you trust your suites, automate them:

  1. Click Schedules in the sidebar, then + New Schedule.
  2. Pick a suite, choose a cadence (daily, weekly, hourly, or custom cron), and pick which browsers to run on.
  3. Save. You'll get an email — and Slack/Discord/Teams if you've connected them — when a scheduled run finishes or fails.
Plan limits: Starter gets one weekly schedule. Pro and Business have no schedule cap. See pricing for details.

Going further

Once the basics are humming:

  • Visual Regression — turn on pixel-level screenshot comparison. Catch CSS/layout drift you'd never notice manually.
  • API Testing — add API request steps to a suite so you assert on backend responses alongside the UI flow.
  • CI/CD Integration — trigger a run from GitHub Actions, GitLab, or any CI on every PR.
  • Notifications — send run results to Slack, Discord, Teams, or a webhook.

Where to go next

Need help?

  • Check Common Issues.
  • Email support@aegisrunner.com. Starter and above include faster-response email support.
  • Open the in-app chat from the support page if you're already logged in.

Need help?

Can't find what you're looking for? Our support team is here to help.