Onboarding Audit CLI

Command-line interface for auditing onboarding experiences.

Installation

npm install -g @virrpe/onbrd-cli

Usage

Audit Command

Audit a URL or HTML file:

onbrd audit <url|file.html> --threshold 80 --mode local --json out.json --report out.html

Exit Codes:

• 0: Audit passed (score >= threshold)
• 1: Audit failed (score < threshold)
• 2: Integrity check failed

Options:

• --threshold <number>: Minimum score threshold (0-100, default: 80)
• --mode <local|remote>: Audit mode (default: local)
• --json <file>: Output JSON results to file
• --report <file>: Generate HTML report

Compare Command

Compare two HTML files:

onbrd compare a.html b.html --out diff.html

Log Command

Manage audit history:

# Append score to history
onbrd log --append score.json --history .onbrd/history.jsonl

# View history
onbrd log --history .onbrd/history.jsonl

Examples

# Audit a website
onbrd audit https://example.com --threshold 85 --json results.json --report report.html

# Audit a local HTML file
onbrd audit ./index.html --threshold 70 --mode local

# Compare two versions
onbrd compare v1.html v2.html --out comparison.html

# Track scores over time
onbrd log --append current-score.json --history ./audit-history.jsonl

GitHub Action

Use the provided GitHub Action in your workflows:

- uses: ./.github/actions/run-onbrd
  with:
    url: 'https://your-site.com'
    threshold: '80'
    mode: 'local'
    artifact: 'true'

License

MIT