@unlighthouse/cli

@unlighthouse/cli

The command-line interface and CI integration for Unlighthouse, enabling automated website scanning in development and deployment workflows.

Installation

# Use directly with npx
npx unlighthouse --site https://example.com

# Or install globally
npm install -g @unlighthouse/cli

Usage

Basic Scanning

# Scan a website
unlighthouse --site https://example.com

# Enable debug mode
unlighthouse --site https://example.com --debug

# Mobile device simulation
unlighthouse --site https://example.com --mobile

Advanced Options

# Multiple samples with throttling
unlighthouse --site https://example.com --samples 3 --throttle

# Custom URLs and exclusions
unlighthouse --site https://example.com --urls /home,/about,/contact --exclude-urls /admin/*

# With custom configuration
unlighthouse --site https://example.com --config-file ./my-config.ts

CI Integration

# CI mode with exit codes for failed audits
unlighthouse-ci --site https://example.com --budget 75

Configuration

Create unlighthouse.config.ts in your project root:

import { defineUnlighthouseConfig } from 'unlighthouse/config'

export default defineUnlighthouseConfig({
  site: 'https://example.com',
  debug: true,
  scanner: {
    device: 'desktop',
    throttle: false,
  },
  lighthouseOptions: {
    onlyCategories: ['performance', 'accessibility'],
  }
})

Documentation

• CLI Integration Guide
• CI Integration Guide
• Configuration Reference

License

MIT License 2021-PRESENT Harlan Wilton