uxaudit 0.1.2

UX/UI audit tool with screenshots and Gemini analysis

uxaudit

UX/UI audit tool that captures screenshots and analyzes them with Gemini.

Highlights

• Full-page and section screenshots with evidence links.
• Multi-page crawling from header, nav, and footer.
• Structured JSON output for agents and pipelines.

Requirements

• Python 3.10+
• Playwright browsers: playwright install
• Gemini API key: GEMINI_API_KEY (or GOOGLE_API_KEY)

Install

PyPI

python3 -m pip install uxaudit

Editable (dev)

python3 -m pip install -e .[dev]

Usage

export GEMINI_API_KEY="your-key"
uxaudit analyze https://example.com --model flash

Outputs are written to runs/<run_id>/ with manifest.json and report.json.

Crawling multiple pages

uxaudit analyze https://example.com --max-pages 5

Style consistency analysis

By default uxaudit runs a cross-screenshot style consistency pass. You can disable it or tune the batch size:

uxaudit analyze https://example.com --no-style-consistency
uxaudit analyze https://example.com --style-consistency-batch-size 10

Login (form-based)

# Example with fake credentials
export UXAUDIT_AUTH_USERNAME="[e-mail]"
export UXAUDIT_AUTH_PASSWORD="P@ssw0rd-Example-123"

uxaudit analyze https://demo.example.test \\
  --auth-mode form \\
  --auth-login-url https://demo.example.test/login \\
  --auth-post-login-url https://demo.example.test/app \\
  --auth-username-selector "#email" \\
  --auth-password-selector "#password" \\
  --auth-submit-selector "button[type=submit]" \\
  --auth-success-selector ".dashboard"

Login (storage state)

uxaudit analyze https://app.example.com \\
  --auth-mode storage_state \\
  --auth-storage-state /path/to/storage_state.json

Development

ruff check .
ruff format .
mypy uxaudit
pytest

Project links

• Source: https://github.com/albertoburgosplaza/uxaudit
• Issues: https://github.com/albertoburgosplaza/uxaudit/issues
• Changelog: https://github.com/albertoburgosplaza/uxaudit/blob/main/CHANGELOG.md

CLI options

uxaudit analyze --help