https://github.com/tgiles/auto-lighthouse

A utility package for automating lighthouse reporting
https://github.com/tgiles/auto-lighthouse

audits auto-lighthouse crawler lighthouse-reports robots simplecrawler

Last synced: 6 days ago
JSON representation

A utility package for automating lighthouse reporting

• Host: GitHub
• URL: https://github.com/tgiles/auto-lighthouse
• Owner: TGiles
• License: gpl-3.0
• Created: 2019-08-17T21:49:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-24T20:57:27.000Z (almost 2 years ago)
• Last Synced: 2024-12-01T11:07:26.986Z (25 days ago)
• Topics: audits, auto-lighthouse, crawler, lighthouse-reports, robots, simplecrawler
• Language: HTML
• Size: 2.12 MB
• Stars: 133
• Watchers: 3
• Forks: 20
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# auto-lighthouse

[![License](https://badgen.net/github/license/TGiles/auto-lighthouse)](https://github.com/TGiles/auto-lighthouse/LICENSE)

[![npm version](https://badgen.net/npm/v/auto-lighthouse)](https://www.npmjs.com/package/auto-lighthouse)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=TGiles/auto-lighthouse)](https://dependabot.com)

[![Master build status](https://badgen.net/github/status/TGiles/auto-lighthouse)](https://github.com/TGiles/auto-lighthouse/actions)

[![Latest master commit](https://badgen.net/github/last-commit/TGiles/auto-lighthouse/master)](https://github.com/TGiles/auto-lighthouse/commits/master)

[![Open issues](https://badgen.net/github/open-issues/TGiles/auto-lighthouse)](https://github.com/TGiles/auto-lighthouse/issues)

[![Closed issues](https://badgen.net/github/closed-issues/TGiles/auto-lighthouse)](https://github.com/TGiles/auto-lighthouse/issues?q=is%3Aissue+is%3Aclosed)

A CLI for crawling one or more domains and generating both mobile and desktop reports for each page.

**Note: You will need a version of Chrome or Chromium installed for this package to work as expected.**

## How to use via NPM

* `npx auto-lighthouse`

    * This command should print the help output

* `npm install auto-lighthouse` or `npm install -g auto-lighthouse`

 * `auto-lighthouse`

    * Verify that you recieve the help output

* `auto-lighthouse -u some_url -e true`

## How to use when contributing back to repository

* Fork the repository

* Navigate to the project root

* `npm install`

* `npm link`

* `auto-lighthouse`

    * Verify help output

* Make some changes

* Make a pull request

* `npm unlink auto-lighthouse`