Official CLI Reference & Headless Testing

Planned — not yet shipped. The content below is the target design for this integration. The currently available developer surface is the UI Designer MCP server with uidesigner_resolve_link.

The UIDesigner CLI

The @uidesigner/cli package brings the power of UIDesigner directly into your local terminal and automated build pipelines.

Installation & Setup

Install the CLI globally or as a project dev-dependency:

# Global installation via npm
npm install -g @uidesigner/cli

# Or run on-demand with npx
npx @uidesigner/cli --version

Authenticate your CLI with your workspace:

uidesigner login

This opens your default browser for instant passwordless authorization.

Core CLI Commands

1. Run Headless Audit

Inspect any staging or production URL:

uidesigner audit https://example.com --viewports=mobile,desktop --wcag

2. Test Localhost Development Servers

Verify accessibility and responsive layouts on your local development build before pushing code:

uidesigner audit http://localhost:3000 --min-score=90

3. Machine-Readable JSON Export

Pipe audit results directly into your automated reporting tools:

uidesigner audit https://example.com --format=json > audit-results.json

4. Create Review Snapshot

Create a new review version programmatically from a CI preview deployment:

uidesigner review create --project="Marketing Site" --url="https://preview-123.app" --label="PR #123"