Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(cli): list valid categories #9399

Merged
merged 2 commits into from
Jul 31, 2019
Merged

doc(cli): list valid categories #9399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b67a40f
cli(help): list available categories
olore Jul 18, 2019
6197539
add example text change
patrickhulce Jul 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions lighthouse-cli/cli-flags.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ function getFlags(manualArgv) {
'Path to JSON file of HTTP Header key/value pairs to send in requests')
.example(
'lighthouse <url> --only-categories=performance,pwa',
'Only run specific categories.')

'Only run the specified categories. Available categories: accessibility, best-practices, performance, pwa, seo')
/**
* Also accept a file for all of these flags. Yargs will merge in and override the file-based
* flags with the command-line flags.
Expand Down Expand Up @@ -129,7 +128,7 @@ function getFlags(manualArgv) {
'precomputed-lantern-data-path': 'Path to the file where lantern simulation data should be read from, overwriting the lantern observed estimates for RTT and server latency.',
'lantern-data-output-path': 'Path to the file where lantern simulation data should be written to, can be used in a future run with the `precomputed-lantern-data-path` flag.',
'only-audits': 'Only run the specified audits',
'only-categories': 'Only run the specified categories',
'only-categories': 'Only run the specified categories. Available categories: accessibility, best-practices, performance, pwa, seo',
'skip-audits': 'Run everything except these audits',
'plugins': 'Run the specified plugins',
'print-config': 'Print the normalized config for the given config and options, then exit.',
Expand Down
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ Examples:
lighthouse <url> --quiet --chrome-flags="--headless" Launch Headless Chrome, turn off logging
lighthouse <url> --extra-headers "{\"Cookie\":\"monster=blue\"}" Stringify\'d JSON HTTP Header key/value pairs to send in requests
lighthouse <url> --extra-headers=./path/to/file.json Path to JSON file of HTTP Header key/value pairs to send in requests
lighthouse <url> --only-categories=performance,pwa Only run the specified categories. Available categories: accessibility,
best-practices, performance, pwa, seo.

For more information on Lighthouse, see https://developers.google.com/web/tools/lighthouse/.
```
Expand Down