Skip to content

Commit d34e5bb

Browse files
authored
readme: include CLI flags
1 parent 2fdde48 commit d34e5bb

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

readme.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,38 @@ Lighthouse can be used to analyze trace and performance data collected from othe
9999
Then, run with: `lighthouse --config-path=$PWD/config.json http://www.random.url`
100100

101101

102+
## Lighthouse CLI options
103+
104+
```sh
105+
$ lighthouse --help
106+
107+
lighthouse <url>
108+
109+
Logging:
110+
--verbose Displays verbose logging [boolean]
111+
--quiet Displays no progress or debug logs [boolean]
112+
113+
Configuration:
114+
--mobile Emulates a Nexus 5X [default: true]
115+
--load-page Loads the page [default: true]
116+
--save-assets Save the trace contents & screenshots to disk [boolean]
117+
--save-artifacts Save all gathered artifacts to disk [boolean]
118+
--audit-whitelist Comma separated list of audits to run [default: "all"]
119+
--list-all-audits Prints a list of all available audits and exits [boolean]
120+
--list-trace-categories Prints a list of all required trace categories and exits [boolean]
121+
--config-path The absolute path to the config JSON.
122+
123+
Output:
124+
--output Reporter for the results
125+
[choices: "pretty", "json", "html"] [default: "pretty"]
126+
--output-path The file path to output the results
127+
Example: --output-path=./lighthouse-results.html [default: "stdout"]
128+
129+
Options:
130+
--help Show help [boolean]
131+
--version Show version number [boolean]
132+
```
133+
102134
## Tests
103135

104136
Some basic unit tests forked are in `/test` and run via mocha. eslint is also checked for style violations.

0 commit comments

Comments
 (0)