Authentication

UI Inspect supports two authentication methods:

API key authentication

API keys are used for CLI tools, CI/CD pipelines, and programmatic access.

Create an API key

1. Go to your dashboard at Settings → API Keys
2. Click Create API Key
3. Give it a descriptive name (e.g., "GitHub Actions CI")
4. Copy the full key — it's only shown once

API keys use the format uii_<64-character-hex> and are sent as Bearer tokens:

# CLI usage
export UI_INSPECT_TOKEN="uii_your-full-api-key"
npx ui-inspect build --project your-project-id

# HTTP usage
curl -H "Authorization: Bearer uii_your-full-api-key" \
  http://localhost:3000/api/trpc/project.list

Key management

Revoking a key immediately invalidates it across all services.

Session authentication

The web dashboard and browser extension use session-based authentication via Better Auth.

Supported providers

Google OAuth setup

1. Go to Google Cloud Console
2. Create OAuth 2.0 credentials
3. Set authorized redirect URI to http://localhost:3002/api/auth/callback/google
4. Add credentials to .env:

AUTH_GOOGLE_ID="your-google-client-id"
AUTH_GOOGLE_SECRET="your-google-client-secret"

CI/CD secrets

Never commit tokens to your repository. Use your CI provider's secret management:

GitHub Actions

env:
  UI_INSPECT_TOKEN: ${{ secrets.UI_INSPECT_TOKEN }}

GitLab CI

variables:
  UI_INSPECT_TOKEN: $UI_INSPECT_TOKEN # Set in CI/CD Settings → Variables

CircleCI

Set UI_INSPECT_TOKEN in Project Settings → Environment Variables.

Permissions

API keys inherit the permissions of the user who created them: