oleggromov / rushy

A tiny wrapper around Lighthouse

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rushy

This is a tiny wrapper around Lighthouse with some conveniences to run continious audits on your website pages.

Installation

You'll need to have Google Chrome installed, as Lighthouse runs audits using it. To install rushy just do:

yarn global add rushy

Usage

rushy --config=/path/to/your/config.json

Configuration .json file should look something like:

{
  "urls": ["http://example.com"],
  "storeDir": "./reports",
  "reporter": "html",
  "reportQuery": {
    "Time to First Byte": "$.audits['time-to-first-byte'].rawValue"
  }
}

Make sure to provide configuration suitable for your needs. More info can be found here.

When completed, the audit will be stored as a .csv file. What do next is up to you. For example, you can:

  • commit reports to your git repository
  • upload somewhere
  • build historical data, charts, etc...

About

A tiny wrapper around Lighthouse


Languages

Language:TypeScript 90.0%Language:CSS 5.5%Language:HTML 2.5%Language:JavaScript 2.0%