# AegisRunner

> Guides for AegisRunner website and mobile testing, app access, test results, CI automation, and billing.

## Documentation

- [AegisRunner documentation](https://docs.aegisrunner.com/introduction.md): Explore your app, generate tests, investigate failures, and automate regression testing.
- [Run your first website scan](https://docs.aegisrunner.com/quickstart.md): Create a project from a website URL, configure access, and inspect your first results.
- [Start with a free website scan](https://docs.aegisrunner.com/guides/public-scan.md): Run a bounded public website audit and continue into a project for maintained tests.
- [Examples and a guided walkthrough](https://docs.aegisrunner.com/guides/examples.md): Use public demos to understand scan findings and run evidence before testing your own app.
- [What AegisRunner tests](https://docs.aegisrunner.com/features.md): Choose the testing workflow and evidence that fit your app.
- [Projects and navigation](https://docs.aegisrunner.com/guides/projects.md): Find scans, tests, reports, access settings, and project configuration.
- [Website scans](https://docs.aegisrunner.com/guides/website-scans.md): Choose scan detail, verify discovery coverage, and repeat scans after app changes.
- [App access and login](https://docs.aegisrunner.com/guides/authentication.md): Save and check test accounts, session cookies, API tokens, and custom sign-in flows.
- [Environments and test data](https://docs.aegisrunner.com/guides/environments-and-data.md): Configure targets, reusable values, and secrets for repeatable tests.
- [Test suites and runs](https://docs.aegisrunner.com/guides/test-suites.md): Review generated test cases and execute them against your app.
- [Create and edit tests](https://docs.aegisrunner.com/guides/authoring-tests.md): Add test cases, edit actions and expectations, and approve tests you have reviewed.
- [Mobile testing](https://docs.aegisrunner.com/guides/mobile-testing.md): Upload an Android or iOS build, choose an execution device, and review screen evidence.
- [Cross-role and web and mobile tests](https://docs.aegisrunner.com/guides/cross-surface-testing.md): Verify that a record created by one user reaches another role or app.
- [User journeys and composite suites](https://docs.aegisrunner.com/guides/composite-suites.md): Create a workflow across pages or group reviewed suites for one execution.
- [Data-driven tests and CSV examples](https://docs.aegisrunner.com/guides/data-driven-testing.md): Run form tests with reusable data rows and verify the outcome for each row.
- [Browsers and test selection](https://docs.aegisrunner.com/guides/browser-and-selection.md): Choose browser profiles, environments, and a focused set of tests for a run.
- [API checks inside a workflow](https://docs.aegisrunner.com/guides/api-checks.md): Add an HTTP request to a web test and inspect API errors found during scans.
- [Import tests and export code](https://docs.aegisrunner.com/guides/import-export.md): Bring CSV or JSON cases into a project and export Playwright, page objects, or Appium tests.
- [Read and share results](https://docs.aegisrunner.com/guides/results.md): Investigate scan findings and run failures using the available evidence.
- [Failure triage and auto-heal](https://docs.aegisrunner.com/guides/failure-triage.md): Investigate a failed run, group likely causes, and repair broken locators.
- [Issues and coverage](https://docs.aegisrunner.com/guides/issues-and-coverage.md): Read issue families, distinguish observations from confirmed defects, and inspect coverage gaps.
- [Verify saved data](https://docs.aegisrunner.com/guides/persistence-checks.md): Distinguish an accepted write action from a separately verified record and field values.
- [Page audits and their limits](https://docs.aegisrunner.com/guides/audits.md): Interpret accessibility, performance, SEO, security, and network observations alongside functional results.
- [Accessibility and WCAG reports](https://docs.aegisrunner.com/guides/accessibility.md): Review automated accessibility findings and use evidence in your accessibility workflow.
- [Baselines and visual changes](https://docs.aegisrunner.com/guides/baselines.md): Compare later results with a known reference and review intended changes.
- [Analytics and test trends](https://docs.aegisrunner.com/guides/analytics.md): Interpret execution history and compare results across consistent testing conditions.
- [Review what AegisRunner learned](https://docs.aegisrunner.com/guides/learned-behavior.md): Confirm observed app facts, judge check quality, and guide exploration with scan hints.
- [AegisRunner CLI](https://docs.aegisrunner.com/automation/cli.md): Trigger scans and runs from a terminal and collect results for automation.
- [CI and deployment pipelines](https://docs.aegisrunner.com/automation/ci-cd.md): Run a reviewed suite in CI and preserve a JUnit report.
- [Local and private apps](https://docs.aegisrunner.com/automation/local-testing.md): Reach a local target with a tunnel or execute scans on your own machine.
- [Vite Nuxt and Next development workflows](https://docs.aegisrunner.com/automation/framework-plugins.md): Install framework integrations or attach the CLI to your development server.
- [Scheduled testing](https://docs.aegisrunner.com/automation/schedules.md): Repeat scans, suite runs, or baseline checks in a selected timezone.
- [AI provider setup](https://docs.aegisrunner.com/guides/ai-provider.md): Choose built-in test generation or configure your own provider for a project.
- [Integrations and notifications](https://docs.aegisrunner.com/integrations.md): Connect issue trackers, deployment events, and run notifications.
- [GitHub Issues and Jira](https://docs.aegisrunner.com/integrations/issue-trackers.md): Connect an issue destination and control automation for failed tests.
- [Email and chat notifications](https://docs.aegisrunner.com/integrations/notifications.md): Choose events and connect Slack Discord or Teams to project testing.
- [Custom notification webhooks](https://docs.aegisrunner.com/integrations/custom-webhooks.md): Receive run events in your service and verify their signature.
- [Deployment-triggered testing](https://docs.aegisrunner.com/integrations/deployment-webhooks.md): Connect Vercel Netlify or GitLab deployment events to regression checks.
- [Account profile and security](https://docs.aegisrunner.com/account/profile-and-security.md): Manage account access, identity connections, password changes, and recovery.
- [Two-factor authentication and backup codes](https://docs.aegisrunner.com/account/two-factor-authentication.md): Enable an authenticator code for sign-in and prepare account recovery.
- [Teams and project permissions](https://docs.aegisrunner.com/account/team-and-permissions.md): Invite teammates and distinguish organization access from project roles.
- [Set up SAML single sign-on](https://docs.aegisrunner.com/account/sso.md): Connect an identity provider and validate organization sign-in before enforcement.
- [Review audit logs](https://docs.aegisrunner.com/account/audit-logs.md): Find organization events and inspect who changed a resource.
- [Test data and shared reports](https://docs.aegisrunner.com/account/data-and-sharing.md): Choose appropriate test data and understand what a public evidence link exposes.
- [Plans and usage](https://docs.aegisrunner.com/account/plans-and-usage.md): Find current plan limits, usage, and upgrade options.
- [Billing and invoices](https://docs.aegisrunner.com/account/billing.md): Manage a subscription, review scheduled changes, and download invoices.

## API Reference

- [Automation API overview](https://docs.aegisrunner.com/api-reference/overview.md): Trigger runs and scans, poll run status, and stream scan progress.
- [API authentication](https://docs.aegisrunner.com/api-reference/authentication.md): Create a project CI token and authenticate automation requests.
- [API errors and completion states](https://docs.aegisrunner.com/api-reference/errors.md): Handle authentication, plan limits, asynchronous failures, and rate limits.
- [Project and testing API](https://docs.aegisrunner.com/api-reference/platform-api.md): Use authenticated project management and test execution endpoints alongside the CI API.
- [Trigger a run or scan](https://docs.aegisrunner.com/api-reference/endpoints/trigger.md): Start an existing test run or dispatch website or mobile discovery.
- [Get run status](https://docs.aegisrunner.com/api-reference/endpoints/run-status.md): Read the current state and available case results for a run in the CI token's project.
- [Stream scan progress](https://docs.aegisrunner.com/api-reference/endpoints/scan-events.md): Follow website discovery and test generation through Server-Sent Events.
- [List projects](https://docs.aegisrunner.com/api-reference/platform/list-projects.md): List projects available to the account.
- [Create a project](https://docs.aegisrunner.com/api-reference/platform/create-project.md): Create a project in an organization where the account has the necessary role.
- [Get a project](https://docs.aegisrunner.com/api-reference/platform/get-project.md): Read project metadata after access checks.
- [List project suites](https://docs.aegisrunner.com/api-reference/platform/list-suites.md): Inspect the suites available for a project and choose IDs for a focused run..
- [Create a custom suite](https://docs.aegisrunner.com/api-reference/platform/create-suite.md): Create a named suite with optional description, page anchor, and tags.
- [List suite cases](https://docs.aegisrunner.com/api-reference/platform/list-cases.md): Read cases belonging to a suite available to the account..
- [Create a test case](https://docs.aegisrunner.com/api-reference/platform/create-case.md): Create a case in a suite with the appropriate project write role.
- [Get a test case](https://docs.aegisrunner.com/api-reference/platform/get-case.md): Read a case and the available step details for its project..
- [Review a test case](https://docs.aegisrunner.com/api-reference/platform/review-case.md): Set a case review state after checking its actions and expectations.
- [Create a project test run](https://docs.aegisrunner.com/api-reference/platform/create-run.md): Dispatch a test run asynchronously.
- [List project test runs](https://docs.aegisrunner.com/api-reference/platform/list-runs.md): Read project execution history.
- [Get a project test run](https://docs.aegisrunner.com/api-reference/platform/get-run.md): Read the run detail and available result metadata.
- [Cancel a test run](https://docs.aegisrunner.com/api-reference/platform/cancel-run.md): Request cancellation of a run available to the account.
- [Rerun a test execution](https://docs.aegisrunner.com/api-reference/platform/rerun.md): Create another execution from an existing run.
- [Export suite code](https://docs.aegisrunner.com/api-reference/platform/export-code.md): Export supported web or native mobile test source.
- [Export a page object project](https://docs.aegisrunner.com/api-reference/platform/export-page-objects.md): Download a generated page-object project for an eligible suite and plan.
- [Export a run report](https://docs.aegisrunner.com/api-reference/platform/export-report.md): Download a run report in CSV, JUnit XML, HTML, or PDF.
- [Import test cases](https://docs.aegisrunner.com/api-reference/platform/import-cases.md): Import a CSV or JSON test library into a project.
- [List project environments](https://docs.aegisrunner.com/api-reference/platform/list-environments.md): Inspect configured environments before selecting an environmentId for a run.
- [List test data sets](https://docs.aegisrunner.com/api-reference/platform/list-data-sets.md): Inspect reusable test data sets belonging to the project before selecting a testDataSetId..

## Help Center

- [AegisRunner help center](https://docs.aegisrunner.com/help-center.md): Find troubleshooting steps and contact support with useful diagnostic details.
- [Getting started questions](https://docs.aegisrunner.com/help-center/faq/getting-started.md): Answers about scans, test runs, access, mobile builds, and CI.
- [Run and inspect your first test](https://docs.aegisrunner.com/help-center/guides/first-test.md): Turn a completed scan into a small, repeatable regression check.
- [Documentation updates](https://docs.aegisrunner.com/changelog.md): Published changes to AegisRunner documentation and developer guides.
- [Scan or test not running](https://docs.aegisrunner.com/help-center/troubleshooting/test-not-running.md): Diagnose missing work, stalled progress, empty suites, and execution failures.
- [Login troubleshooting](https://docs.aegisrunner.com/help-center/troubleshooting/login-failed.md): Resolve bad credentials, expired sessions, and incomplete authenticated coverage.
- [Mobile scan troubleshooting](https://docs.aegisrunner.com/help-center/troubleshooting/mobile-scan.md): Resolve build uploads, device queues, and missing screen coverage.
- [Troubleshoot testing and integrations](https://docs.aegisrunner.com/help-center/troubleshooting/common-issues.md): Resolve failures in access data execution notifications and CI.