Unlighthouse scans your entire site using Google Lighthouse,
with a modern UI, minimal config and smart sampling.

View Demo

Status: Beta Made possible by my Sponsor Program 💖 Follow me @harlan_zw 🐦 • Join Discord for help

Quick Setup

Run the following command:

npx unlighthouse --site <your-site>
# or PNPM
pnpm dlx unlighthouse --site <your-site>

Requirements: Node 14.x or higher, Node 16.x recommended.

By default, Unlighthouse will try and find your Google Chrome installation and use that with puppeteer. If you have issues with that you can install puppeteer globally.

npm install -g puppeteer

Getting Started

Install instructions for all integrations can be found on the docs site.

Need a hand? Join the Discord for one-on-one help.

gitignore

Unlighthouse will save your reports in outputDir (.unlighthouse by default), it's recommended you .gitignore these files.

Debugging

As Unlighthouse is in beta, it's recommended you run it in debug mode.

# NPM
npx unlighthouse --site unlighthouse.dev --debug
# or PNPM
pnpm dlx unlighthouse --site unlighthouse.dev  --debug

Docs

Integration instructions, Guides, API and config spec can be found on docs site.

Sponsors

License

MIT License © 2022 Harlan Wilton