CLI Quickstart
Run your first UX audit from the terminal in 5 minutes
CLI Quickstart
Get from zero to your first UX audit in 5 minutes.
Prerequisites
Before starting, make sure you have:
- Node.js 18+ installed
- A VertaaUX account with an API key
Need to install? See Installation.
Install the CLI
Install globally via npm:
Verify installation:
@vertaaux/cli v1.0.0
Authenticate
Log in with your API key:
You'll be prompted to enter your API key. Get yours from the VertaaUX Dashboard.
Environment Variable
Alternatively, set the VERTAA_API_KEY environment variable:
export VERTAA_API_KEY=vx_live_your_key_hereVerify authentication:
Authenticated as: your-email@example.com Plan: Pro Credits remaining: 950/1000
Run Your First Audit
Audit any public URL:
You should see:
VertaaUX CLI v1.0.0
Auditing: https://example.com
Mode: basic
[====================================] 100%
Audit Complete
──────────────────────────────────────────────
Overall Score: 85/100
Scores by Category:
UX: 88/100
Accessibility: 82/100
Information Arch: 87/100
Performance: 83/100
Issues Found: 12
Errors: 2
Warnings: 7
Info: 3
Top Issues:
[ERROR] Missing alt text on hero image
[ERROR] Color contrast ratio 3.2:1 below 4.5:1 minimum
[WARN] No skip link for keyboard navigation
[WARN] Touch target 32x32px below 44x44px minimum
Full results: https://vertaaux.ai/reports/abc123Save Results
Export audit results to a file:
Or specify a different format:
What's Next?
Now that you've run your first audit, explore more capabilities:
Audit Command Reference
All 30+ flags for the audit command including filtering, quality gates, and debug options
Baseline Management
Create baselines and track UX improvements over time
CI/CD Integration
Set up automated audits in GitHub Actions, GitLab CI, and more
Configuration File
Set defaults with .vertaaux.yml so you don't need to repeat flags
Common Commands
Here are commands you'll use frequently:
| Command | Purpose |
|---|---|
vertaa audit -u <url> | Run an audit |
vertaa audit -u <url> --mode deep | Deep audit with more checks |
vertaa audit -u <url> --fail-on error | Fail if errors found |
vertaa baseline -u <url> -o baseline.json | Create a baseline |
vertaa diff -u <url> --baseline baseline.json | Compare against baseline |
vertaa whoami | Check authentication status |
Was this page helpful?