Skip to content

fayeed/ai-lighthouse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🚨 AI Lighthouse

SEO and AI Readability Audits - A comprehensive toolkit for auditing websites for AI readiness, SEO optimization, and content quality.

πŸ“¦ Packages

This monorepo contains:

  • packages/scanner - Core scanning engine with 50+ rules for detecting AI readiness issues
  • apps/cli - Command-line interface for running audits and generating reports

πŸš€ Quick Start

Installation

pnpm install

CLI Usage

# Audit a single page
cd apps/cli
pnpm dev audit https://example.com --output html

# Crawl multiple pages
pnpm dev crawl https://example.com --depth 2 --sitemap

# Generate report from saved results
pnpm dev report ./.ai-lighthouse/last_run.json --open

🎯 Features

Scanning Engine (packages/scanner)

  • 50+ Built-in Rules covering:

    • AI Readiness & Comprehension
    • Content Clarity & Quality
    • Extractability & Chunking
    • Knowledge Graph & Schema.org
    • SEO & Crawlability
    • Accessibility (A11y)
    • Security & Performance
  • LLM Integration:

    • Support for OpenAI, Anthropic, Ollama, and local models
    • Hallucination detection
    • Content comprehension analysis
    • Entity extraction
    • FAQ generation
  • Advanced Analysis:

    • Content chunking with token optimization
    • Extractability mapping
    • AI readiness scoring
    • Traditional SEO scoring

CLI (apps/cli)

Three powerful commands:

  1. audit - Audit a single webpage
  2. crawl - Crawl and audit multiple pages
  3. report - Generate and view reports

Output Formats:

  • JSON (CI/CD friendly)
  • HTML (beautiful visualizations)
  • LHR (Lighthouse-compatible)
  • CSV (spreadsheet analysis)

πŸ“– Documentation

πŸ’» Development

# Install dependencies
pnpm install

# Run scanner tests
cd packages/scanner
pnpm dev

# Use the CLI
cd apps/cli
pnpm dev audit https://example.com

πŸ—οΈ Architecture

ai-lighthouse/
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ scanner/          # Core scanning engine
β”‚   β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”‚   β”œβ”€β”€ rules/    # 50+ detection rules
β”‚   β”‚   β”‚   β”œβ”€β”€ llm/      # LLM integration
β”‚   β”‚   β”‚   └── ...       # Core functionality
β”‚   └── utils/            # Shared utilities
└── apps/
    └── cli/              # Command-line interface
        β”œβ”€β”€ src/
        β”‚   └── commands/ # CLI commands
        └── bin/          # Executable entry

🎨 Example Output

AI Readiness Score

╔════════════════════════════════════════════════════════════════╗
β•‘           AI Readiness Assessment for example.com              β•‘
β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

πŸ“Š Overall AI Readiness: 87/100 (B+)

πŸ” Extractability    : 92/100 ⭐⭐⭐⭐⭐
πŸ“ Clarity          : 85/100 ⭐⭐⭐⭐
🧩 Chunkability     : 88/100 ⭐⭐⭐⭐
🎯 Context          : 84/100 ⭐⭐⭐⭐

HTML Report

Beautiful, interactive reports with:

  • Color-coded severity levels
  • Score visualizations
  • Detailed issue breakdowns
  • Entity detection display
  • Actionable remediation steps

πŸ› οΈ CI/CD Integration

# GitHub Actions example
- name: Audit Website
  run: |
    cd apps/cli
    pnpm dev audit ${{ secrets.SITE_URL }} --threshold 80 --output json

Exit code 1 if score is below threshold - perfect for automated quality gates!

πŸ“ License

MIT

🀝 Contributing

Contributions welcome! Please see individual package READMEs for specific contribution guidelines.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • docs: a Next.js app
  • web: another Next.js app
  • @repo/ui: a stub React component library shared by both web and docs applications
  • @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • @repo/typescript-config: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

Build

To build all apps and packages, run the following command:

cd my-turborepo

# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended)
turbo build

# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager
npx turbo build
yarn dlx turbo build
pnpm exec turbo build

You can build a specific package by using a filter:

# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended)
turbo build --filter=docs

# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager
npx turbo build --filter=docs
yarn exec turbo build --filter=docs
pnpm exec turbo build --filter=docs

Develop

To develop all apps and packages, run the following command:

cd my-turborepo

# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended)
turbo dev

# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager
npx turbo dev
yarn exec turbo dev
pnpm exec turbo dev

You can develop a specific package by using a filter:

# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended)
turbo dev --filter=web

# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager
npx turbo dev --filter=web
yarn exec turbo dev --filter=web
pnpm exec turbo dev --filter=web

Remote Caching

Tip

Vercel Remote Cache is free for all plans. Get started today at vercel.com.

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo

# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended)
turbo login

# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager
npx turbo login
yarn exec turbo login
pnpm exec turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

# With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended)
turbo link

# Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager
npx turbo link
yarn exec turbo link
pnpm exec turbo link

Useful Links

Learn more about the power of Turborepo:

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages