Kuality CLI

Scan any website for accessibility, performance, SEO, cross-browser, stress testing, and 30+ QA dimensions — from your terminal.

Install

Homebrew (macOS and Linux):

brew install kuality-io/tap/kuality

Go:

go install github.com/kuality-io/cli@latest

Binary: download from Releases.

Quick start

# Authenticate with your API key (get one at https://kuality.io/settings/api-keys)
kuality auth login

# Run a scan
kuality scan example.com

# Run a specific scan type
kuality scan example.com --type a11y

# Fail CI if high-severity findings exist
kuality scan example.com --type a11y --fail-on high

# JSON output for scripting
kuality scan example.com --format json

# JUnit XML for CI test reporting
kuality scan example.com --format junit > results.xml

Commands

Command	Description
kuality scan <url>	Run a quality scan
kuality status <scan-id>	Check scan status
kuality reports list	List recent reports
kuality reports show <id>	Show report details
kuality targets	List configured targets
kuality score	Show Kuality Scores
kuality auth login	Store API key
kuality auth status	Check auth status
kuality auth logout	Remove stored API key

Scan types

37 scan types across 8 categories:

Category	Types
Core quality	a11y, webvitals, seo, formaudit, brokenlinks, cookie, headers, jsaudit, tech, cms, api
Cross-browser	firefox, webkit
Advanced UX	uxaudit, animation, colorblind, assets, screenreader
Performance	performancebudget, assetaudit, bundlesize, ttfb, throttle, memoryleak
Mobile	touchaudit, touchsize, orientation, pwa, mobilelighthouse
API testing	contract, graphql, openapi
Web compliance	privacyscan, csp, cors
Monitoring	synthetic, cdnaudit

CI/CD integration

GitHub Actions

- name: Quality scan
  run: |
    kuality scan ${{ vars.SITE_URL }} --type a11y --fail-on high --format junit > kuality-results.xml

- name: Upload results
  uses: actions/upload-artifact@v4
  with:
    name: kuality-results
    path: kuality-results.xml

GitLab CI

quality_scan:
  script:
    - kuality scan $SITE_URL --type a11y --fail-on high --format junit > kuality-results.xml
  artifacts:
    reports:
      junit: kuality-results.xml

Generic CI

export KUALITY_API_KEY="your-key"
kuality scan example.com --type a11y --fail-on high --quiet

Exit codes: 0 = pass, 1 = findings exceed --fail-on threshold.

Authentication

Three methods, in order of precedence:

1. --api-key flag
2. KUALITY_API_KEY environment variable
3. ~/.kuality/config.yaml (set via kuality auth login)

API keys start with ku_ and are stored with 0600 file permissions.

Global flags

Flag	Short	Description
--api-key		API key override
--format	-f	Output format: table, json, junit
--quiet	-q	Suppress progress output
--version	-v	Show version
--help	-h	Show help

License

MIT. See LICENSE.