Getting Started

UI QA is a command-line tool for automated UI/UX testing. It uses browser automation and LLM analysis to identify issues across your website.

Prerequisites

Node.js 18 or later (or Bun)
OpenRouter API key

Installation

Using npx (Recommended)

Run without installation:

bash

npx @usharma124/ui-qa https://example.com

Global Installation

Install for repeated use:

npmbunpnpm

bash

npm install -g @usharma124/ui-qa

bash

bun add -g @usharma124/ui-qa

bash

pnpm add -g @usharma124/ui-qa

Then run from any directory:

bash

ui-qa https://example.com

Project Dependency

Add to your project for CI/CD integration:

npmbun

bash

npm install --save-dev @usharma124/ui-qa

bash

bun add -D @usharma124/ui-qa

Add a script to package.json:

json

{
  "scripts": {
    "test:ui": "ui-qa https://staging.example.com"
  }
}

Browser Setup

Install Chromium on first run:

bash

npx playwright install chromium

Running Your First Test

Set your API key:

bash

export OPENROUTER_API_KEY=sk-or-v1-your-key-here

Run a test:

bash

npx @usharma124/ui-qa https://example.com

View results in .ui-qa-runs/:

File	Contents
`report.md`	Human-readable report
`report.json`	Structured data
`screenshots/`	Visual evidence

Getting Started ​

Prerequisites ​

Installation ​

Using npx (Recommended) ​

Global Installation ​

Project Dependency ​

Browser Setup ​

Running Your First Test ​

Next Steps ​

Getting Started

Prerequisites

Installation

Using npx (Recommended)

Global Installation

Project Dependency

Browser Setup

Running Your First Test

Next Steps