|
| 1 | +Usage: webpagetest testAndWait [options] <url_or_script> |
| 2 | + |
| 3 | +run test and waits for the result |
| 4 | + |
| 5 | +Options: |
| 6 | + -k, --key <api_key> API key (if assigned). Contact the |
| 7 | + WebPageTest server administrator for a |
| 8 | + key if required |
| 9 | + -l, --location <location> location to test from |
| 10 | + -y, --connectivity <profile> connectivity profile |
| 11 | + (Cable|DSL|3GSlow|3G|3GFast|4G|LTE|Edge|2G|Dial|FIOS|Native|custom) |
| 12 | + [Cable] |
| 13 | + -r, --runs <number> number of test runs [1] |
| 14 | + -f, --first skip the Repeat View test |
| 15 | + -v, --video capture video |
| 16 | + -p, --private keep the test hidden from the test log |
| 17 | + -L, --label <label> label for the test |
| 18 | + -i, --onload stop test at document complete. |
| 19 | + typically, tests run until all activity |
| 20 | + stops |
| 21 | + -S, --noscript disable JavaScript (IE, Chrome, Firefox) |
| 22 | + -C, --clearcerts clear SSL certificate caches |
| 23 | + -R, --ignoressl ignore SSL certificate errors, e.g. name |
| 24 | + mismatch, self-signed certificates, etc |
| 25 | + -T, --standards forces all pages to load in standards |
| 26 | + mode (IE only) |
| 27 | + -u, --tcpdump capture network packet trace (tcpdump) |
| 28 | + -O, --bodies save response bodies for text resources |
| 29 | + -K, --keepua do not add PTST to the original browser |
| 30 | + User Agent string |
| 31 | + -m, --dom <element> DOM element to record for sub-measurement |
| 32 | + -N, --duration <seconds> minimum test duration in seconds |
| 33 | + -E, --tester <name> run the test on a specific PC (name must |
| 34 | + match exactly or the test will not run) |
| 35 | + --injectScript <injectScript> JavaScript to run after the document has |
| 36 | + started loading |
| 37 | + -W, --mobile (experimental) emulate mobile browser: |
| 38 | + Chrome mobile user agent, 640x960 screen, |
| 39 | + 2x scaling and fixed viewport (Chrome |
| 40 | + only) |
| 41 | + --device <string> device name from mobile_devices.ini to |
| 42 | + use for mobile emulation (only when |
| 43 | + mobile=1 is specified to enable emulation |
| 44 | + and only for Chrome) |
| 45 | + -M, --timeline capture Developer Tools Timeline (Chrome |
| 46 | + only) |
| 47 | + -J, --callstack set between 1-5 to include the JS call |
| 48 | + stack. must be used in conjunction with |
| 49 | + timeline (increases overhead) (Chrome |
| 50 | + only) |
| 51 | + -q, --chrometrace capture chrome trace (about://tracing) |
| 52 | + (Chrome only) |
| 53 | + --tracecategories <categories> trace categories (when chrometrace |
| 54 | + enabled) (Chrome only) |
| 55 | + -G, --netlog capture Network Log (Chrome only) |
| 56 | + -Q, --datareduction enable data reduction on Chrome 34+ |
| 57 | + Android (Chrome only) |
| 58 | + -x, --useragent <string> custom user agent string (Chrome only) |
| 59 | + -X, --cmdline <switches> use a list of custom command line |
| 60 | + switches (Chrome only) |
| 61 | + --lighthouse perform lighthouse test (Chrome only, |
| 62 | + Linux agent only) |
| 63 | + -thc, --throttleCPU <number> custom cpu throttling |
| 64 | + -g, --login <username> username for authenticating tests (http |
| 65 | + authentication) |
| 66 | + -w, --password <password> password for authenticating tests (http |
| 67 | + authentication) |
| 68 | + -t, --sensitive discard script and http headers in the |
| 69 | + result |
| 70 | + -H, --noheaders disable saving of the http headers (as |
| 71 | + well as browser status messages and CPU |
| 72 | + utilization) |
| 73 | + -b, --block <urls> space-delimited list of urls to block |
| 74 | + (substring match) |
| 75 | + -Z, --spof <domains> space-delimited list of domains to |
| 76 | + simulate failure by re-routing to |
| 77 | + blackhole.webpagetest.org to silently |
| 78 | + drop all requests |
| 79 | + -c, --custom <script> execute arbitrary JavaScript at the end |
| 80 | + of a test to collect custom metrics |
| 81 | + -a, --authtype <type> type of authentication: 0 = Basic, 1 = |
| 82 | + SNS [0] |
| 83 | + -n, --notify <e-mail> e-mail address to notify with the test |
| 84 | + results |
| 85 | + -B, --pingback <url> URL to ping when the test is complete |
| 86 | + (the test ID will be passed as an "id" |
| 87 | + parameter) |
| 88 | + -D, --bwdown <bandwidth> download bandwidth in Kbps (used when |
| 89 | + specifying a custom connectivity profile) |
| 90 | + -U, --bwup <bandwidth> upload bandwidth in Kbps (used when |
| 91 | + specifying a custom connectivity profile) |
| 92 | + -bw, --browserwidth <pixels> Browser window width (in display pixels) |
| 93 | + -bh, --browserheight <pixels> Browser window height (in display pixels) |
| 94 | + -vh, --viewportheight <pixels> Viewport Height in css pixels |
| 95 | + -vw, --viewportwidth <pixels> Viewport Width in css pixels |
| 96 | + -dpr, --devicetopixelratio <ratio> Device To Pixel Ratio |
| 97 | + -au, --appendua <string> String to append to the user agent |
| 98 | + string. This is in addition to the |
| 99 | + default PTST/ver string |
| 100 | + -tt, --testtype <string> For running alternative test types, can |
| 101 | + specify traceroute or lighthouse |
| 102 | + -pr, --profiler <number> Set to 1 to enable the V8 sampling |
| 103 | + profiler (Chromium only) |
| 104 | + -avif, --disableAVIF <number> Set to 1 to disable AVIF support |
| 105 | + (Chromium 88+) |
| 106 | + -webp, --disableWEBP <number> Set to 1 to disable WEBP support |
| 107 | + (Chromium 88+) |
| 108 | + -jxl, --disableJXL <number> Set to 1 to disable JpegXL support |
| 109 | + (Chromium 88+) |
| 110 | + -dts, --dtShaper <number> Set to 1 to use Chrome's built-in |
| 111 | + traffic-shaping instead of the |
| 112 | + packet-level netem shaping usually used |
| 113 | + by the test agents |
| 114 | + -Y, --latency <time> first-hop Round Trip Time in ms (used |
| 115 | + when specifying a custom connectivity |
| 116 | + profile) |
| 117 | + -P, --plr <percentage> packet loss rate - percent of packets to |
| 118 | + drop (used when specifying a custom |
| 119 | + connectivity profile) |
| 120 | + -z, --noopt disable optimization checks (for faster |
| 121 | + testing) |
| 122 | + -I, --noimages disable screen shot capturing |
| 123 | + -F, --full save a full-resolution version of the |
| 124 | + fully loaded screen shot as a PNG |
| 125 | + -j, --jpeg <level> jpeg compression level (30-100) for the |
| 126 | + screen shots and video capture |
| 127 | + -A, --medianvideo store the video from the median run when |
| 128 | + capturing video is enabled |
| 129 | + --htmlbody save the content of only the base HTML |
| 130 | + response |
| 131 | + --tsview <id> test name to use when submitting results |
| 132 | + to tsviewdb (for private instances that |
| 133 | + have integrated with tsviewdb) |
| 134 | + --tsviewconfigs <string> configs to use when submitting results to |
| 135 | + tsviewdb (for private instances that have |
| 136 | + integrated with tsviewdb) |
| 137 | + --affinity <string> string to hash test to a specific test |
| 138 | + agent. tester will be picked by index |
| 139 | + among available testers |
| 140 | + --priority <number> change test priority (0-9) [enforced by |
| 141 | + API key, otherwise 5] |
| 142 | + --noads block ads defined by adblockrules.org |
| 143 | + --continuous capture video continuously |
| 144 | + (unstable/experimental, may cause tests |
| 145 | + to fail) |
| 146 | + --spdy3 force SPDY version 3 (Chrome only) |
| 147 | + --swrender force software rendering, disable GPU |
| 148 | + acceleration (Chrome only) |
| 149 | + --poll [interval] poll for results after test is scheduled |
| 150 | + at every <interval> seconds [5] |
| 151 | + --wait [hostname:port] wait for test results informed by agent |
| 152 | + once complete listening on |
| 153 | + <hostname>:<port> [hostname:first port |
| 154 | + available above 8000] |
| 155 | + --timeout <seconds> timeout for polling and waiting results |
| 156 | + [no timeout] |
| 157 | + -e, --request <id> echo request ID, useful to track |
| 158 | + asynchronous requests |
| 159 | + --breakdown include the breakdown of requests and |
| 160 | + bytes by mime type |
| 161 | + --domains include the breakdown of requests and |
| 162 | + bytes by domain |
| 163 | + --pagespeed include the PageSpeed score in the |
| 164 | + response (may be slower) |
| 165 | + --requests include the request data in the response |
| 166 | + (slower and results in much larger |
| 167 | + responses) |
| 168 | + --median <metric> set the metric used to calculate median |
| 169 | + for multiple runs tests [loadTime] |
| 170 | + --medianrun <metric> set the run used for median for multiple |
| 171 | + runs tests [median] |
| 172 | + --specs <json_or_file> set the specs for performance test suite |
| 173 | + --reporter <name> set performance test suite reporter |
| 174 | + output: |
| 175 | + [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity |
| 176 | + -h, --help display help for command |
0 commit comments