@speedkit/cli
Advanced tools
Speed Kit CLI
via envVars:
$CHROME_PATH # path to chromeBinary
$CHROME_USER_PROFILE_PATH # path to save custom chromeUserProfile
$SLACK_TOKEN # slackToken that will be injected in deploymentDetection
$SPEED_KIT_EXTENSION_PATH # path to speedKitDevtoolsBrowserExtension
$TEST_APP # name of your testApp
$IDEA_INITIAL_DIRECTORY # directoryPath to intellij shellBinary
$DIFF_EXEC # path or executable of you favorite diffTool e.g. "vscode --diff", "codium --diff", "diff", "idea diff"
DIFF_EXEC_TEMPLATE # defaults to "$exec $file1 $file2" resolves in "diff pathToFile1 pathToFile2"
or via config file:
Unix: ~/.config/speed-kit-cli/config.json
Windows: %LOCALAPPDATA%\speed-kit-cli/config.json
{
"chromePath": "", //path to chromeBinary
"chromeUserProfilePath": "", //path to save custom chromeUserProfile
"slackToken": "", //slackToken that will be injected in deploymentDetection
"speedKitBrowserExtensionPath": "", //path to speedKitDevtoolsBrowserExtension
"testApp": "", //name of your testApp
"ideaDirectory": "", //directoryPath to intellij shellBinary
"diffExec": "" // path or executable of you favorite diffTool e.g. "vscode --diff", "codium --diff", "diff", "idea diff"
"diffExecTemplate": "" // defaults to "$exec $file1 $file2" resolves in "diff pathToFile1 pathToFile2"
}
example for diffing with intellij:
{
"diffExec": "idea diff"
"diffExecTemplate": ""
}
example for diffing with VSCodium:
{
"diffExec": "codium"
"diffExecTemplate": "$exec --diff $file1 $file2"
}
example for changing the order of files to diff:
{
"diffExecTemplate": "$exec $file2 $file1"
}
$ npm install -g @speedkit/cli
$ sk COMMAND
running command...
$ sk (--version)
@speedkit/cli/2.9.0 linux-x64 node-v20.11.1
$ sk --help [COMMAND]
USAGE
$ sk COMMAND
...
sk autocomplete [SHELL]sk build-parameter-query CUSTOMERPATHsk build-prewarm-query CUSTOMERPATHsk deploy CUSTOMERPATHsk document-handler CUSTOMERPATHsk find-pops APPsk generate-customer-configsk generate-pop-config APPsk help [COMMANDS]sk login [APP]sk onboarding CUSTOMERPATHsk param-diff PAGEURLsk pop-prewarm APPsk prewarm APP PATHsk pull CUSTOMERPATHsk wpt-launcher URLS TESTIDsk autocomplete [SHELL]Display autocomplete installation instructions.
USAGE
$ sk autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ sk autocomplete
$ sk autocomplete bash
$ sk autocomplete zsh
$ sk autocomplete powershell
$ sk autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
sk build-parameter-query CUSTOMERPATHBuild a parameter query that can be executed in Athena
USAGE
$ sk build-parameter-query CUSTOMERPATH [-c <value>]
ARGUMENTS
CUSTOMERPATH The customer config path
FLAGS
-c, --configName=<value> [default: production] The costumer config name
DESCRIPTION
Build a parameter query that can be executed in Athena
EXAMPLES
$ sk build-parameter-query <customerPath> -c <configName>
$ sk build-parameter-query customer/decathlon.de -c production
sk build-prewarm-query CUSTOMERPATHBuild a prewarm query that can be executed in Athena
USAGE
$ sk build-prewarm-query CUSTOMERPATH [-c <value>]
ARGUMENTS
CUSTOMERPATH The customer config path
FLAGS
-c, --configName=<value> [default: production] The costumer config name
DESCRIPTION
Build a prewarm query that can be executed in Athena
EXAMPLES
$ sk build-prewarm-query <customerPath> -c <configName>
$ sk build-prewarm-query customer/decathlon.de -c production
sk deploy CUSTOMERPATHDeploys the specified customer config while comparing to the live version before
USAGE
$ sk deploy CUSTOMERPATH [-c <value>] [-t <value>] [-a <value>] [-d]
ARGUMENTS
CUSTOMERPATH The customer config path
FLAGS
-a, --artifacts=<value> Whitelist of files to deploy
-c, --configName=<value> [default: production] The costumer config name
-d, --dryRun Do not deploy changes
-t, --slackToken=<value> Slack hook found on 1Pass
DESCRIPTION
Deploys the specified customer config while comparing to the live version before
EXAMPLES
$ sk deploy <customerPath> -c <configName> -t <slackToken> -a <artifacts> -d <dryRun>
$ sk deploy customer/decathlon.de -c production -t someSlackToken -a dynamic,SpeedKit -d
sk document-handler CUSTOMERPATHCreates testable documentHandler in folder {CUSTOMER_PATH}/test/src/
USAGE
$ sk document-handler CUSTOMERPATH [-c <value>] [-t <value>]
ARGUMENTS
CUSTOMERPATH The customer config path
FLAGS
-c, --configName=<value> [default: production] The costumer config name
-t, --CreateTests=<value>... name of the test to create
DESCRIPTION
Creates testable documentHandler in folder {CUSTOMER_PATH}/test/src/
EXAMPLES
$ sk documentHandler <customerPath> -c <configName>
$ sk deploy customer/decathlon.de -c production
sk find-pops APPGet IPs for all fastly PoPs
USAGE
$ sk find-pops APP [-i <value>]
ARGUMENTS
APP The customers appName
FLAGS
-i, --ips=<value> [default: 151.101.x.194]
DESCRIPTION
Get IPs for all fastly PoPs
EXAMPLES
$ sk find-pops <app> -i <ips>
$ sk find-pops appName -i ips
sk generate-customer-configGenerates a customer config guided by a wizard 🧙
USAGE
$ sk generate-customer-config [-a <value>] [-d <value>]
FLAGS
-a, --app=<value> The SK app name which is also being used the config output directory name (kebab-case)
-d, --customersDir=<value> Name of the sk-onboarding directory where all customer configs are being stored (default:
"customers")
DESCRIPTION
Generates a customer config guided by a wizard 🧙
EXAMPLES
$ sk generate-customer-config -a <app> -d <customersDir>
$ sk generate-customer-config -a decathlon -d customers
sk generate-pop-config APPGenerate a pop config for the given app
USAGE
$ sk generate-pop-config APP [-c <value>] [-d] [-p <value>] [-t <value>] [-r]
ARGUMENTS
APP The customers appName
FLAGS
-c, --coverage=<value> [default: 95] The percentage of traffic which should be covered through prewarming.
-d, --[no-]deploy Default it diffs with the deployed config and ask for deployment. If the flag is passed
deployment will be skipped or forced.
-p, --pop-limit=<value> [default: 5] The maximal pop count which should prewarmed.
-r, --use-rum Compute the pop statistics based on RUM. Otherwise the real Speed Kit traffic is used.
-t, --traffic-share=<value> [default: 5] The minimum traffic share in percent a pop must have to be actually
prewarmed.
DESCRIPTION
Generate a pop config for the given app
EXAMPLES
$ sk generate-pop-config <app>
$ sk generate-pop-config --use-rum <app>
$ sk generate-pop-config --coverage 95 appName
$ sk generate-pop-config --no-deploy appName
$ sk generate-pop-config --deploy appName
$ sk generate-pop-config --coverage 95 --pop-limit 6 --traffic-share 2 --deploy appName
sk help [COMMANDS]Display help for sk.
USAGE
$ sk help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for sk.
See code: @oclif/plugin-help
sk login [APP]Login to your app
USAGE
$ sk login [APP]
ARGUMENTS
APP [default: bbq] The customers appName
DESCRIPTION
Login to your app
EXAMPLES
$ sk login <app>
$ sk login appName
sk onboarding CUSTOMERPATHStart a local dev environment for building and testing the Speed Kit configuration
USAGE
$ sk onboarding CUSTOMERPATH [-c <value>] [-l] [-v]
ARGUMENTS
CUSTOMERPATH The customer config path
FLAGS
-c, --configName=<value> [default: production] The costumer config name
-l, --local Run with local documentHandler
-v, --verboseLevel Show all messages
DESCRIPTION
Start a local dev environment for building and testing the Speed Kit configuration
EXAMPLES
$ sk onboarding <customerPath> -c <configName>
$ sk onboarding customer/decathlon.de -c production
sk param-diff PAGEURLShows difference in documents with query parameters on/off
USAGE
$ sk param-diff PAGEURL [-h]
ARGUMENTS
PAGEURL Link of the page
FLAGS
-h, --hideDiff Hide the code diff in IDE code diff window
DESCRIPTION
Shows difference in documents with query parameters on/off
EXAMPLES
$ sk prewarm <pageUrl> -h
$ sk prewarm https://www.decathlon.de/ -h
sk pop-prewarm APPPre-warm Fastly PoPs
USAGE
$ sk pop-prewarm APP [-i <value>] [-c <value>]
ARGUMENTS
APP The customers appName
FLAGS
-c, --contentTypes=<value> [default: image]
-i, --ips=<value> [default: 151.101.120.194]
DESCRIPTION
Pre-warm Fastly PoPs
EXAMPLES
$ sk pop-prewarm <app> -c <contentTypes> -i <ips>
$ sk pop-prewarm decathlon -c image,style -i 151.101.120.194
sk prewarm APP PATHPre-warm Fastly
USAGE
$ sk prewarm APP PATH [-p <value> | -v <value>] [-d <value>] [-k]
ARGUMENTS
APP The customer app name
PATH path to prewarmFile
FLAGS
-d, --delay=<value> Request delay in ms
-k, --keepParameterSorting Prevents alphabetical sorting of the URL parameters
-p, --variationPath=<value>
-v, --variation=<value> [default: DEFAULT]
DESCRIPTION
Pre-warm Fastly
EXAMPLES
for a single variation:
$ sk prewarm <app> <path> -v <variation> -d <delay> -k
$ sk prewarm decathlon C:\Users\testUser\file.csv -v MOBILE -d 1200 -k
for a list of variations:
$ sk prewarm <app> <path> -p <variationPath> -d <delay> -k
$ sk prewarm decathlon C:\Users\testUser\file.csv -p C:\Users\testUser\variations.csv -d 1200 -k
sk pull CUSTOMERPATHPull the specified customer config from orestes
USAGE
$ sk pull CUSTOMERPATH [-c <value>]
ARGUMENTS
CUSTOMERPATH The customer config path
FLAGS
-c, --configName=<value> [default: production] The costumer config name
DESCRIPTION
Pull the specified customer config from orestes
EXAMPLES
$ sk pull <customerPath>
$ sk pull customer/decathlon.de -c production
sk wpt-launcher URLS TESTIDAnalyze the performance impact that Speed Kit has compared to the original version.
USAGE
$ sk wpt-launcher URLS TESTID [-c <value>] [-m <value>] [-g <value>]
FLAGS
-c, --cookies=<value>
-g, --group=<value> [default: A]
-m, --mobile=<value> [default: no]
DESCRIPTION
Analyze the performance impact that Speed Kit has compared to the original version.
EXAMPLES
$ sk wpt-launcher <urls> <testId> -g <group> -m <mobile> -c <cookies>
$ sk wpt-launcher url1,url2,url3 listing-50vs50 -g B -m Y -c consentCookies
FAQs
Speed Kit CLI
The npm package @speedkit/cli receives a total of 172 weekly downloads. As such, @speedkit/cli popularity was classified as not popular.
We found that @speedkit/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.