Skip to content
nitishagarPublic

About

Lighthouse reimagined for the AI-first world

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Latest commit

 

History

46 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SoberAI Optimizer

License: MIT Node.js Version GitHub Issues GitHub Stars Version CI

sober-ai(2)

Lighthouse for the AI Age - A free, open-source website auditing tool that evaluates and optimizes websites for AI agent interactions.

Overview

With 1 billion+ monthly AI crawler requests (GPTBot, ClaudeBot, PerplexityBot), optimizing for AI visibility is no longer optional. SoberAI is the first specialized tool for ensuring your website works perfectly with AI agents, LLMs, and autonomous browsing systems.

What It Audits

Category Weight Description
SSR Readiness 20% Server-side rendering for AI agents that don't execute JavaScript
Schema Coverage 20% Structured data (Schema.org) for AI understanding
Semantic Structure 20% HTML5 semantic elements and heading hierarchy
Content Extractability 20% Text readability and accessibility for LLMs
Machine Readability 20% AI crawler access (robots.txt, llms.txt, sitemap, OpenGraph)

AI-powered recommendations default to an OpenAI-compatible key (OpenAI, NVIDIA NIM, or any /chat/completions endpoint, including bring-your-own-key mode that never stores the key server-side). Ollama local/cloud and Anthropic stay available as opt-ins. Without any key, audits complete with finding-based recommendations.

Quick Start

Option 1: Desktop App

Download the latest release for your platform from the Releases page.

Option 2: From Source

# Clone and install
git clone https://github.com/nitishagar/sober-ai.git
cd sober-ai
npm install

# Build frontend
cd frontend && npm install && npm run build && cd ..

# Set up database
npx prisma generate --schema=src/db/schema.prisma
npx prisma migrate deploy --schema=src/db/schema.prisma

# Start the server
node src/api/server.js
# Open http://localhost:3000/app

Option 3: Electron Development

npm run electron:dev

Option 4: Chrome Extension

Start the backend (Option 2), then load extension/ unpacked at chrome://extensions (Developer mode). Audit the active tab from the popup; keys stay in chrome.storage.local. See extension/README.md.

LLM Setup (Optional)

Set an OpenAI-compatible key — environment, Settings page, or bring-your-own-key mode:

export OPENAI_API_KEY=sk-...

Or go fully local: install Ollama, run ollama pull qwen3:4b, and select ollama_local in Settings.

Usage

  1. Navigate to the Audit page
  2. Enter a URL (e.g., https://vercel.com)
  3. Click Run Audit and watch real-time progress (auto-reconnects on network interruption)
  4. Review scores across 5 categories, findings, and AI recommendations
  5. Compare reports over time to track improvements
  6. Configure your LLM provider in Settings

Architecture

Electron Shell
├── React Frontend (BrowserWindow)
├── Express.js Backend (in-process)
├── SQLite Database (Prisma ORM)
├── Playwright (browser automation)
└── LLM Provider (OpenAI-compatible default; Ollama local/cloud or Anthropic opt-in)

Key Technologies

  • Desktop: Electron
  • Backend: Express.js + Node.js 22+
  • Frontend: React + Vite
  • Database: SQLite via Prisma
  • Browser: Playwright
  • LLM: OpenAI-compatible default (OpenAI, NVIDIA NIM, self-hosted gateways); Ollama or Anthropic opt-in
  • Extension: Chrome MV3 tab audit (no build step)

Testing

npm test              # Run all tests (Jest unit + integration suites)
npm run test:unit     # Unit tests only
npm run test:integration  # Integration tests only
npm run test:ci       # CI mode (all tests, force exit)
npm run verify        # Run tests + lint
npm run test:e2e      # Playwright E2E tests (browser)
npm run verify:full   # Unit + integration + lint + E2E

First-time E2E setup (installs Chromium, ~400MB):

npm run test:e2e:install

The test suite covers:

  • Unit tests: All 5 audit classes (score boundaries, severity, findings), scorer, validator, LLM analyzer, provider factory
  • Integration tests: SSE streaming (reconnect, error paths), audit pipeline, settings, reports (CRUD + compare), provider routing, health
  • E2E tests: Audit happy-path (real SSE + DB), reports list/detail, health banner, SSE reconnect branch (tests/e2e/)

Documentation

Full documentation available at nitishagar.github.io/sober-ai.

Contributing

We welcome contributions! See the Contributing Guide for development setup and guidelines.

License

MIT License - see LICENSE for details.

Copyright 2025-2026 Nitish Agarwal

Support


Version 0.4.0 | Changelog

About

Lighthouse reimagined for the AI-first world

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages