🛠️

jekyll-audit

CLI Flags Reference

CLI Flags

All flags can be combined. Defaults target fast, lean CI runs with small JSON outputs.

General

  • --config <path> – Path to config file.
  • --baseUrl <url> – Target a running site instead of serving locally.
  • --report <formats> – CSV of json,html,md. Default json.
  • --outDir <dir> – Reports output directory. Default reports.
  • --skipBuild, --skipServe – Skip steps if you already have a site running.

Crawl Controls

  • --maxPages <n> – Limit pages scanned (overrides config).
  • --paths <csv> – Comma-separated path list to scan. Disables sitemap.
  • --noSitemap – Do not use sitemap.xml even if present.

Lighthouse

  • --output summary|full – JSON mode. Default summary.
  • --includeDetails – Include audit details (heavier). Typically for full.
  • --includeScreenshots – Include Base64 screenshot audits (large!).
  • --gzip – Write lighthouse.json.gz when in full mode.
  • --softFail – Do not exit non‑zero on threshold warnings.

Summary mode skips heavy audits and strips blobs for small, diff‑friendly reports.

Accessibility (Pa11y)

  • --a11yOutput summary|full – Default summary.
  • --a11yIncludeDetails – Include raw issue list.

Summary includes per‑page totals and counts by issue type (error/warning/notice).

Links (Linkinator)

  • --linksOutput summary|full – Default summary.
  • --linksInternalOnly – Only report links within the base origin.
  • --linksIncludeDetails – Include all link records (heavier).
  • --linksTimeout <ms> – Per‑request timeout (default 30000).
  • --linksConcurrency <n> – Concurrency (default 100).

Summary lists only broken links with minimal fields for fast triage.

HTML Validation

  • --htmlOutput summary|full – Default summary.
  • --htmlIncludeDetails – Include full validator messages.

Summary returns only per‑URL error counts.

Examples

# Default, lean CI run
npx @brennanbrown/jekyll-audit audit

# Full Lighthouse with details and screenshots (heavy)
npx @brennanbrown/jekyll-audit audit --output full --includeDetails --includeScreenshots

# Internal links only, tuned for speed
npx @brennanbrown/jekyll-audit audit --linksInternalOnly --linksConcurrency 200 --linksTimeout 15000

# Limit pages and disable sitemap
npx @brennanbrown/jekyll-audit audit --maxPages 20 --noSitemap