Skip to content

Commit 66a53ba

Browse files
committed
updated readme with new history,video,player commands and options
1 parent 7917e2b commit 66a53ba

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ $ webpagetest --help
5151
* **netlog** _[options] \<id\>_: get the Chrome Developer Tools Net log data (if available) from test
5252
* **console** _[options] \<id\>_: get the browser console log data (if available) from test
5353
* **testinfo** _\<id\>_: get test request info/details
54+
* **history** _[days]_: get history of previously run tests
5455
* **waterfall** _[options] \<id\>_: get the waterfall PNG image
5556
* **screenshot** _[options] \<id\>_: get the fully loaded page screenshot in JPG format (PNG if in full resolution)
57+
* **video** _[options] \<tests\>_: create a video from _\<tests\>_ (comma separated test ids)
58+
* **player _\<id\>_: get a html5 player for a video _\<id\>_
5659
* **listen** _[port]_: start webpagetest-api server on port _[7791_]
5760
* **batch** _\<file\>_: run commands in batch, i.e. one command per line from _\<file\>_ in parallel
5861

@@ -153,6 +156,9 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
153156
* **-e, --noellipsis**: hide ellipsis (...) for missing items [false]
154157
* **-l, --nolabels**: hide labels for requests (URL) [false]
155158

159+
#### Video (works for **video** command only)
160+
* **-e, --end** _\<end_point\>_: frame comparison end point: [visual]=visually complete | all=last change | doc=document complete | full=fully loaded
161+
156162
### Examples
157163
#### 1. Get available locations
158164
```bash
@@ -315,8 +321,11 @@ Methods and options (including the one letter shorthands) are the same when usin
315321
* `getNetLogData(id, options, callback)`
316322
* `getConsoleLogData(id, options, callback)`
317323
* `getTestInfo(id, options, callback)`
324+
* `getHistory(days, options, callback)`
318325
* `getWaterfallImage(id, options, callback)`
319326
* `getScreenshotImage(id, options, callback)`
327+
* `createVideo(tests, options, callback)`
328+
* `getEmbedVideoPlayer(id, options, callback)`
320329
* `listen(port, callback)`
321330
* `scriptToString(script)`
322331

@@ -451,6 +460,9 @@ wpt.runTest(script, function(err, data) {
451460
* **noEllipsis**: _Boolean_, hide ellipsis (...) for missing items [false]
452461
* **noLabels**: _Boolean_, hide labels for requests (URL) [false]
453462

463+
#### Video (works for `createVideo` method only)
464+
* **comparisonEndPoint** _String_: frame comparison end point: [visual]=visually complete | all=last change | doc=document complete | full=fully loaded
465+
454466
### Examples
455467

456468
#### 1. Instantiating

0 commit comments

Comments
 (0)