Skip to content

TGiles/auto-lighthouse

Repository files navigation

auto-lighthouse

License npm version

Dependabot Status Master build status Latest master commit

Open issues Closed issues

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