Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 4.31 KB

README.md

File metadata and controls

38 lines (24 loc) · 4.31 KB
Raw

Quickstart:

npx lighthouse-multi --depth=10 --endpoints=http://www.example.com --output=reports

lighthouse-multi is a comparison tool that generates performance reports based on x number of lighthouse audits against a list of endpoints. When run, a JSON file is created that contains averaged metrics for each endpoint.

lighthouse-multi does three things:

  1. With the --depth parameter (optional), you can run x number of Lighthouse audits against a remote or local URL. Each audit generates a JSON file that is saved in a reports folder at the location where lighthouse-multi was run.
  2. With the --endpoints parameter (required), you can run audits against a list of different remote or local URLs. lighthouse-multi will run audits for each of these endpoints and will run x number of audits for each endpoint based on the number passed into the --depth parameter (if --depth is not provided, then only 1 audit is run per endpoint).
  3. Once lighthouse-multi finishes running all audits for each endpoint, it prints averaged performance metrics to the console for each metric. It also saves these averaged metrics to a JSON file in a reports folder at the location where lighthouse-multi was run. These metrics are calculated by taking all previously generated audits inside the reports folder for the given endpoint and averaging out performance metrics based on these audits.

Usage

Installation

To install:

npm install -g lighthouse-multi

or

yarn global add lighthouse-multi

Parameters

Most of the parameters that lighthouse-multi can take are wrapped arguments that are passed straight to Lighthouse. For more comprehensive usage, try the Lighthouse package. lighthouse-ci can also run multiple audits on multiple urls and can calculate the median values of these audits and is more comprehensive for pipeline use, but may require more work to get reporting on all performance metrics.

option type required default description
endpoints string yes This is a comma-separated list of endpoints you want to run Lighthouse audits against. If only testing one endpoint: --endpoints=http://www.example.com If testing more than one endpoint, separate each endpoint by a comma: --endpoints=http://www.example.com,http://www.google.com
depth number no 1 This is the number of Lighthouse audits you want to run per endpoint.
disableStorageReset boolean no false For urls that require credentials, this can allow credentials to persist on each audit. No value is needed for this flag: --disableStorageReset
extraHeaders string no This is a comma-separated list of header=value key-value headers. Values that contain spaces should be wrapped in quotes.
output string no reports This is the destination folder for the generated report.