Installation

Prerequisites

Node.js 22.21.0 or later
pnpm 10.19.0 or later (for self-hosted)
Docker (for self-hosted database)

Install the CLI

The fastest way to get started is with the CLI tool for your CI/CD pipeline:

bash pnpm add -D @ui-inspect/cli

bash npm install -D @ui-inspect/cli

bash yarn add -D @ui-inspect/cli

Or install globally:

pnpm add -g @ui-inspect/cli

Self-hosted setup

If you want to run the full UI Inspect platform locally or on your own infrastructure:

Clone the repository

git clone https://github.com/UdaySagar-Git/ui-inspect.git
cd ui-inspect

Install dependencies

pnpm install

Start the database

docker compose up -d

Configure environment

cp .env.example .env

Edit .env and set your values:

.env

# Database
POSTGRES_URL="postgres://postgres:password@127.0.0.1:5432/ui-inspect"

# Authentication (generate with: openssl rand -base64 32)
AUTH_SECRET="your-secret-here"

# Optional: Google OAuth
AUTH_GOOGLE_ID=""
AUTH_GOOGLE_SECRET=""

Push database schema

pnpm db:push

Start all services

pnpm dev

This starts:

Web app at http://localhost:3002
MCP server at http://localhost:3000
Docs at http://localhost:3003

The web app runs on port 3002 (not 3000) to avoid conflicts with the MCP server.

Verify installation

After setup, verify everything is working:

# Check the web app
curl http://localhost:3002

# Check the MCP server
curl http://localhost:3000

# Check the CLI
npx ui-inspect --version

Next steps

Quick Start Guide — Run your first visual test
Configuration — Configure projects and settings
Authentication — Set up API keys and OAuth

On this page