@speedkit/cli 2.4.1

package/README.md

@@ -0,0 +1,775 @@
+speed-kit-cli
+=============
+
+Speed Kit CLI
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/speed-kit-cli.svg)](https://npmjs.org/package/speed-kit-cli)
+[![Downloads/week](https://img.shields.io/npm/dw/speed-kit-cli.svg)](https://npmjs.org/package/speed-kit-cli)
+[![License](https://img.shields.io/npm/l/speed-kit-cli.svg)](https://github.com/baqend/speed-kit-cli/blob/master/package.json)
+
+## Configuration: 
+via envVars: 
+```shell
+$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
+
+```javascript
+{
+        "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:
+```javascript
+{
+        "diffExec": "idea diff" 
+        "diffExecTemplate": "" 
+}
+
+```
+
+example for diffing with VSCodium:
+```javascript
+{
+        "diffExec": "codium" 
+        "diffExecTemplate": "$exec --diff $file1 $file2" 
+}
+
+```
+
+example for changing the order of files to diff:
+```javascript
+{
+       "diffExecTemplate": "$exec $file2 $file1" 
+}
+```
+
+---
+  
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @speedkit/cli
+$ sk COMMAND
+running command...
+$ sk (--version)
+@speedkit/cli/2.4.1 linux-x64 node-v20.11.1
+$ sk --help [COMMAND]
+USAGE
+  $ sk COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`sk autocomplete [SHELL]`](#sk-autocomplete-shell)
+* [`sk build-parameter-query CUSTOMERPATH`](#sk-build-parameter-query-customerpath)
+* [`sk build-prewarm-query CUSTOMERPATH`](#sk-build-prewarm-query-customerpath)
+* [`sk deploy CUSTOMERPATH`](#sk-deploy-customerpath)
+* [`sk document-handler CUSTOMERPATH`](#sk-document-handler-customerpath)
+* [`sk find-pops APP`](#sk-find-pops-app)
+* [`sk generate-customer-config`](#sk-generate-customer-config)
+* [`sk generate-pop-config APP`](#sk-generate-pop-config-app)
+* [`sk help [COMMANDS]`](#sk-help-commands)
+* [`sk login [APP]`](#sk-login-app)
+* [`sk onboarding CUSTOMERPATH`](#sk-onboarding-customerpath)
+* [`sk param-diff PAGEURL`](#sk-param-diff-pageurl)
+* [`sk plugins`](#sk-plugins)
+* [`sk plugins:install PLUGIN...`](#sk-pluginsinstall-plugin)
+* [`sk plugins:inspect PLUGIN...`](#sk-pluginsinspect-plugin)
+* [`sk plugins:install PLUGIN...`](#sk-pluginsinstall-plugin-1)
+* [`sk plugins:link PLUGIN`](#sk-pluginslink-plugin)
+* [`sk plugins:uninstall PLUGIN...`](#sk-pluginsuninstall-plugin)
+* [`sk plugins reset`](#sk-plugins-reset)
+* [`sk plugins:uninstall PLUGIN...`](#sk-pluginsuninstall-plugin-1)
+* [`sk plugins:uninstall PLUGIN...`](#sk-pluginsuninstall-plugin-2)
+* [`sk plugins update`](#sk-plugins-update)
+* [`sk pop-prewarm APP`](#sk-pop-prewarm-app)
+* [`sk prewarm APP PATH`](#sk-prewarm-app-path)
+* [`sk pull CUSTOMERPATH`](#sk-pull-customerpath)
+* [`sk wpt-launcher URLS TESTID`](#sk-wpt-launcher-urls-testid)
+
+## `sk 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](https://github.com/oclif/plugin-autocomplete/blob/v3.0.1/src/commands/autocomplete/index.ts)_
+
+## `sk build-parameter-query CUSTOMERPATH`
+
+Build 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 CUSTOMERPATH`
+
+Build 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 CUSTOMERPATH`
+
+Deploys 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 CUSTOMERPATH`
+
+Creates 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 APP`
+
+Get 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-config`
+
+Generates 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 APP`
+
+Generate 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](https://github.com/oclif/plugin-help/blob/v6.0.5/src/commands/help.ts)_
+
+## `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 CUSTOMERPATH`
+
+Start 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 PAGEURL`
+
+Shows 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 plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ sk plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ sk plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/index.ts)_
+
+## `sk plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ sk plugins add plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences yarn output.
+  -v, --verbose  Show verbose yarn output.
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ sk plugins add
+
+EXAMPLES
+  $ sk plugins:install myplugin 
+
+  $ sk plugins:install https://github.com/someuser/someplugin
+
+  $ sk plugins:install someuser/someplugin
+```
+
+## `sk plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ sk plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ sk plugins:inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/inspect.ts)_
+
+## `sk plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ sk plugins install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences yarn output.
+  -v, --verbose  Show verbose yarn output.
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ sk plugins add
+
+EXAMPLES
+  $ sk plugins:install myplugin 
+
+  $ sk plugins:install https://github.com/someuser/someplugin
+
+  $ sk plugins:install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/install.ts)_
+
+## `sk plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ sk plugins link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ sk plugins:link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/link.ts)_
+
+## `sk plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ sk plugins remove plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ sk plugins unlink
+  $ sk plugins remove
+```
+
+## `sk plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ sk plugins reset
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/reset.ts)_
+
+## `sk plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ sk plugins uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ sk plugins unlink
+  $ sk plugins remove
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/uninstall.ts)_
+
+## `sk plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ sk plugins unlink plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ sk plugins unlink
+  $ sk plugins remove
+```
+
+## `sk plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ sk plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.2/src/commands/plugins/update.ts)_
+
+## `sk pop-prewarm APP`
+
+Pre-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 PATH`
+
+Pre-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 CUSTOMERPATH`
+
+Pull 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 TESTID`
+
+Analyze 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
+```
+<!-- commandsstop -->