An open API service indexing awesome lists of open source software.

https://github.com/harlan-zw/unlighthouse

Run Google Lighthouse on your entire site.
https://github.com/harlan-zw/unlighthouse

google-lighthouse puppeteer site-audit

Last synced: 2 months ago
JSON representation

Run Google Lighthouse on your entire site.

Awesome Lists containing this project

README

          

![unlighthouse - Scan your entire website with Google Lighthouse.](https://repository-images.githubusercontent.com/423079536/c88a81ee-43ec-40fc-a615-1d29bbeaaeb4)

Unlighthouse

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]


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

View Demo


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

## Quick Setup

Run the following command:

```bash
npx unlighthouse --site
# or PNPM
pnpm dlx unlighthouse --site
```

> [!TIP]
> Generate an Agent Skill for this package using [skilld](https://github.com/harlan-zw/skilld):
> ```bash
> npx skilld add unlighthouse
> ```

_Requirements: Node >= 20.x._

## Getting Started

Install instructions for all integrations can be found on the [docs](https://unlighthouse.dev/) site.

Need a hand? Join the [Discord](https://discord.gg/275MBUBvgP) for one-on-one help.

### gitignore

Unlighthouse will save your reports in `outputDir`,
it's recommended you .gitignore these files.

```shell
.unlighthouse
```

#### Debugging

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

```bash
# 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](https://unlighthouse.dev/) site.

## Sponsors



Sponsors

## License

Licensed under the [MIT license](https://github.com/harlan-zw/unlighthouse/blob/main/LICENSE.md).

[npm-version-src]: https://img.shields.io/npm/v/unlighthouse/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/unlighthouse

[npm-downloads-src]: https://img.shields.io/npm/dm/unlighthouse.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/unlighthouse

[license-src]: https://img.shields.io/github/license/harlan-zw/unlighthouse.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/harlan-zw/unlighthouse/blob/main/LICENSE.md