CLI Overview

The VertaaUX CLI brings UX auditing directly to your terminal. Run audits locally during development, integrate into CI/CD pipelines for quality gates, and manage baselines for tracking improvements over time.

Quick Install

npm install -g @vertaaux/cli

Key Features

Terminal Audits

Run audits directly from your shell with real-time progress and results

Multiple Audit Modes

Choose basic, standard, or deep analysis depth for your use case

Baseline Tracking

Create baselines and track UX improvements over time with diff comparisons

CI/CD Ready

Exit codes and structured output for pipeline integration

What You Can Do

Local Development

Run audits during development to catch UX issues before they reach production:

Audit your local dev server

$vertaa audit -u https://localhost:3000

CI/CD Quality Gates

Block merges when UX score drops below threshold:

Fail CI if errors found or score below 80

$vertaa audit -u $PREVIEW_URL --fail-on error --threshold 80

Baseline Comparisons

Track UX improvements by comparing against a baseline:

Compare current state against baseline

$vertaa audit -u https://example.com --baseline baseline.json

Multiple Output Formats

Export results in the format you need:

Export as SARIF for IDE integration

$vertaa audit -u https://example.com --format sarif -o results.sarif

Output Formats

Format	Use Case
`human`	Terminal display with colors (default)
`json`	Structured data for programmatic processing
`sarif`	IDE integration (VS Code, GitHub code scanning)
`junit`	Test framework integration
`html`	Shareable HTML reports