AI Lighthouse CLI

Integrate AI readiness checks directly into your development workflow. Perfect for CI/CD pipelines and automated testing.

Installation

Install the CLI globally using your preferred package manager

npm install -g @ai-lighthouse/cli

Quick Start

Run your first audit in seconds

Basic Audit

ai-lighthouse audit https://example.com

Generate HTML Report

ai-lighthouse audit https://example.com --output html

Interactive Setup Wizard

ai-lighthouse wizard

Recommended for first-time users - guides you through configuration options

Commands

Complete command reference

audit

Audit a single webpage for AI readiness

Common Options

-o, --output <format>Output format: json, html, lhr, csv (default: json)
--enable-llmEnable LLM comprehension analysis
--enable-chunkingEnable detailed content chunking analysis
--enable-extractabilityEnable extractability mapping
--threshold <score>Minimum score threshold (exit 1 if below)

Example

ai-lighthouse audit https://example.com \
  --output html \
  --enable-llm \
  --enable-chunking \
  --llm-provider ollama \
  --llm-model qwen2.5:0.5b

crawl

Crawl and audit multiple pages from a website

Options

-d, --depth <number>Maximum crawl depth (default: 2)
--sitemapParse sitemap.xml for URLs
--max-pages <number>Maximum number of pages to crawl (default: 50)
-o, --output <format>Output format: json, html (default: json)

Example

ai-lighthouse crawl https://example.com \
  --sitemap \
  --max-pages 100 \
  --depth 3

report

Generate and view reports from saved audit results

Options

--openOpen the report in browser
-f, --format <format>Output format: html, json, csv (default: html)

Example

ai-lighthouse report ./.ai-lighthouse/last_run.json --open

Features

Everything you need for AI readiness testing

Command Line Power

Run comprehensive AI audits directly from your terminal

CI/CD Integration

Integrate with GitHub Actions, GitLab CI, and other platforms

Multiple Output Formats

Export results as JSON, HTML, CSV, or Lighthouse-compatible format

Highly Configurable

Control every aspect of the audit with detailed options

Interactive Wizard

Guided setup for new users with sensible defaults

Score Thresholds

Set minimum score requirements and fail builds automatically

CI/CD Integration

Automate AI readiness checks in your deployment pipeline

GitHub Actions Example

name: AI Readiness Check
on: [push, pull_request]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install AI Lighthouse CLI
        run: npm install -g @ai-lighthouse/cli

      - name: Run AI Audit
        run: ai-lighthouse audit https://yoursite.com --threshold 80

      - name: Upload Report
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: ai-lighthouse-report
          path: .ai-lighthouse/

Use the --threshold flag to fail builds when scores drop below your minimum requirements.

Ready to Get Started?

Install the CLI and run your first audit today