All Commands

Complete reference for all commands available in the VertaaUX CLI.

Command Overview

Command	Description	Category
audit	Run UX and accessibility audits	Core
baseline	Create audit baselines	Core
diff	Compare audit results	Core
policy	Manage policy-as-code	Core
login	Authenticate with VertaaUX	Auth
logout	Clear stored credentials	Auth
whoami	Show authentication status	Auth
init	Initialize project configuration	Setup
status	Get audit job status	Utility
comment	Generate PR comment markdown	CI/CD
upload	Upload audit results to cloud	Storage
download	Download audit results from cloud	Storage
explain	Show evidence bundle for finding	Analysis
fix	Generate fix patch for issue	Remediation
fix-all	Generate patches for all issues	Remediation
verify	Verify patch fixes issue	Remediation
a11y	Accessibility-focused audit	Alias
scan	UX scan (alias for audit)	Alias
compare	Compare two URL audits	Alias

Core Commands

audit

Run UX and accessibility audits on websites.

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

Key Options:

Option	Description
`-u, --url`	URL to audit (required)
`--mode`	Audit depth: basic, standard, deep
`--format`	Output: human, json, sarif, junit, html
`-o, --output`	Write results to file
`--fail-on`	Exit 1 on severity: error, warning, info
`--threshold`	Exit 3 if score below value
`--baseline`	Compare against baseline file

Full audit reference

baseline

Create and manage audit baselines for tracking improvements.

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

Key Options:

Option	Description
`-u, --url`	URL to audit for baseline
`-o, --output`	Output file path
`--update`	Update existing baseline
`--mode`	Audit mode for baseline

Full baseline reference

diff

Compare two audit results to identify changes.

$vertaa diff --before old.json --after new.json

Key Options:

Option	Description
`--baseline`	Compare against baseline file
`--before`	First audit (file or URL)
`--after`	Second audit (file or URL)
`--format`	Output: human, json, markdown

Full diff reference

policy

Manage policy-as-code configuration.

$vertaa policy init

Subcommands:

Subcommand	Description
`init`	Create starter policy file
`validate`	Check policy syntax
`show`	Display effective policy
`schema`	Output JSON schema

Full policy reference

Authentication Commands

Authenticate with your VertaaUX account.

$vertaa login

Prompts for your API key and stores credentials in ~/.vertaaux/config.json.

Options:

Option	Description
`--key`	Provide API key directly (not recommended)
`--no-save`	Don't store credentials

logout

Clear stored credentials.

$vertaa logout

Removes credentials from ~/.vertaaux/config.json.

whoami

Show current authentication status.

$vertaa whoami

Authenticated as: user@example.com
Plan: Pro
Credits remaining: 950/1000

Setup Commands

init

Initialize VertaaUX configuration in your project.

$vertaa init

Creates .vertaaux.yml with sensible defaults.

Options:

Option	Description
`--url`	Default URL for audits
`--mode`	Default audit mode
`--ci`	Include CI/CD templates
`--policy`	Also create policy file

Utility Commands

status

Get the status of an audit job.

$vertaa status job_abc123

Options:

Option	Description
`--wait`	Wait for job completion
`--format`	Output format: human, json

comment

Generate PR comment markdown from audit results.

$vertaa comment --file results.json --format github

Options:

Option	Description
`--file`	Audit results file
`--format`	Platform: github, gitlab, bitbucket
`--post`	Actually post comment (requires token)
`--pr`	PR number for posting

CI Integration

Use vertaa comment in CI to automatically add audit summaries to pull requests.

Storage Commands

upload

Upload audit results to VertaaUX cloud storage.

$vertaa upload results.json

Returns a shareable link to the results.

Options:

Option	Description
`--name`	Custom name for the upload
`--expires`	Expiration: 1d, 7d, 30d, never
`--public`	Make publicly accessible

download

Download audit results from cloud storage.

$vertaa download abc123 -o results.json

Arguments:

Argument	Description
`id`	Upload ID or share token

Options:

Option	Description
`-o, --output`	Output file path

Analysis Commands

explain

Show detailed evidence bundle for a specific finding.

$vertaa explain finding_abc123

Displays:

Full rule description
Why this matters (impact)
Screenshots/DOM snapshots
Suggested fixes
Related findings

Options:

Option	Description
`--format`	Output: human, json, html
`--evidence`	Download evidence files

Remediation Commands

fix

Generate a fix patch for a specific issue.

$vertaa fix finding_abc123

Outputs a git-compatible patch to fix the issue.

Options:

Option	Description
`--apply`	Apply patch directly
`--file`	Path to source file
`-o, --output`	Write patch to file

fix-all

Generate patches for all fixable issues.

$vertaa fix-all results.json -o patches/

Creates individual patch files for each fixable issue.

Options:

Option	Description
`--apply`	Apply all patches
`-o, --output`	Output directory
`--severity`	Filter by severity

Review Before Applying

Always review generated patches before applying. AI-generated fixes may need manual adjustment.

verify

Verify that a patch successfully fixes an issue.

$vertaa verify finding_abc123 --patch fix.patch

Runs a targeted audit to confirm the issue is resolved.

Options:

Option	Description
`--patch`	Patch file to verify
`--url`	URL to test against

Alias Commands

These commands are aliases for common operations:

Accessibility-focused audit. Alias for audit --category accessibility.

$vertaa a11y -u https://example.com

scan

General UX scan. Alias for audit.

$vertaa scan -u https://example.com

compare

Compare two URLs directly. Alias for diff --before <url1> --after <url2>.

$vertaa compare https://v1.example.com https://v2.example.com

Global Options

These options work with any command:

Option	Description
`--help, -h`	Show help for command
`--version, -V`	Show CLI version
`--verbose, -v`	Verbose output
`--quiet, -q`	Suppress non-essential output
`--no-color`	Disable colored output
`--config`	Path to config file

Environment Variables

Variable	Description
`VERTAA_API_KEY`	API key for authentication
`VERTAA_DEFAULT_URL`	Default URL for audits
`VERTAA_CONFIG`	Path to config file
`NO_COLOR`	Disable colored output
`HTTPS_PROXY`	Proxy server URL

Exit Codes

Code	Meaning
`0`	Success
`1`	Issues found / Quality gate failed
`2`	Command error (invalid input, network error)
`3`	Score below threshold
`130`	Interrupted (Ctrl+C)

Quickstart

Get started in 5 minutes

Configuration

Configure defaults with .vertaaux.yml

CI/CD Integration

Automate audits in your pipeline

Was this page helpful?

All Commands

Quickstart

Configuration

CI/CD Integration

On this page