@speedkit/cli 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [2.11.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.10.0...v2.11.0) (2024-03-15)
+
+
+### Bug Fixes
+
+* **onboarding:** fix wrong path to fileEventHandler) ([6be965a](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/6be965ac4155cb139162f7fc615e5911cca02c5a))
+
+
+### Features
+
+* **docs:** update readme ([f658a14](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/f658a1477d7f22a3429ef94483857a50e74d4b0b))
+* **onboarding:** enable use of chrome extensions ([ad54021](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/ad540216fe79a8ad049a9ba676e5627b415e49c4))
+* **userCliConfig:** make use of userConfig overall' ([5e5b1e7](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/5e5b1e764bafd0c09282799f32bda13dde86df1a))
+
+# [2.10.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.9.0...v2.10.0) (2024-03-15)
+
+
+### Features
+
+* update dependencies ([30f8889](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/30f88894848e224546747d1aeed566ea15607bb9))
+
 # [2.9.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.8.0...v2.9.0) (2024-03-15)
 
 

package/README.md

@@ -1,86 +1,67 @@
 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" 
-}
-```
+## Quicklinks
 
----
-  
 <!-- toc -->
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
+* [Contributing](./CONTRIBUTING.md)
+* [Changelog](./CHANGELOG.md)
+
 # Usage
+
 <!-- usage -->
 ```sh-session
 $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.9.0 linux-x64 node-v20.11.1
+@speedkit/cli/2.11.0 linux-x64 node-v20.11.1
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
 ...
 ```
 <!-- usagestop -->
+
+## Configure
+
+There are two different ways of configuring the CLI:
+- [Using Config File (recommended)](#using-config-file-recommended)
+- [Using Environment Variables](#using-environment-variables)
+
+### Using Config File (recommended)
+
+On the first execution of any `sk` command a `config.json` will be created and stored to the current user's directory of your OS:
+- Unix: `~/.config/speed-kit-cli/config.json`
+- Windows: `%LOCALAPPDATA%\speed-kit-cli\config.json`
+
+```json5
+{
+  "chromePath": "",             // local path to the Chrome binary
+  "chromeUserProfilePath": "",  // local path to the Custom Chrome User Profile (use if you want to have Chrome's state saved)
+  "chromeExtensionPaths": "",   // comma separated list of local paths to unpacked extensions for Chrome to load
+  "slackToken": "",             // Slack token that will be injected to the deploymentDetection
+  "testApp": "",                // name of your Test Speed Kit App
+  "ideaDirectory": "",          // local directory path to the IntelliJ's shell binary
+  "diffExec": "",               // path or executable of your favorite diff tool e.g. "vscode --diff", "codium --diff", "diff", "idea diff"
+  "diffExecTemplate": ""        // defaults to "$exec $file1 $file2" resolves in "diff pathToFile1 pathToFile2"
+}
+```
+
+### Using Environment Variables
+
+By either...
+- copying [.env.sample](./.env.sample) as `.env` to the directory of the cloned [sk-onboarding](https://gitlab.orestes.info/baqend/sk-onboarding)
+- or by exporting [the listed variables](./.env.sample) to your shell as needed before using a specific CLI command.
+
 # Commands
 <!-- commands -->
 * [`sk autocomplete [SHELL]`](#sk-autocomplete-shell)
@@ -91,7 +72,7 @@ USAGE
 * [`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 help [COMMAND]`](#sk-help-command)
 * [`sk login [APP]`](#sk-login-app)
 * [`sk onboarding CUSTOMERPATH`](#sk-onboarding-customerpath)
 * [`sk param-diff PAGEURL`](#sk-param-diff-pageurl)
@@ -183,7 +164,7 @@ Deploys the specified customer config while comparing to the live version before
 
 ```
 USAGE
-  $ sk deploy CUSTOMERPATH [-c <value>] [-t <value>] [-a <value>] [-d]
+  $ sk deploy CUSTOMERPATH [-c <value>] [-a <value>] [-d] [-t <value>]
 
 ARGUMENTS
   CUSTOMERPATH  The customer config path
