Docs

Running an Audit

Learn how to initiate single-page scans or multi-page sitemap crawls across responsive device viewports.

Initiating an Audit

You can launch an audit anytime from your UIDesigner organization dashboard or the Audit web portal:

  1. Navigate to Audit Tool from your organization navigation.
  2. Click the New Audit button in the upper right.
  3. Enter your target URL (e.g., https://staging.yourdomain.com or local dev URLs).
  4. Configure your scan parameters and click Start Audit.

Scan Types

UIDesigner Audit supports two primary scanning scopes:

  • Single Page Scan: Analyzes a specific URL endpoint thoroughly across all selected viewports. Typical duration is 10–25 seconds.
  • Sitemap & Multi-Page Crawl: Discovers child routes from your XML sitemap or internal links, generating a consolidated site health score and cross-page issue matrix.

Selecting Target Viewports

Choose which device environments to evaluate during the run:

  • Desktop (1440 × 900 px): Standard laptop resolution.
  • Tablet (768 × 1024 px): Portrait tablet view.
  • Mobile (390 × 844 px): Standard modern smartphone viewport.

Selecting multiple viewports enables the engine to cross-reference responsive CSS rules and isolate issues that occur exclusively on handheld devices.

Running Audits via CLI

For engineering teams who prefer automated terminal workflows or CI/CD pipelines, audits can be executed with the official CLI:

# Run a single page audit across mobile and desktop uidesigner audit https://staging.example.com --viewports=mobile,desktop # Run an audit on a local development server uidesigner audit http://localhost:3000 --wcag