https://github.com/codewithkyle/lightkeeper

A lighthouse testing, reporting, and budgeting CLI tool.
https://github.com/codewithkyle/lightkeeper

Last synced: 3 months ago
JSON representation

A lighthouse testing, reporting, and budgeting CLI tool.

• Host: GitHub
• URL: https://github.com/codewithkyle/lightkeeper
• Owner: codewithkyle
• License: gpl-3.0
• Created: 2020-07-01T18:20:12.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-14T18:32:11.000Z (almost 2 years ago)
• Last Synced: 2025-03-11T14:52:22.309Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 415 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lightkeeper

An automated lighthouse testing, reporting, and budgeting CLI tool.

## Installation

Install the NPM package:

```sh

npm i -D @codewithkyle/lightkeeper

```

Add the script:

```json

"scripts": {

    "audit": "lightkeeper"

}

```

Run the audit:

```sh

npm run audit

```

## Settings

To test the same URL every time use the `-u` flag.

To output the lightkeeper report JSON add an output directory with the `-o` flag.

```json

"scripts": {

    "audit": "lightkeeper -u https://example.com/ -o ./audits"

}

```