@@ -309,16 +290,16 @@ EXAMPLES
   $ sk generate-pop-config --coverage 95 --pop-limit 6 --traffic-share 2 --deploy appName
 ```
 
-## `sk help [COMMANDS]`
+## `sk help [COMMAND]`
 
 Display help for sk.
 
 ```
 USAGE
-  $ sk help [COMMANDS] [-n]
+  $ sk help [COMMAND] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMAND  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -327,7 +308,7 @@ DESCRIPTION
   Display help for sk.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.5/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.18/src/commands/help.ts)_
 
 ## `sk login [APP]`
 

package/dist/commands/build-parameter-query.d.ts

@@ -1,15 +1,15 @@
-import { Command } from '@oclif/core';
+import { Command } from "@oclif/core";
 export default class BuildParameterQuery extends Command {
-    static description: string;
     static args: {
         customerPath: import("@oclif/core/lib/interfaces").Arg<string, {
             exists?: boolean;
         }>;
     };
+    static description: string;
+    static examples: string[];
     static flags: {
         configName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
-    static examples: string[];
-    run(): Promise<void>;
     buildParameterQuery(app: string, parameterFilter: string, whitelistedFilter: string, blacklistedFilter: string, parameterReplaceFilter: string): string;
+    run(): Promise<void>;
 }

package/dist/commands/build-parameter-query.js

@@ -4,55 +4,25 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const clipboardy_cjs_1 = tslib_1.__importDefault(require("clipboardy-cjs"));
-const cli_parameters_1 = require("../models/cli-parameters");
+const CustomerConfig_1 = require("../helpers/CustomerConfig");
 const build_query_helper_1 = require("../helpers/build-query-helper");
 const get_parsed_config_1 = require("../helpers/get-parsed-config");
-const CustomerConfig_1 = require("../helpers/CustomerConfig");
 const logging_helper_1 = require("../helpers/logging-helper");
+const cli_parameters_1 = require("../models/cli-parameters");
 class BuildParameterQuery extends core_1.Command {
-    static description = 'Build a parameter query that can be executed in Athena';
     static args = cli_parameters_1.CLI_CUSTOMER_CONFIG;
-    static flags = {
-        ...cli_parameters_1.CLI_CONFIG_NAME
-    };
+    static description = "Build a parameter query that can be executed in Athena";
     static examples = [
         `$ sk build-parameter-query <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}>`,
         `$ sk build-parameter-query ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName}`,
     ];
-    async run() {
-        const { args: { customerPath }, flags: { configName } } = await this.parse(BuildParameterQuery);
-        core_1.ux.action.start('Building parameter query');
-        try {
-            const { app, config } = await CustomerConfig_1.CustomerConfig.loadCustomer(customerPath, configName);
-            const parsedConfig = await (0, get_parsed_config_1.getParsedConfig)(config);
-            const params = (0, build_query_helper_1.getStrippedParams)(parsedConfig);
-            const skConfigVersion = (0, get_parsed_config_1.getSpeedKitConfigVersion)(parsedConfig);
-            const parameterFilter = (0, build_query_helper_1.getParameterFilter)(params, skConfigVersion);
-            const parameterReplaceFilter = (0, build_query_helper_1.getParameterReplaceFilter)(params, skConfigVersion);
-            const whitelistedFilter = (0, build_query_helper_1.getWhitelistedFilter)(parsedConfig);
-            const blacklistedFilter = (0, build_query_helper_1.getBlacklistedFilter)(parsedConfig);
-            const result = this.buildParameterQuery(app || parsedConfig.appName, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter);
-            if (!this.config.windows) {
-                clipboardy_cjs_1.default.writeSync(result);
-            }
-            console.log(chalk_1.default.dim.italic(result));
-            console.log('');
-            core_1.ux.action.stop();
-            console.log('');
-            if (!this.config.windows) {
-                (0, logging_helper_1.logInfo)('Result has been copied to the clipboard 📋');
-            }
-        }
-        catch (e) {
-            console.log('');
-            (0, logging_helper_1.logError)(e.stack);
-        }
-        console.log('');
-    }
+    static flags = {
+        ...cli_parameters_1.CLI_CONFIG_NAME,
+    };
     buildParameterQuery(app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
         const nowMinusOneMonth = new Date(new Date().setMonth(new Date().getMonth() - 1, new Date().getDate()));
-        const monthString = `${nowMinusOneMonth.getMonth() + 1 < 10 ? '0' : ''}${nowMinusOneMonth.getMonth() + 1}`;
-        const dateString = `${nowMinusOneMonth.getDate() < 10 ? '0' : ''}${nowMinusOneMonth.getDate()}`;
+        const monthString = `${nowMinusOneMonth.getMonth() + 1 < 10 ? "0" : ""}${nowMinusOneMonth.getMonth() + 1}`;
+        const dateString = `${nowMinusOneMonth.getDate() < 10 ? "0" : ""}${nowMinusOneMonth.getDate()}`;
         const date = `${nowMinusOneMonth.getFullYear()}-${monthString}-${dateString}`;
         return `
 with urlWithParams as (
@@ -91,5 +61,35 @@ from prepared
 where cardinality(paramKeys) > 0
 order by potentialGain desc, cachedUrls desc, PIs desc`;
     }
+    async run() {
+        const { args: { customerPath }, flags: { configName }, } = await this.parse(BuildParameterQuery);
+        core_1.ux.action.start("Building parameter query");
+        try {
+            const { app, config } = await CustomerConfig_1.CustomerConfig.loadCustomer(customerPath, configName);
+            const parsedConfig = await (0, get_parsed_config_1.getParsedConfig)(config);
+            const params = (0, build_query_helper_1.getStrippedParams)(parsedConfig);
+            const skConfigVersion = (0, get_parsed_config_1.getSpeedKitConfigVersion)(parsedConfig);
+            const parameterFilter = (0, build_query_helper_1.getParameterFilter)(params, skConfigVersion);
+            const parameterReplaceFilter = (0, build_query_helper_1.getParameterReplaceFilter)(params, skConfigVersion);
+            const whitelistedFilter = (0, build_query_helper_1.getWhitelistedFilter)(parsedConfig);
+            const blacklistedFilter = (0, build_query_helper_1.getBlacklistedFilter)(parsedConfig);
+            const result = this.buildParameterQuery(app || parsedConfig.appName, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter);
+            if (!this.config.windows) {
+                clipboardy_cjs_1.default.writeSync(result);
+            }
+            console.log(chalk_1.default.dim.italic(result));
+            console.log("");
+            core_1.ux.action.stop();
+            console.log("");
+            if (!this.config.windows) {
+                (0, logging_helper_1.logInfo)("Result has been copied to the clipboard 📋");
+            }
+        }
+        catch (error) {
+            console.log("");
+            (0, logging_helper_1.logError)(error.stack);
+        }
+        console.log("");
+    }
 }
 exports.default = BuildParameterQuery;

package/dist/commands/build-prewarm-query.d.ts

@@ -1,15 +1,15 @@
-import { Command } from '@oclif/core';
+import { Command } from "@oclif/core";
 export default class BuildPrewarmQuery extends Command {
-    static description: string;
     static args: {
         customerPath: import("@oclif/core/lib/interfaces").Arg<string, {
             exists?: boolean;
         }>;
     };
+    static description: string;
+    static examples: string[];
     static flags: {
         configName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
-    static examples: string[];
-    run(): Promise<void>;
     buildPrewarmQuery(app: string, whitelistedFilter: string, blacklistedFilter: string, parameterReplaceFilter: string): string;
+    run(): Promise<void>;
 }

package/dist/commands/build-prewarm-query.js

@@ -2,27 +2,43 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const core_2 = require("@oclif/core");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const clipboardy_cjs_1 = tslib_1.__importDefault(require("clipboardy-cjs"));
-const cli_parameters_1 = require("../models/cli-parameters");
+const CustomerConfig_1 = require("../helpers/CustomerConfig");
 const build_query_helper_1 = require("../helpers/build-query-helper");
 const get_parsed_config_1 = require("../helpers/get-parsed-config");
 const logging_helper_1 = require("../helpers/logging-helper");
-const CustomerConfig_1 = require("../helpers/CustomerConfig");
+const cli_parameters_1 = require("../models/cli-parameters");
 class BuildPrewarmQuery extends core_1.Command {
-    static description = 'Build a prewarm query that can be executed in Athena';
     static args = cli_parameters_1.CLI_CUSTOMER_CONFIG;
-    static flags = {
-        ...cli_parameters_1.CLI_CONFIG_NAME
-    };
+    static description = "Build a prewarm query that can be executed in Athena";
     static examples = [
         `$ sk build-prewarm-query <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}>`,
         `$ sk build-prewarm-query ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName}`,
     ];
+    static flags = {
+        ...cli_parameters_1.CLI_CONFIG_NAME,
+    };
+    buildPrewarmQuery(app, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
+        const now = new Date();
+        now.setDate(now.getDate() - 10);
+        const date = now.toISOString().split("T")[0];
+        return `
+select url
+from (
+select regexp_replace(regexp_replace(${parameterReplaceFilter}, '(^[^&?]*)&','$1?'), '\\?$','') as url,
+uadevice
+from live.rum.pi
+where app = '${app}'
+  and date >= '${date}'
+  and ${whitelistedFilter}
+  and ${blacklistedFilter})
+group by url
+order by count(*) desc`;
+    }
     async run() {
-        const { args: { customerPath }, flags: { configName } } = await this.parse(BuildPrewarmQuery);
-        core_2.ux.action.start('Building pre-warm query');
+        const { args: { customerPath }, flags: { configName }, } = await this.parse(BuildPrewarmQuery);
+        core_1.ux.action.start("Building pre-warm query");
         try {
             const { app, config } = await CustomerConfig_1.CustomerConfig.loadCustomer(customerPath, configName);
             const parsedConfig = await (0, get_parsed_config_1.getParsedConfig)(config);
@@ -35,35 +51,18 @@ class BuildPrewarmQuery extends core_1.Command {
                 clipboardy_cjs_1.default.writeSync(result);
             }
             console.log(chalk_1.default.dim.italic(result));
-            console.log('');
-            core_2.ux.action.stop();
-            console.log('');
+            console.log("");
+            core_1.ux.action.stop();
+            console.log("");
             if (!this.config.windows) {
-                (0, logging_helper_1.logInfo)('Result has been copied to the clipboard 📋');
+                (0, logging_helper_1.logInfo)("Result has been copied to the clipboard 📋");
             }
         }
-        catch (e) {
-            console.log('');
-            (0, logging_helper_1.logError)(e.stack);
+        catch (error) {
+            console.log("");
+            (0, logging_helper_1.logError)(error.stack);
         }
-        console.log('');
-    }
-    buildPrewarmQuery(app, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
-        const now = new Date();
-        now.setDate(now.getDate() - 10);
-        const date = now.toISOString().split('T')[0];
-        return `
-select url
-from (
-select regexp_replace(regexp_replace(${parameterReplaceFilter}, '(^[^&?]*)&','$1?'), '\\?$','') as url,
-uadevice
-from live.rum.pi
-where app = '${app}'
-  and date >= '${date}'
-  and ${whitelistedFilter}
-  and ${blacklistedFilter})
-group by url
-order by count(*) desc`;
+        console.log("");
     }
 }
 exports.default = BuildPrewarmQuery;

package/dist/commands/deploy.d.ts

@@ -1,17 +1,17 @@
-import { Command } from '@oclif/core';
+import { Command } from "@oclif/core";
 export default class Deploy extends Command {
-    static description: string;
     static args: {
         customerPath: import("@oclif/core/lib/interfaces").Arg<string, {
             exists?: boolean;
         }>;
     };
+    static description: string;
+    static examples: string[];
     static flags: {
-        slackToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         artifacts: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        slackToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         configName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
-    static examples: string[];
     run(): Promise<void>;
 }

package/dist/commands/deploy.js

@@ -1,36 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-/* eslint-disable valid-jsdoc, no-await-in-loop */
 const core_1 = require("@oclif/core");
+const cli_config_1 = require("../helpers/cli-config");
 const cli_parameters_1 = require("../models/cli-parameters");
 const deploy_context_1 = tslib_1.__importDefault(require("../services/deploy/context/deploy-context"));
 const deploy_service_factory_1 = tslib_1.__importDefault(require("../services/deploy/deploy-service-factory"));
-const cli_config_1 = require("../helpers/cli-config");
 class Deploy extends core_1.Command {
-    static description = 'Deploys the specified customer config while comparing to the live version before';
     static args = cli_parameters_1.CLI_CUSTOMER_CONFIG;
+    static description = "Deploys the specified customer config while comparing to the live version before";
+    static examples = [
+        `$ sk deploy <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}> -${cli_parameters_1.CLIParametersChar.SlackToken} <${cli_parameters_1.CLIParameters.SlackToken}> -${cli_parameters_1.CLIParametersChar.Artifacts} <${cli_parameters_1.CLIParameters.Artifacts}> -${cli_parameters_1.CLIParametersChar.DryRun} <${cli_parameters_1.CLIParameters.DryRun}>`,
+        `$ sk deploy ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName} -${cli_parameters_1.CLIParametersChar.SlackToken} ${cli_parameters_1.CLIParametersExample.SlackToken} -${cli_parameters_1.CLIParametersChar.Artifacts} ${cli_parameters_1.CLIParametersExample.Artifacts} -${cli_parameters_1.CLIParametersChar.DryRun}`,
+    ];
     static flags = {
         ...cli_parameters_1.CLI_CONFIG_NAME,
-        [cli_parameters_1.CLIParameters.SlackToken]: core_1.Flags.string({
-            description: 'Slack hook found on 1Pass',
-            char: cli_parameters_1.CLIParametersChar.SlackToken
-        }),
         [cli_parameters_1.CLIParameters.Artifacts]: core_1.Flags.string({
-            description: 'Whitelist of files to deploy',
-            char: cli_parameters_1.CLIParametersChar.Artifacts
+            char: cli_parameters_1.CLIParametersChar.Artifacts,
+            description: "Whitelist of files to deploy",
         }),
         [cli_parameters_1.CLIParameters.DryRun]: core_1.Flags.boolean({
-            description: 'Do not deploy changes',
             char: cli_parameters_1.CLIParametersChar.DryRun,
+            description: "Do not deploy changes",
+        }),
+        [cli_parameters_1.CLIParameters.SlackToken]: core_1.Flags.string({
+            char: cli_parameters_1.CLIParametersChar.SlackToken,
+            description: "Slack hook found on 1Pass",
         }),
     };
-    static examples = [
-        `$ sk deploy <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}> -${cli_parameters_1.CLIParametersChar.SlackToken} <${cli_parameters_1.CLIParameters.SlackToken}> -${cli_parameters_1.CLIParametersChar.Artifacts} <${cli_parameters_1.CLIParameters.Artifacts}> -${cli_parameters_1.CLIParametersChar.DryRun} <${cli_parameters_1.CLIParameters.DryRun}>`,
-        `$ sk deploy ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName} -${cli_parameters_1.CLIParametersChar.SlackToken} ${cli_parameters_1.CLIParametersExample.SlackToken} -${cli_parameters_1.CLIParametersChar.Artifacts} ${cli_parameters_1.CLIParametersExample.Artifacts} -${cli_parameters_1.CLIParametersChar.DryRun}`,
-    ];
     async run() {
-        const { args: { customerPath }, flags: { configName, slackToken, artifacts, dryRun } } = await this.parse(Deploy);
+        const { args: { customerPath }, flags: { artifacts, configName, dryRun, slackToken }, } = await this.parse(Deploy);
         const deployContext = new deploy_context_1.default(customerPath, configName, slackToken, artifacts, dryRun);
         const deployService = await new deploy_service_factory_1.default(deployContext, new cli_config_1.CliConfig(this.config).load()).buildService();
         await deployService.run();

package/dist/commands/find-pops.js

@@ -17,9 +17,9 @@ class FindPops extends core_1.Command {
     static description = 'Get IPs for all fastly PoPs';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
-            required: true,
-            description: 'The customers appName',
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
+            description: 'The customers appName', // help description
             hidden: false, // hide this arg from help
         }),
     };
@@ -65,7 +65,7 @@ class FindPops extends core_1.Command {
                     Host: `${app}.app.baqend.com`,
                     authorization: `BAT ${token}`,
                 },
-                timeout: 10000,
+                timeout: 10_000,
             });
             const servedBy = resp.headers.get('x-served-by');
             if (resp.status !== 200 || !servedBy) {

package/dist/commands/generate-pop-config.js

@@ -68,9 +68,9 @@ const percentageFormatter = new Intl.NumberFormat("en-US", {
 class GeneratePopConfig extends core_1.Command {
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            description: "The customers appName",
-            hidden: false,
-            name: cli_parameters_1.CLIParameters.AppName,
+            description: "The customers appName", // help description
+            hidden: false, // hide this arg from help
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
             required: true, // make the arg required with `required: true`
         }),
     };

package/dist/commands/login.js

@@ -10,7 +10,7 @@ class Login extends core_1.Command {
     static description = 'Login to your app';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
             required: false,
             default: 'bbq',
             description: 'The customers appName', // help description

package/dist/commands/pop-prewarm.js

@@ -11,9 +11,9 @@ class PopPrewarm extends core_1.Command {
     static description = 'Pre-warm Fastly PoPs';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
-            required: true,
-            description: 'The customers appName',
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
+            description: 'The customers appName', // help description
             hidden: false, // hide this arg from help
         }),
     };

package/dist/commands/prewarm.js

@@ -13,13 +13,13 @@ class Prewarm extends core_1.Command {
     static description = 'Pre-warm Fastly';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
-            required: true,
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
             description: 'The customer app name', // help description
         }),
         [cli_parameters_1.CLIParameters.Path]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.Path,
-            required: true,
+            name: cli_parameters_1.CLIParameters.Path, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
             description: 'path to prewarmFile', // help description
         }),
     };

