Skip to content

Configuration

CLI options for @holmdigital/engine: language codes, severity thresholds, PDF reports, and CI/CD integration.

The scanner can be configured via a .a11yrc file (JSON) or CLI arguments.

CLI Options

npx hd-a11y-scan <url> [options] Options: --lang <code> Language code (en, sv, no, da, fi, de, fr, es, nl, it, pt, pl). Default: en --threshold <level> Severity threshold (critical, high, medium, low). Default: high --ci Run in CI mode (fail build). See [CI/CD Guide](/ci-cd) --json Output results as JSON --junit <path> Generate JUnit XML report for CI dashboards --pdf <path> Generate PDF report to specified file path --viewport <size> Set viewport: "mobile", "desktop", "tablet" or "WxH" --generate-tests [Experimental] Generate repro scripts for found issues --statement <path> Generate static HTML accessibility statement --org <name> Organization name for statement --email <email> Contact email for statement --phone <number> Contact phone for statement --response-time <val> Response time for statement (e.g. "2 working days") --publish-date <date> Publish date for the website (YYYY-MM-DD) --format <type> Output format (text, json, junit) --country <code> Country-specific legal mapping (se, no, dk, fi, de, nl, fr, es, it, pt, pl) --sector <type> Sector type: public (WAD) or private (EAA). Default: public --api-key <key> Upload results to HolmDigital Cloud Dashboard --light Fast score-only scan (skips HTML validation and legal mapping) --invalid-https-cert Allow scanning pages with self-signed certificates --cloud-url <url> Custom Cloud API endpoint (default: cloud.holmdigital.se)

Statement Metadata Mapping

When generating accessibility statements via CLI or .a11yrc, the following keys map directly to the AccessibilityStatement component props:

.a11yrc KeyProp NameDescription
orgorganizationNameLegal name of the entity.
emailcontactEmailPublic contact address.
responseTimeresponseTimee.g. "2 working days".
phonecontactPhonePublic contact phone number.
publish-datepublishDatePublish date for the website (YYYY-MM-DD).
sectorsector"public" (WAD) or "private" (EAA). Determines enforcement body and law.

⚠️ Security: --invalid-https-cert should only be used in trusted environments (e.g., local dev servers with self-signed certificates).