Skip to content

Commit e8fca67

Browse files
marcelduranmarcelduran
committed
updated readme test options
1 parent 6ba8784 commit e8fca67

1 file changed

Lines changed: 72 additions & 68 deletions

File tree

‎README.md‎

Lines changed: 72 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ $ webpagetest --help
4949
* **request** _[options] <\id\>_: get the request data from test
5050
* **timeline** _[options] \<id\>_: get the Chrome Developer Tools Timeline data (if available) from test
5151
* **netlog** _[options] \<id\>_: get the Chrome Developer Tools Net log data (if available) from test
52+
* **chrometrace** _[options] \<id\>_: get the Chrome Trace data (if available) from test
5253
* **console** _[options] \<id\>_: get the browser console log data (if available) from test
5354
* **testinfo** _\<id\>_: get test request info/details
5455
* **history** _[days]_: get history of previously run tests
@@ -72,58 +73,59 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
7273

7374
#### Test (works for **test** command only)
7475
* **-l, --location** _\<location\>_: location to test from
76+
* **-y, --connectivity** _\<profile\>_: connectivity profile (Cable|DSL|FIOS|Dial|3G|3GFast|Native|custom) [Cable]
7577
* **-r, --runs** _\<number\>_: number of test runs [1]
7678
* **-f, --first**: skip the Repeat View test
77-
* **-L, --label** _\<label\>_: label for the test
78-
* **-p, --private**: keep the test hidden from the test log
7979
* **-v, --video**: capture video
80-
* **-y, --connectivity** _\<profile\>_: connectivity profile (Cable|DSL|FIOS|Dial|3G|3GFast|Native|custom) [Cable]
80+
* **-p, --private**: keep the test hidden from the test log
81+
* **-L, --label** _\<label\>_: label for the test
82+
* **-i, --onload**: stop test at document complete. typically, tests run until all activity stops
83+
* **-S, --noscript**: disable javascript (IE, Chrome, Firefox)
84+
* **-C, --clearcerts**: clear SSL cetificate caches
85+
* **-R, --ignoressl**: ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
86+
* **-T, --standards**: forces all pages to load in standards mode (IE only)
87+
* **-u, --tcpdump**: capture network packet trace (tcpdump)
88+
* **-O, --bodies**: save response bodies for text resources
89+
* **-K, --keepua**: do not add PTST to the original browser User Agent string
8190
* **-m, --dom** _\<element\>_: DOM element to record for sub-measurement
82-
* **-c, --connections** _\<number\>_: override the number of concurrent connections
83-
* **-i, --onload**: force the test to stop at window.onload
84-
* **-t, --sensitive**: discard script and http headers in the result
85-
* **-b, --block** _\<urls\>_: space-delimited list of urls to block (substring match)
91+
* **-N, --duration** _\<seconds\>_: minimum test duration in seconds
92+
* **-E, --tester** _\<name\>_: run the test on a specific PC (name must match exactly or the test will not run)
93+
* **-W, --mobile**: (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
94+
* **-M, --timeline**: capture Developer Tools Timeline (Chrome only)
95+
* **-J, --callstack**: set between 1-5 to include the JS call stack. must be used in conjunction with timeline (increases overhead) (Chrome only)
96+
* **-q, --chrometrace**: capture chrome trace (about://tracing) (Chrome only)
97+
* **-G, --netlog**: capture Network Log (Chrome only)
98+
* **-Q, --datareduction**: enable data reduction on Chrome 34+ Android (Chrome only)
99+
* **-x, --useragent** _\<string\>_: custom user agent string (Chrome only)
100+
* **-X, --cmdline** _\<switches\>_: use a list of custom command line switches (Chrome only)
86101
* **-g, --login** _\<username\>_: username for authenticating tests (http authentication)
87102
* **-w, --password** _\<password\>_: password for authenticating tests (http authentication)
103+
* **-t, --sensitive**: discard script and http headers in the result
104+
* **-H, --noheaders**: disable saving of the http headers (as well as browser status messages and CPU utilization)
105+
* **-b, --block** _\<urls\>_: space-delimited list of urls to block (substring match)
106+
* **-Z, --spof** _\<domains\>_: space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
107+
* **-c, --custom** _\<script\>_: execute arbitrary javascript at the end of a test to collect custom metrics
88108
* **-a, --authtype** _\<type\>_: type of authentication: 0 = Basic, 1 = SNS [0]
89109
* **-n, --notify** _\<e-mail\>_: e-mail address to notify with the test results
90110
* **-B, --pingback** _\<url\>_: URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
91111
* **-D, --bwdown** _\<bandwidth\>_: download bandwidth in Kbps (used when specifying a custom connectivity profile)
92112
* **-U, --bwup** _\<bandwidth\>_: upload bandwidth in Kbps (used when specifying a custom connectivity profile)
93113
* **-Y, --latency** _\<time\>_: first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
94114
* **-P, --plr** _\<percentage\>_: packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
95-
* **-u, --tcpdump**: enable tcpdump capture
96115
* **-z, --noopt**: disable optimization checks (for faster testing)
97116
* **-I, --noimages**: disable screen shot capturing
98-
* **-H, --noheaders**: disable saving of the http headers (as well as browser status messages and CPU utilization)
99117
* **-F, --full**: save a full-resolution version of the fully loaded screen shot as a PNG
100118
* **-j, --jpeg** _\<level\>_: jpeg compression level (30-100) for the screen shots and video capture
101-
* **-S, --noscript**: disable javascript (IE, Chrome, Firefox)
102-
* **-R, --ignoressl**: ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
103-
* **-T, --standards**: forces all pages to load in standards mode (IE only)
104-
* **-O, --bodies**: save response bodies for text resources
105-
* **-K, --keepua**: do not add PTST to the original browser User Agent string
106-
* **-N, --duration** _\<seconds\>_: minimum test duration in seconds
107-
* **-A, --noads**: block ads defined by adblockrules.org
108-
* **-E, --aft**: (experimental) measure above-the-fold rendering time
109-
* **-Z, --spof** _\<domains\>_: space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
119+
* **-A, --medianvideo**: store the video from the median run when capturing video is enabled
110120
* **--htmlbody**: save the content of only the base HTML response
111-
* **--continuous**: capture video continuously (unstable/experimental, may cause tests to fail)
112-
* **--clearcerts**: clear the OS certificate caches (causes IE to do OCSP/CRL checks during SSL negotiation if the certificates are not already cached)
113-
* **--medianvideo**: store the video from the median run when capturing video is enabled
114121
* **--tsview** _\<id\>_: test name to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)
115-
* **-W, --mobile**: (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
116-
* **-M, --timeline**: capture Developer Tools Timeline (Chrome only)
117-
* **-G, --netlog**: capture Network Log (Chrome only)
118-
* **-C, --spdy3**: force SPDY version 3 (Chrome only)
119-
* **-J, --swrender**: force software rendering, disable GPU acceleration (Chrome only)
120-
* **-Q, --noparser**: disable threaded HTML parser (Chrome only)
121-
* **-q, --spdynossl**: use SPDY without SSL (Chrome only)
122-
* **--datareduction**: enable data reduction on Chrome 34+ Android (Chrome only)
123-
* **--useragent** _\<string\>_: custom user agent string (Chrome only)
124-
* **--cmdline** _\<switches\>_: use a list of custom command line switches (Chrome only)
125-
* **--poll** _[interval]_: poll for results after test is scheduled at every \<interva\l> seconds [5]
126-
* **--wait** _[hostname:port]_: wait for test results informed by agent once complete listening on \<hostname\>:\<port\> [hostname:first port available above 8000]
122+
* **--affinity** _\<string\>_: string to hash test to a specific test agent. tester will be picked by index among available testers
123+
* **--noads**: block ads defined by adblockrules.org
124+
* **--continuous**: capture video continuously (unstable/experimental, may cause tests to fail)
125+
* **--spdy3**: force SPDY version 3 (Chrome only)
126+
* **--swrender**: force software rendering, disable GPU acceleration (Chrome only)
127+
* **--poll** _\<interval\>_: poll for results after test is scheduled at every <interval> seconds [5]
128+
* **--wait** _\<hostname:port\>_: wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
127129
* **--timeout** _\<seconds\>_: timeout for polling and waiting results [no timeout]
128130

129131
#### API Key (works for **test** and **cancel** commands)
@@ -141,7 +143,7 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
141143
* **-S, --specs** _\<json_or_file\>_: set the specs for performance test suite
142144
* **-r, --reporter** _\<name\>_: set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity
143145

144-
#### Run (works for **pagespeed**, **utilization**, **request**, **timeline**, **netlog**, **console**, **googlecsi**, **response**, **waterfall** and **screenshot** commands)
146+
#### Run (works for **pagespeed**, **utilization**, **request**, **timeline**, **netlog**, **chrometrace**, **console**, **googlecsi**, **response**, **waterfall** and **screenshot** commands)
145147
* **-r, --run** _\<number\>_: which run number on a multiple runs test [1]
146148
* **-c, --cached**: get the Repeat View (cached view) instead of default First View (primed cache)
147149

@@ -336,6 +338,7 @@ Methods and options (including the one letter shorthands) are the same when usin
336338
* `getRequestData(id, options, callback)`
337339
* `getTimelineData(id, options, callback)`
338340
* `getNetLogData(id, options, callback)`
341+
* `getChromeTraceData(id, options, callback)`
339342
* `getConsoleLogData(id, options, callback)`
340343
* `getTestInfo(id, options, callback)`
341344
* `getHistory(days, options, callback)`
@@ -393,67 +396,68 @@ wpt.runTest(script, function(err, data) {
393396

394397
#### Test (works for `runTest` method only)
395398
* **location**: _String_, location to test from
399+
* **connectivity**: _String_, connectivity profile (Cable|DSL|FIOS|Dial|3G|3GFast|Native|custom) [Cable]
396400
* **runs**: _Number_, number of test runs [1]
397401
* **firstViewOnly**: _Boolean_, skip the Repeat View test
398-
* **label**: _String_, label for the test
399-
* **private**: _Boolean_, keep the test hidden from the test log
400402
* **video**: _Boolean_, capture video
401-
* **connectivity**: _String_, connectivity profile (Cable|DSL|FIOS|Dial|3G|3GFast|Native|custom) [Cable]
403+
* **private**: _Boolean_, keep the test hidden from the test log
404+
* **label**: _String_, label for the test
405+
* **stopAtDocumentComplete**: _Boolean_, stop test at document complete. typically, tests run until all activity stops
406+
* **disableJavaScript**: _Boolean_, disable javascript (IE, Chrome, Firefox)
407+
* **clearCerts**: _Boolean_, clear SSL cetificate caches
408+
* **ignoreSSL**: _Boolean_, ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
409+
* **disableCompatibilityView**: _Boolean_, forces all pages to load in standards mode (IE only)
410+
* **tcpDump**: _Boolean_, capture network packet trace (tcpdump)
411+
* **saveResponseBodies**: _Boolean_, save response bodies for text resources
412+
* **keepOriginalUserAgent**: _Boolean_, do not add PTST to the original browser User Agent string
402413
* **domElement**: _String_, DOM element to record for sub-measurement
403-
* **connections**: _Number_, override the number of concurrent connections
404-
* **stopAtDocumentComplete**: _Boolean_, force the test to stop at window.onload
405-
* **sensitive**: _Boolean_, discard script and http headers in the result
406-
* **block**: _[String]_, array of string of urls to block (substring match)
414+
* **minimumDuration**: _Number_, minimum test duration in seconds
415+
* **tester**: _String_, run the test on a specific PC (name must match exactly or the test will not run)
416+
* **emulateMobile**: _Boolean_, (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
417+
* **timeline**: _Boolean_, capture Developer Tools Timeline (Chrome only)
418+
* **timelineCallStack**: _Boolean_, set between 1-5 to include the JS call stack. must be used in conjunction with timeline (increases overhead) (Chrome only)
419+
* **chromeTrace**: _Boolean_, capture chrome trace (about://tracing) (Chrome only)
420+
* **netLog**: _Boolean_, capture Network Log (Chrome only)
421+
* **dataReduction**: _Boolean_, enable data reduction on Chrome 34+ Android (Chrome only)
422+
* **userAgent**: _String_, custom user agent string (Chrome only)
423+
* **commandLine**: _String_, use a list of custom command line switches (Chrome only)
407424
* **login**: _String_, username for authenticating tests (http authentication)
408425
* **password**: _String_, password for authenticating tests (http authentication)
426+
* **sensitive**: _Boolean_, discard script and http headers in the result
427+
* **disableHTTPHeaders**: _Boolean_, disable saving of the http headers (as well as browser status messages and CPU utilization)
428+
* **block**: _String_, space-delimited list of urls to block (substring match)
429+
* **spof**: _String_, space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
430+
* **customMetrics**: _String_, execute arbitrary javascript at the end of a test to collect custom metrics
409431
* **authenticationType**: _Number_, type of authentication: 0 = Basic, 1 = SNS [0]
410432
* **notifyEmail**: _String_, e-mail address to notify with the test results
411433
* **pingback**: _String_, URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
412434
* **bandwidthDown**: _String_, download bandwidth in Kbps (used when specifying a custom connectivity profile)
413435
* **bandwidthUp**: _String_, upload bandwidth in Kbps (used when specifying a custom connectivity profile)
414436
* **latency**: _String_, first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
415437
* **packetLossRate**: _Number_, packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
416-
* **tcpDump**: _Boolean_, enable tcpdump capture
417438
* **disableOptimization**: _Boolean_, disable optimization checks (for faster testing)
418439
* **disableScreenshot**: _Boolean_, disable screen shot capturing
419-
* **disableHTTPHeaders**: _Boolean_, disable saving of the http headers (as well as browser status messages and CPU utilization)
420440
* **fullResolutionScreenshot**: _Boolean_, save a full-resolution version of the fully loaded screen shot as a PNG
421441
* **jpegQuality**: _Number_, jpeg compression level (30-100) for the screen shots and video capture
422-
* **disableJavaScript**: _Boolean_, disable javascript (IE, Chrome, Firefox)
423-
* **ignoreSSL**: _Boolean_, ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
424-
* **disableCompatibilityView**: _Boolean_, forces all pages to load in standards mode (IE only)
425-
* **saveResponseBodies**: _Boolean_, save response bodies for text resources
426-
* **keepOriginalUserAgent**: _Boolean_, do not add PTST to the original browser User Agent string
427-
* **minimumDuration**: _String_, minimum test duration in seconds
428-
* **blockAds**: _Boolean_, block ads defined by adblockrules.org
429-
* **aftRenderingTime**: _Boolean_, (experimental) measure above-the-fold rendering time
430-
* **spof**: _[String]_, array of string of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
431-
* **htmlBody**: _Boolean_, save the content of only the base HTML response
432-
* **continuous**: _Boolean_, capture video continuously (unstable/experimental, may cause tests to fail)
433-
* **clearCerts**: _Boolean_, clear the OS certificate caches (causes IE to do OCSP/CRL checks during SSL negotiation if the certificates are not already cached)
434442
* **medianVideo**: _Boolean_, store the video from the median run when capturing video is enabled
443+
* **htmlBody**: _Boolean_, save the content of only the base HTML response
435444
* **tsView**: _String_, test name to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)
436-
* **emulateMobile**: _Boolean_, (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
437-
* **timeline**: _Boolean_, capture Developer Tools Timeline (Chrome only)
438-
* **netLog**: _Boolean_, capture Network Log (Chrome only)
445+
* **affinity**: _String_, string to hash test to a specific test agent. tester will be picked by index among available testers
446+
* **blockAds**: _Boolean_, block ads defined by adblockrules.org
447+
* **continuousVideoCapture**: _Boolean_, capture video continuously (unstable/experimental, may cause tests to fail)
439448
* **forceSpdy3**: _Boolean_, force SPDY version 3 (Chrome only)
440449
* **forceSoftwareRendering**: _Boolean_, force software rendering, disable GPU acceleration (Chrome only)
441-
* **disableThreadedParser**: _Boolean_, disable threaded HTML parser (Chrome only)
442-
* **spdyNoSSL**: _Boolean_, use SPDY without SSL (Chrome only)
443-
* **dataReduction**: _Boolean_, enable data reduction on Chrome 34+ Android (Chrome only)
444-
* **userAgent**: _String_, custom user agent string (Chrome only)
445-
* **commandLine**: _[String]_, use a list of custom command line switches (Chrome only)
446450
* **pollResults**: _Number_, poll for results after test is scheduled at every <interval> seconds [5]
447451
* **waitResults**: _String_, wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
448-
* **timeout**: _Number_, timeout (in seconds) for pollResults and waitResults [no timeout]
452+
* **timeout**: _String_, timeout for polling and waiting results [no timeout]
449453

450-
#### API Key (works for **runTest** and **cancelTest** methods)
454+
#### API Key (works for `runTest` and `cancelTest` methods)
451455
* **key**: _String_, API key (if assigned). Contact the WebPageTest server administrator for a key if required
452456

453-
#### Request (works for **getTestStatus**, **getResults**, **getLocations**, **getTesters** and **runTest** methods)
457+
#### Request (works for `getTestStatus` `getResults` `getLocations` `getTesters` and `runTest` methods)
454458
* **requestId**: _String_, echo request ID, useful to track asynchronous requests
455459

456-
#### Results (works for **getResults** and **runTest** methods)
460+
#### Results (works for `getResults` and `runTest` methods)
457461
* **breakDown**: _Boolean_, include the breakdown of requests and bytes by mime type
458462
* **domains**: _Boolean_, include the breakdown of requests and bytes by domain
459463
* **pageSpeed**: _Boolean_, include the PageSpeed score in the response (may be slower)
@@ -462,7 +466,7 @@ wpt.runTest(script, function(err, data) {
462466
* **specs**: _String_, set the specs for performance test suite
463467
* **reporter**: _String_, set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity
464468

465-
#### Run (works for `getPageSpeedData`, `getUtilizationData`, `getRequestData`, `getTimelineData`, `getNetLogData`, `getConsoleLogData`, `getGoogleCsiData`, `getResponseBody`, `getWaterfallImage` and `getScreenshotImage` methods)
469+
#### Run (works for `getPageSpeedData`, `getUtilizationData`, `getRequestData`, `getTimelineData`, `getNetLogData`, `getChromeTraceData`, `getConsoleLogData`, `getGoogleCsiData`, `getResponseBody`, `getWaterfallImage` and `getScreenshotImage` methods)
466470
* **run**: _Number_, the test run number for multiple runs tests (default: 1, first test)
467471
* **repeatView**: _Boolean_, if `true` returns the repeat view (cached) data
468472

0 commit comments

Comments
 (0)