Skip to content

Commit 3e53f28

Browse files
committed
update api key options
1 parent d239332 commit 3e53f28

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ $ webpagetest --help
6666
_The default WPT server can also be specified via environment variable `WEBPAGETEST_SERVER`_
6767

6868
#### Test (works for **test** command only)
69-
* **-k, --key** _\<api_key\>_:API key (if assigned). Contact the WebPageTest server administrator for a key if required
7069
* **-l, --location** _\<location\>_: location to test from
7170
* **-r, --runs** _\<number\>_: number of test runs [1]
7271
* **-f, --first**: skip the Repeat View test
@@ -115,6 +114,9 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
115114
* **--wait** _[hostname:port]_: wait for test results informed by agent once complete listening on \<hostname\>:\<port\> [hostname:first port available above 8000]
116115
* **--timeout** _\<seconds\>_: timeout for polling and waiting results [no timeout]
117116

117+
#### API Key (works for **test** and **cancel** commands)
118+
* **-k, --key** _\<api_key\>_:API key (if assigned). Contact the WebPageTest server administrator for a key if required
119+
118120
#### Request (works for **status**, **results**, **locations**, **testers** and **test** commands)
119121
* **-e, --request** _\<id\>_: echo request ID, useful to track asynchronous requests
120122

@@ -362,7 +364,6 @@ wpt.runTest(script, function(err, data) {
362364
* **server**: _String_, if specified, overrides the WebPageTest server informed in the constructor only for that method call
363365

364366
#### Test (works for `runTest` method only)
365-
* **key**: _String_, API key (if assigned). Contact the WebPageTest server administrator for a key if required
366367
* **location**: _String_, location to test from
367368
* **runs**: _Number_, number of test runs [1]
368369
* **firstViewOnly**: _Boolean_, skip the Repeat View test
@@ -411,6 +412,9 @@ wpt.runTest(script, function(err, data) {
411412
* **waitResults**: _String_, wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
412413
* **timeout**: _Number_, timeout (in seconds) for pollResults and waitResults [no timeout]
413414

415+
#### API Key (works for **runTest** and **cancelTest** methods)
416+
* **key**: _String_, API key (if assigned). Contact the WebPageTest server administrator for a key if required
417+
414418
#### Request (works for **getTestStatus**, **getResults**, **getLocations**, **getTesters** and **runTest** methods)
415419
* **requestId**: _String_, echo request ID, useful to track asynchronous requests
416420

0 commit comments

Comments
 (0)