Documentation

Everything you need to integrate Audiq into your workflow — CLI, MCP server, API, and Pulse SDK.

Quick Start

# Scan any website
npx audiq scan https://your-site.com

# Add to CI pipeline (fails if scores below budget)
npx audiq ci https://your-site.com --budget perf=80,seo=90,a11y=95

# Use as MCP server in Claude Code
npx audiq mcp

CLI Reference

$ npx audiq scan <url>

Scan a single page — returns scores (0-100) and prioritized issues

$ npx audiq crawl <url>

Crawl and audit an entire site (up to 50 pages)

$ npx audiq plan <url>

Scan + generate a prioritized fix plan with code examples

$ npx audiq ci <url>

CI budget check — exits non-zero if scores below thresholds

$ npx audiq review <url>

AI visual review using Claude Vision (needs ANTHROPIC_API_KEY)

$ npx audiq mcp

Start MCP server for Claude Code / Cursor / Windsurf

MCP Server Tools (18)

Start with npx audiq mcp or add to your MCP settings:

{
  "mcpServers": {
    "audiq": {
      "command": "npx",
      "args": ["audiq"]
    }
  }
}

Tool	Parameters	Description
scan_page	url, profile?, loginUrl?, username?, password?	Deep audit — perf, SEO, a11y, security, design. Quick (~15s) or full (~60s).
screenshot_page	url, viewport?, fullPage?, loginUrl?	Take screenshot and return image for AI to analyze visually.
analyze_visual	url, viewport?	AI design analysis — server-side (with API key) or returns image.
generate_fix_plan	format?, minSeverity?	Convert scan results into prioritized fix tasks with code examples.
start_scan	url, maxPages?	Start async multi-page site scan.
scan_status	scanId	Check async scan job progress.
scan_results	scanId	Get completed scan results.
get_console_errors	url, duration?	Capture console errors, warnings, and exceptions.
get_network_issues	url	Detect failed requests, timeouts, and missing resources.
run_lighthouse	url, categories?, device?	Run Lighthouse audit (performance, a11y, SEO, best practices).
check_accessibility	url	Run axe-core WCAG 2.1 AA accessibility audit.
login_and_scan	loginUrl, url, username, password	Authenticate then scan protected pages.
discover_site	url, maxPages?	Map entire site structure — pages, forms, interactive elements.
qa_audit	url	Full QA pass with screenshots across all pages.
recommend_design	url	AI design recommendations from screenshot analysis.
get_report	format?	Retrieve report in JSON or Markdown.
get_dashboard_report	shareUrl	Fetch results from dashboard via share link.
cancel_scan	scanId	Cancel a running async scan.

API Endpoints

Authenticate with a Supabase access token via Authorization: Bearer <token> header.

POST

/api/scan

Trigger a scan. Body: { url, siteId? }

GET

/api/scan/:jobId

Get scan job status and progress

GET

/api/reports?url=...

Get latest scan results for a URL. Auth: Bearer token

GET

/api/report/:token

Get public report by share token (no auth)

GET

/api/badge/:token

Get SVG score badge for embedding

Pulse SDK

Lightweight (3.7KB) real user monitoring. Tracks Core Web Vitals, JS errors, rage/dead clicks, and generates click heatmaps.

<!-- Add to your site's <head> -->
<script
  src="https://pulse.audiq.app/sdk.js"
  data-site-id="YOUR_SITE_ID"
  defer
></script>

Tracks: LCP, CLS, INP, FCP, TTFB, JS errors, rage clicks, dead clicks

Heatmap: Click positions rendered as canvas overlay on site screenshot

Privacy: No cookies, no PII collected, GDPR-friendly

CI Integration

Add quality gates to your pipeline. The CI command exits with code 1 if any score falls below the budget.

# GitHub Actions example
- name: Audiq Quality Check
  run: npx audiq ci $DEPLOY_URL --budget perf=80,seo=90,a11y=95,bp=90

# With custom thresholds per metric
- name: Audiq CI
  run: npx audiq ci $DEPLOY_URL --budget perf=70 --format json