Docs & Parameter

Die wichtigsten Eingaben, Flags und Aufrufmuster für auditmysite. Fokus: Single-Reports, Sitemap-Scans, JSON-Ausgabe und Einzelreports pro URL.

Workflows

Typische Workflows

Die Beispiele sind nicht nur Referenzbefehle. Sie zeigen die beabsichtigten Pfade durch das Produkt: Einzelprüfung, Batch, CI und Per-Page-Reports.

Einzelne Startseite prüfen

terminal

 $ auditmysite https://www.casoon.de

Terminal-Zusammenfassung plus PDF, JSON und History im aktuellen Verzeichnis.

Einzelne Unterseite gezielt prüfen

terminal

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

Detaillierter Einzelreport für eine konkrete Leistungs- oder Landingpage.

Sitemap kompakt als Domain-Report prüfen

terminal

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

Ein komprimierter Report mit Durchschnittswerten, Rankings und URL-Matrix.

Sitemap scannen und pro URL Einzelreports schreiben

terminal

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

Ein Report pro URL im Zielverzeichnis statt eines einzigen Batch-Reports.

JSON für CI erzeugen

terminal

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

Schema-stabile JSON-Ausgabe für Pipelines, Snapshots und Validierung.

CI/CD-Integration

auditmysite läuft als eigenständiges Binary ohne Browser-Extension. In CI/CD-Pipelines wird Chrome for Testing automatisch erkannt oder per auditmysite browser install heruntergeladen. Der JSON-Output liefert stabile Schemas für 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

Bei jedem Audit-Lauf schreibt auditmysite automatisch eine *-history.json neben die Ausgabedatei. Diese Datei akkumuliert Snapshots mit Timestamp, Score und Verstoßzahlen. Beim nächsten Lauf gegen dieselbe URL liest das Tool die Datei ein und zeigt im Report automatisch eine Trendbewertung: Verbesserung, Verschlechterung oder stabil — inklusive Delta-Werte für Accessibility-Score und Gesamtverstöße.

Der History-Mechanismus ist konventionsbasiert: gleiches Verzeichnis, gleicher Dateinamenprefix. Kein zusätzliches Setup nötig.

Report-Level: executive, standard, technical

Der --report-level-Parameter steuert die Tiefe des PDF-Reports:

executive

Kompaktes Einseiter-Format für Entscheider. Score, Reifegrad, Top-Maßnahmen und Benchmark. Keine rohen Fundstellen.

standard

Vollständiger Report mit priorisierten Findings, Maßnahmenplan, Moduldetails und Trendbewertung. Standard für Freigaben und Kundenpräsentationen.

technical

Alles aus Standard plus Anhang mit allen Fundstellen, Selektoren und Regelreferenzen. Für Entwickler und Qualitätssicherung.

Browser-Hinweis

auditmysite benötigt lokal ein Chrome- oder Chromium-Binary, weil der Audit auf echten Browserdaten basiert. Standardmäßig sucht das Tool nach installierten Browsern auf dem System. Wenn kein passender Browser gefunden wird, kannst du mit auditmysite browser install automatisch Chrome for Testing herunterladen. Alternativ erzwingt --browser-path /pfad/zum/browser ein konkretes Binary. Der Download landet im lokalen Cache und wird bei späteren Läufen wiederverwendet.

Eingaben

Parameter	Bedeutung
URL	Prüft eine einzelne Seite und erzeugt standardmäßig Terminal-Zusammenfassung, PDF, JSON und History.
Beispiel: `auditmysite https://example.com`
`--sitemap`	Lädt eine Sitemap und erzeugt standardmäßig einen komprimierten Domain-Report.
Beispiel: `--sitemap https://example.com/sitemap.xml`
`--url-file`	Prüft mehrere URLs aus einer Datei, eine URL pro Zeile.
Beispiel: `--url-file urls.txt`
`--prefer-sitemap`	Erkennt bei Basis-URLs eine gefüllte Sitemap und startet direkt den Batch-Scan.
Beispiel: `auditmysite https://example.com --prefer-sitemap`
`--no-sitemap-suggest`	Unterdrückt den interaktiven Sitemap-Vorschlag bei Basis-URLs.
Beispiel: `auditmysite https://example.com --no-sitemap-suggest`
`--per-page-reports`	Scannt Sitemap oder URL-Liste, erzeugt aber Einzelreports pro URL statt eines aggregierten Batch-Reports.
Beispiel: `--sitemap ... --per-page-reports`

Ausgabe

Parameter	Bedeutung
`-f pdf`	PDF-Report. Bei Einzel-URLs Standard, bei Batch nur mit Flag.
Beispiel: `-f pdf`
`-f json`	Maschinenlesbare Ausgabe für CI/CD und Automatisierung.
Beispiel: `-f json -o report.json`
`-f table`	Terminal-Ausgabe für schnelle Sichtung im CLI.
Beispiel: `-f table`
`-o`	Zieldatei. Mit `--per-page-reports` wird `-o` als Zielverzeichnis behandelt.
Beispiel: `-o reports/report.pdf`
`--report-level`	PDF-Tiefe: `executive`, `standard` oder `technical`.
Beispiel: `--report-level executive`
`--lang`	Sprache für PDF-Texte.
Beispiel: `--lang de` / `--lang en`

Module und Analyseumfang

Parameter	Bedeutung
Standardlauf	Accessibility plus Performance, SEO, Security und Mobile im selben Lauf.
Beispiel: `auditmysite https://example.com`
`--full`	Erzwingt alle Zusatzmodule explizit.
Beispiel: `--full`
`--performance` / `--skip-performance`	Schaltet Performance gezielt an oder aus.
Beispiel: `--performance`
`--seo`	Schaltet SEO-Analyse gezielt ein.
Beispiel: `--seo`
`--security`	Schaltet Header- und TLS-Prüfungen gezielt ein.
Beispiel: `--security`
`--mobile` / `--skip-mobile`	Schaltet Mobile-Checks gezielt an oder aus.
Beispiel: `--mobile`

Laufzeit und Browser

Parameter	Bedeutung
`--browser-path`	Erzwingt ein bestimmtes Chrome/Chromium-Binary.
Beispiel: `--browser-path /path/to/chrome`
`--concurrency`	Anzahl paralleler Tabs im Batch-Modus.
Beispiel: `--concurrency 3`
`--max-pages`	Begrenzt Sitemap- oder URL-File-Scans auf eine feste Anzahl Seiten.
Beispiel: `--max-pages 25`
`--timeout`	Timeout pro Seite in Sekunden.
Beispiel: `--timeout 45`
`--quiet` / `--verbose`	Reduziert oder erweitert die Konsolenausgabe.
Beispiel: `--quiet`
`auditmysite browser install`	Lädt Chrome for Testing, falls lokal kein Browser vorhanden ist.
Beispiel: `auditmysite browser install`