Skip to content

Scan your entire site with Google Lighthouse in 2 minutes (on average). Open source, fully configurable with minimal setup.

License

Notifications You must be signed in to change notification settings

harlan-zw/unlighthouse

Repository files navigation

unlighthouse - Scan your entire website with Google Lighthouse.

NPM version NPM Downloads Docs & Demos
GitHub stars

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

View Demo


Status: v0.12.2 Released 🎉
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 >= 18.x.

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, it's recommended you .gitignore these files.

.unlighthouse

Debugging

If you run into any issues with Unlighthouse, the first step should be to re-run the scan with debugging enabled.

# 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