Cyclop CLI
CLI to run Lighthouse-CLI multiple times, get aggregated value, and generate a raw report for you.
Installation
# NPM
$ npm i -g cyclop-cli
# YARN
$ yarn add -g cyclop-cli
# PNPM
$ pnpm i -g cyclop-cli
Usage
Version Check
$ cyclop-cli -v
# OR
$ cyclop-cli --version
Help Command
$ cyclop-cli -h
# OR
$ cyclop-cli --help
Interactive Command
$ cyclop-cli interactive
CLI Command
$ cyclop-cli test -u=YOUR_URL -d -n=3 -c=cookieA=valueA -c=cookieB=valueB
Available Arguments on CLI
Argument | Alias | Description | Data Type | Default Value |
---|---|---|---|---|
--url |
-u |
URL to be tested | String |
required |
--num |
-n |
Number do you want to run the job | Number |
1 |
--desktop |
-d |
Use desktop device instead of mobile | Boolean |
false |
--show-ui |
-ui |
Show the browser UI when testing | Boolean |
false |
--raw |
-r |
Generate raw report | Boolean |
false |
--screenshot |
-s |
Take a screenshot using puppeteer | Boolean |
false |
--cookie |
-c |
Additional cookies pair (key=value) | Array |
empty |
Use latest configuration
$ cyclop-cli file ./config.json
The root path will refer to ./cyclop-cli-reports/{YOUR_CONFIG_FILE}
Reports
The reports will be placed on cyclop-cl-reports
directory.
It will produce several report:
# JSON report to be viewed in the Ligthouse report viewer
# View on: https://googlechrome.github.io/lighthouse/viewer/
- raw-report-2021-06-04T03:23:52.038Z.json
# Screenshots, to check the UI crawled by cyclop-cli
- screenshot-mobile-www.tokopedia.com--2021-06-04T03:23:30.967Z.png
# Aggregated summary in CSV and JSON
- summary.csv
- summary.json
Maintainers
© 2019 {code} by Web Platform Team @ Tokopedia