| 1 | {"version":"3.0.10","commands":{"marker-timings":{"id":"marker-timings","description":"Get list of all user-timings from trace","pluginName":"tracerbench","pluginType":"core","aliases":[],"flags":{"tracepath":{"name":"tracepath","type":"option","description":"The path to the generated trace.json file","required":true},"filter":{"name":"filter","type":"option","description":"User timing marks start with"},"url":{"name":"url","type":"option","description":"URL to visit for record-har, timings & trace commands","required":true},"traceFrame":{"name":"traceFrame","type":"option","description":"Specify a trace insights frame"}},"args":[]},"record-har":{"id":"record-har","description":"Generates a HAR file from a URL.","pluginName":"tracerbench","pluginType":"core","aliases":[],"flags":{"url":{"name":"url","type":"option","description":"URL to visit for record-har, timings & trace commands","required":true},"dest":{"name":"dest","type":"option","description":"The destination path for the generated file","required":true,"default":""},"cookiespath":{"name":"cookiespath","type":"option","description":"The path to a JSON file containing cookies to authenticate against the correlated URL","required":true},"filename":{"name":"filename","type":"option","description":"The filename for the generated file","required":true,"default":"tracerbench"},"marker":{"name":"marker","type":"option","description":"The last marker before ending recording","required":true,"default":"domComplete"},"config":{"name":"config","type":"option","description":"Specify an alternative directory rather than the project root for the tbconfig.json. This explicit config will overwrite all."}},"args":[]},"report":{"id":"report","description":"Parses the output json from tracerbench and formats it into pdf and html","pluginName":"tracerbench","pluginType":"core","aliases":[],"flags":{"tbResultsFolder":{"name":"tbResultsFolder","type":"option","description":"The output folder path for all tracerbench results","required":true,"default":"./tracerbench-results"},"config":{"name":"config","type":"option","description":"Specify an alternative directory rather than the project root for the tbconfig.json. This explicit config will overwrite all."}},"args":[]},"trace":{"id":"trace","description":"Parses a CPU profile and aggregates time across heuristics. Can be vertically sliced with event names.","pluginName":"tracerbench","pluginType":"core","aliases":[],"flags":{"cpuThrottleRate":{"name":"cpuThrottleRate","type":"option","description":"CPU throttle multiplier","required":true,"default":2},"tbResultsFolder":{"name":"tbResultsFolder","type":"option","description":"The output folder path for all tracerbench results","required":true,"default":"./tracerbench-results"},"harpath":{"name":"harpath","type":"option","description":"The path to the HTTP Archive File (HAR)","required":true},"network":{"name":"network","type":"option","description":"Simulated network conditions.","options":["none","offline","dialup","slow-2g","2g","slow-edge","edge","slow-3g","dsl","3g","fast-3g","4g","cable","LTE","FIOS"],"default":"none"},"url":{"name":"url","type":"option","description":"URL to visit for record-har, timings & trace commands","required":true},"cookiespath":{"name":"cookiespath","type":"option","description":"The path to a JSON file containing cookies to authenticate against the correlated URL","required":true},"iterations":{"name":"iterations","type":"option","description":"Number of runs","required":true,"default":1},"locations":{"name":"locations","type":"option","description":"include locations in names"},"insights":{"name":"insights","type":"boolean","description":"Analyze insights from command.","allowNo":false}},"args":[]},"compare:analyze":{"id":"compare:analyze","description":"Run an analysis of a benchmark run from a results json file and output to terminal","pluginName":"tracerbench","pluginType":"core","aliases":[],"flags":{"fidelity":{"name":"fidelity","type":"option","description":"Directly correlates to the number of samples per trace. High is the longest trace time.","required":true,"default":"low"},"tbResultsFolder":{"name":"tbResultsFolder","type":"option","description":"The output folder path for all tracerbench results","required":true,"default":"./tracerbench-results"},"regressionThreshold":{"name":"regressionThreshold","type":"option","description":"The upper limit the experiment can regress slower in milliseconds. eg 100"}},"args":[{"name":"resultsFile","description":"Results JSON file","required":true}]},"compare":{"id":"compare","description":"Compare the performance delta between an experiment and control","pluginName":"tracerbench","pluginType":"core","aliases":[],"flags":{"hideAnalysis":{"name":"hideAnalysis","type":"boolean","description":"Hide the the analysis output in terminal","allowNo":false},"browserArgs":{"name":"browserArgs","type":"option","description":"(Default Recommended) Additional chrome flags for the TracerBench render benchmark. TracerBench includes many non-configurable defaults in this category.","required":true,"default":["--crash-dumps-dir=./tmp","--disable-background-timer-throttling","--disable-dev-shm-usage","--disable-cache","--disable-v8-idle-tasks","--disable-breakpad","--disable-notifications","--disable-hang-monitor","--safebrowsing-disable-auto-update","--ignore-certificate-errors","--v8-cache-options=none"]},"cpuThrottleRate":{"name":"cpuThrottleRate","type":"option","description":"CPU throttle multiplier","required":true,"default":2},"fidelity":{"name":"fidelity","type":"option","description":"Directly correlates to the number of samples per trace. High is the longest trace time.","required":true,"default":"low"},"markers":{"name":"markers","type":"option","description":"User Timing Markers","required":true,"default":"domComplete"},"network":{"name":"network","type":"option","description":"Simulated network conditions.","required":true,"options":["none","offline","dialup","slow-2g","2g","slow-edge","edge","slow-3g","dsl","3g","fast-3g","4g","cable","LTE","FIOS"],"default":"none"},"tbResultsFolder":{"name":"tbResultsFolder","type":"option","description":"The output folder path for all tracerbench results","required":true,"default":"./tracerbench-results"},"controlURL":{"name":"controlURL","type":"option","description":"Control URL to visit for compare command","required":false},"experimentURL":{"name":"experimentURL","type":"option","description":"Experiment URL to visit for compare command","required":false},"tracingLocationSearch":{"name":"tracingLocationSearch","type":"option","description":"The document location search param.","required":true,"default":"?tracing"},"emulateDevice":{"name":"emulateDevice","type":"option","description":"Emulate a mobile device screen size.","options":["iphone-4","iphone-5se","iphone-678","iphone-678-plus","iphone-x","blackberry-z30","nexus-4","nexus-5","nexus-5x","nexus-6","nexus-6p","pixel-2","pixel-2-xl","lg-optimus-l70","nokia-n9","nokia-lumia-520","microsoft-lumia-550","microsoft-lumia-950","galaxy-s-iii","galaxy-s5","kindle-fire-hdx","ipad-mini","ipad","ipad-pro","blackberry-playbook","nexus-10","nexus-7","galaxy-note-3","galaxy-note-ii","laptop-with-touch","laptop-with-hidpi-screen","laptop-with-mdpi-screen"],"default":""},"emulateDeviceOrientation":{"name":"emulateDeviceOrientation","type":"option","description":"Expected to be either \"vertical\" or \"horizontal\". Dictates orientation of device screen.","options":["horizontal","vertical"],"default":"vertical"},"socksPorts":{"name":"socksPorts","type":"option","description":"Specify a socks proxy port as browser option for control and experiment"},"regressionThreshold":{"name":"regressionThreshold","type":"option","description":"The upper limit the experiment can regress slower in milliseconds. eg 100"},"config":{"name":"config","type":"option","description":"Specify an alternative directory rather than the project root for the tbconfig.json. This explicit config will overwrite all."},"runtimeStats":{"name":"runtimeStats","type":"boolean","description":"Compare command output deep-dive stats during run.","allowNo":false},"report":{"name":"report","type":"boolean","description":"Generate a PDF report directly after running the compare command.","allowNo":false},"debug":{"name":"debug","type":"boolean","description":"Debug flag per command. Will output noisy command","allowNo":false},"headless":{"name":"headless","type":"boolean","description":"Run with headless chrome flags","allowNo":false}},"args":[]}}} |