Docs & Parameters

The most important inputs, flags and command patterns for auditmysite. Focus: single-page reports, sitemap scans, JSON output and one report per URL.

Workflows

Typical workflows

These examples are not only command references. They show the intended product paths: single-page audits, batch scans, CI and per-page reports.

Audit a single homepage

terminal

 $ auditmysite https://www.casoon.de

Terminal summary plus PDF, JSON and history in the current directory.

Audit a specific subpage

terminal

 $ auditmysite https://www.casoon.de/seo-marketing/

Detailed single-page report for a specific service or landing page.

Run a sitemap as a compact domain report

terminal

 $ auditmysite https://www.casoon.de --prefer-sitemap

A condensed report with averages, rankings and a URL matrix.

Scan a sitemap and write one report per URL

terminal

 $ auditmysite --sitemap https://www.casoon.de/sitemap.xml --per-page-reports -o reports/casoon

One report per URL in the target directory instead of a single batch report.

Generate JSON for CI

terminal

 $ auditmysite https://www.casoon.de -f json -o report.json --quiet

Schema-stable JSON output for pipelines, snapshots and validation.

CI/CD integration

auditmysite runs as a standalone binary with no browser extension required. In CI/CD pipelines, Chrome for Testing is detected automatically or downloaded via auditmysite browser install. JSON output provides stable schemas for release gates.

GitHub Actions

.github/workflows/audit.yml

name: Accessibility Audit
on:
  push:
    branches: [main]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install auditmysite
        run: curl -fsSL https://raw.githubusercontent.com/casoon/auditmysite/main/install.sh | bash

      - name: Run audit
        run: auditmysite https://example.com -f json -o audit.json --quiet

      - name: Upload report
        uses: actions/upload-artifact@v4
        with:
          name: audit-report
          path: audit.json

GitLab CI

.gitlab-ci.yml

audit:
  image: ubuntu:latest
  script:
    - curl -fsSL https://raw.githubusercontent.com/casoon/auditmysite/main/install.sh | bash
    - auditmysite https://example.com -f json -o audit.json --quiet
  artifacts:
    paths:
      - audit.json
    expire_in: 30 days

History & trend tracking

Every audit run automatically writes a *-history.json file alongside the output. This file accumulates snapshots with timestamps, scores and violation counts. On the next run against the same URL, auditmysite reads the file and includes a trend assessment in the report: improvement, regression or stable — including delta values for accessibility score and total violations.

The history mechanism is convention-based: same directory, same filename prefix. No additional setup required.

Report level: executive, standard, technical

The --report-level flag controls the depth of the PDF report:

executive

Compact one-pager for decision-makers. Score, maturity rating, top actions and benchmark. No raw findings.

standard

Full report with prioritised findings, action plan, module details and trend assessment. The default for approvals and client presentations.

technical

Everything in standard plus an appendix with all occurrences, selectors and rule references. For developers and QA.

Browser requirement

auditmysite needs a local Chrome or Chromium binary because the audit runs against real browser data. By default, the tool searches the system for installed browsers. If none is available, auditmysite browser install downloads Chrome for Testing automatically. Alternatively, --browser-path /path/to/browser forces a specific binary. The download is stored in the local cache and reused in later runs.

Inputs

Parameter	Meaning
URL	Audits a single page and, by default, writes a terminal summary, PDF, JSON and history.
Example: `auditmysite https://example.com`
`--sitemap`	Loads a sitemap and, by default, creates a condensed domain report.
Example: `--sitemap https://example.com/sitemap.xml`
`--url-file`	Audits multiple URLs from a file, one URL per line.
Example: `--url-file urls.txt`
`--prefer-sitemap`	For base URLs, detects a populated sitemap and starts the batch scan directly.
Example: `auditmysite https://example.com --prefer-sitemap`
`--no-sitemap-suggest`	Suppresses the interactive sitemap suggestion for base URLs.
Example: `auditmysite https://example.com --no-sitemap-suggest`
`--per-page-reports`	Scans a sitemap or URL list but writes one report per URL instead of an aggregated batch report.
Example: `--sitemap ... --per-page-reports`

Output

Parameter	Meaning
`-f pdf`	PDF report. Default for single URLs, explicit for batch runs.
Example: `-f pdf`
`-f json`	Machine-readable output for CI/CD and automation.
Example: `-f json -o report.json`
`-f table`	Terminal output for quick inspection in the CLI.
Example: `-f table`
`-o`	Target file. With `--per-page-reports`, `-o` is treated as the output directory.
Example: `-o reports/report.pdf`
`--report-level`	PDF depth: `executive`, `standard` or `technical`.
Example: `--report-level executive`
`--lang`	Language for PDF texts.
Example: `--lang de` / `--lang en`

Modules and analysis scope

Parameter	Meaning
Default run	Accessibility plus Performance, SEO, Security and Mobile in the same run.
Example: `auditmysite https://example.com`
`--full`	Explicitly enables all additional modules.
Example: `--full`
`--performance` / `--skip-performance`	Enables or disables Performance explicitly.
Example: `--performance`
`--seo`	Enables SEO analysis explicitly.
Example: `--seo`
`--security`	Enables header and TLS checks explicitly.
Example: `--security`
`--mobile` / `--skip-mobile`	Enables or disables mobile checks explicitly.
Example: `--mobile`

Runtime and browser

Parameter	Meaning
`--browser-path`	Forces a specific Chrome/Chromium binary.
Example: `--browser-path /path/to/chrome`
`--concurrency`	Number of parallel tabs in batch mode.
Example: `--concurrency 3`
`--max-pages`	Limits sitemap or URL-file scans to a fixed number of pages.
Example: `--max-pages 25`
`--timeout`	Timeout per page in seconds.
Example: `--timeout 45`
`--quiet` / `--verbose`	Reduces or expands console output.
Example: `--quiet`
`auditmysite browser install`	Downloads Chrome for Testing if no browser is installed locally.
Example: `auditmysite browser install`