package/dist/commands/wpt-launcher.js

@@ -9,11 +9,11 @@ class WptLauncher extends core_1.Command {
     static description = 'Analyze the performance impact that Speed Kit has compared to the original version.';
     static args = {
         [cli_parameters_1.CLIParameters.Urls]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.Urls,
+            name: cli_parameters_1.CLIParameters.Urls, // name of arg to show in help and reference with args[name]
             required: true, // make the arg required with `required: true`
         }),
         [cli_parameters_1.CLIParameters.TestId]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.TestId,
+            name: cli_parameters_1.CLIParameters.TestId, // name of arg to show in help and reference with args[name]
             required: true, // make the arg required with `required: true`
         }),
     };

package/dist/helpers/cli-config.d.ts

@@ -1,22 +1,23 @@
 import { Config } from "@oclif/core/lib/config";
 export type UserCliConfig = {
+    chromeExtensionPaths: string;
     chromePath: string;
     chromeUserProfilePath: string;
-    slackToken: string;
-    speedKitBrowserExtensionPath: string;
-    testApp: string;
-    ideaDirectory: string;
     diffExec: string;
     diffExecTemplate: string;
+    ideaDirectory: string;
+    slackToken: string;
+    testApp: string;
 };
 export declare class CliConfig {
     private config;
     private userCliConfig;
     constructor(config: Config);
     load(): UserCliConfig;
-    private loadConfigFromEnvironment;
-    private getConfigFilePath;
-    private loadConfigFromConfigFile;
     private createEmptyConfigFile;
     private createEmptyUserConfig;
+    private getConfigFilePath;
+    private loadConfigFromConfigFile;
+    private loadConfigFromEnvironment;
+    private readCliConfigFromFile;
 }