Skip to content

VertaaUX/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

VERTAAUX

npm npm downloads Homebrew Docker Marketplace License

UX, accessibility, and conversion audits from the terminal and CI/CD — with score-based quality gates, PR comments, and regression detection.

Website · Docs · GitHub Action · MCP Server · Agent Skills


Install

Pick your package manager:

# npm
npm install -g @vertaaux/cli

# Homebrew (macOS / Linux)
brew install vertaaux/tap/vertaa

# Docker (CI / no Node toolchain)
docker run --rm ghcr.io/vertaaux/cli --help

Quick Start

vertaa audit https://example.com

First run walks you through a welcome tour, optional telemetry consent, and drops you in an interactive menu. 3 guest audits per day without an account — get an API key to unlock metered audits, deep mode, and baselines.

vertaa audit https://example.com --mode deep --fail-on error --baseline .vertaaux/baseline.json

Full command reference, config schema, and CI integration guides: vertaaux.ai/docs.

What it does

  • 7 audit categories — usability · clarity · information architecture · accessibility · conversion · semantic · keyboard
  • axe-core + WCAG heuristics for accessibility checks
  • Score-based quality gates — fail CI when scores drop below thresholds
  • Regression detection — compare against a baseline, comment on PRs
  • Machine-readable output — JSON, SARIF, JUnit, HTML
  • Works on localhost — point at http://localhost:3000 from your dev machine (unmetered for zero-paid-dep audits)
  • AI-powered fix suggestions — ready-to-paste HTML/CSS with impact scores and effort estimates

CI/CD

GitHub Actions

- uses: vertaaux/audit-action@v1
  with:
    url: https://example.com
    api-key: ${{ secrets.VERTAAUX_API_KEY }}
    threshold: 80
    fail-on-critical: true

Marketplace: https://github.com/marketplace/actions/vertaaux-audit

Any CI (Docker)

- run: |
    docker run --rm \
      -e VERTAAUX_API_KEY=$VERTAAUX_API_KEY \
      ghcr.io/vertaaux/cli audit https://staging.example.com --mode standard

Works unchanged on GitLab CI, CircleCI, Buildkite, Jenkins, Azure Pipelines, and self-hosted runners.

Distribution

Channel Install Use
npm npm install -g @vertaaux/cli Local dev + any Node-capable CI
Homebrew brew install vertaaux/tap/vertaa macOS / Linux developer machines
Docker (GHCR) docker pull ghcr.io/vertaaux/cli CI without a Node toolchain
GitHub Action uses: vertaaux/audit-action@v1 GitHub-native CI
MCP Server npx @vertaaux/mcp-server Claude Desktop / Cursor / IDE agents
Agent Skills npx skills add VertaaUX/agent-skills Coding-agent workflows
JS SDK npm install @vertaaux/sdk Programmatic API access

Feedback

This repo is the public home for the CLI — file issues, request features, and track releases here. Source lives in a downstream monorepo; we triage and port fixes through.

License

MIT © VertaaUX

Releases

No releases published

Packages

 
 
 

Contributors