https://github.com/dreipol/dreihouse-cli

https://github.com/dreipol/dreihouse-cli

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dreipol/dreihouse-cli
• Owner: dreipol
• Created: 2018-05-18T18:51:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-15T14:03:11.000Z (about 6 years ago)
• Last Synced: 2024-08-11T10:09:22.619Z (3 months ago)
• Language: TypeScript
• Size: 227 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dreihouse-cli

Dreihouse is a tool to run automated lighthouse audits for a webproject. Dreihouse has the advantage

to be more configurable than lighthouse.

# Install

    npm i dreihouse-cli -g

# Commands

    

### `audit  `

This command, launches a headless chrome instance and will run a small set of audits on the given url whenever a file

in the given folder changes.

### `setup `

The setup command will setup the default configuration files in the folder specified in the command.

After setup you have to edit the config to your flavours.

### `report  [--config-file ./config/desktop.js] --reporter [REPORTER]`

        dreihouse report https://example.ch -f ./config/desktop.js -r cli

        

To create a report you have to call this command followed by the config file that holds the configuration

for `dreihouse`. Alternately you can run an audit with a default config by leaving your the config file option.

        dreihouse report https://example.ch -r cli

**list of available reporters**

- `cli` Print lighthouse results in CLI

- `json` Store the whole LH report as JSON

- `json-dashboard` save just `lighthouse-dashboard` specific data

- `html` save the LH report for further inspections

#### Flags

| name             | optional | default  | example                       | description                                         |

| ---------------- | -------- | -------- | ----------------------------- | --------------------------------------------------- |

| `-r, --reporter` | `false`  |          | cli,html,json,json-dashboard | Add list of repprters to handle the data. Available |

| `-f, --config-file`| `true`   |[./config/base.js](./config/base.js)      | `./config/lh.desktop.js` | Define the config file|

| `-p, --port`         | `true`   |   9222   |                               | Debugging port of a running chrome instance         |

| `-v, --verbose`         | `true`   | false     | -v = Error; -vv = Info; -vvvv = Debug | Verbose console output   |

| `-s, --silent`         | `true`   | false     |                               | Suppress spinner on CLI|

#Config

See [@dreipol/lighthouse-runner](https://www.npmjs.com/package/@dreipol/lighthouse-runner) for detailed config