Quick Start Guide
Get up and running with AegisRunner in under 5 minutes. Learn how to create your first project, run a crawl, and generate automated tests.
Quick Start Guide
Welcome to AegisRunner! This guide will help you get up and running in under 5 minutes.
What is AegisRunner?
AegisRunner is a web crawler and automated testing platform that helps you discover pages on your website, generate AI-powered tests, and run them on a schedule to catch bugs before your users do.
Step 1: Create Your First Project
Click Projects in the left sidebar, then click the + New Project button.
Fill in your project name, the base URL of your website (e.g., https://example.com), and an optional description.
Click Create Project to save your new project.
Step 2: Crawl Your Website
Click Crawl in the sidebar, or use the Crawl Website quick action on your dashboard.
Choose between:
- Full Site - Discovers all linked pages starting from your base URL
- Single Page - Analyzes only the specified URL
Adjust crawl settings as needed:
- Max Pages: 1-1000 (limited by your plan)
- Depth: 1-10 levels deep
- Include/Exclude patterns: Filter which URLs to crawl
Click Start Crawl and watch the real-time progress as pages are discovered.
Step 3: Generate Test Suites
Once your crawl completes, AegisRunner automatically generates test suites for the discovered pages. You can find these in the Test Suites section.
Step 4: Run Your Tests
Click Test Suites in the sidebar to see all generated suites.
Click the Run button on any suite and choose your browser: Chromium, Firefox, or WebKit.
Monitor the test run in real-time. Once complete, view detailed results including passed, failed, and skipped tests.
Step 5: Set Up Scheduled Testing (Optional)
Automate your testing by creating a schedule:
- Go to Schedules in the sidebar
- Click + New Schedule
- Select a test suite and choose a preset schedule (e.g., Daily at 9am, Every hour)
- Enable the schedule and save
Step 6: Enable Visual Regression & API Testing
Take your testing further with these powerful features:
- Visual Regression ā Enable pixel-level screenshot comparisons when running tests. Catch unintended visual changes automatically.
- API Testing ā Add API request steps to test REST/GraphQL endpoints alongside your UI tests. Assert on status codes, response bodies, and timing.
Next Steps
Now that you have the basics down, explore these features:
- Dashboard Overview - Understand your testing metrics
- Starting a New Crawl - Advanced crawl configuration
- AI Test Generation - How AI creates your tests
- User Flow Tests - Create multi-page test flows
Need Help?
If you run into any issues:
- Check our Common Issues guide
- Email support at support@aegisrunner.com
- Starter+ plans include email support with faster response times