@karmaniverous/get-dotenv 2.6.7 → 3.0.0

package/README.md

@@ -3,24 +3,21 @@
 Load environment variables with a cascade of environment-aware dotenv files. You can:
 
 - Load dotenv files synchronously or asynchronously.
-- Specify the directory containing your dotenv files.
-- Specify the token that identifies dotenv files (e.g. '.env').
-- Specify the token that identifies private vatiables (e.g. 'local').
-- Define dynamic variables progressively in terms of other variables and other logic.
 - Load variables for a specific environment or none.
-- Exclude public or private variables.
-- Extract variables to an object, to `process.env`, or both.
-- Log the result to the console.
-
-The command-line version can pull the environment designator from a number of sources, populate `process.env`, and execute a shell command.
+- Define dynamic variables progressively in terms of other variables and other logic.
+- Exclude public, private, global, environment-specific, or dynamic variables.
+- Extract the resulting variables to an object, `process.env`, a dotenv file, or a logger, in any combination.
+- Specify the directories containing your dotenv files.
+- Specify the filename token that identifies dotenv files (e.g. '.env').
+- Specify the filename extension that identifies private variables (e.g. 'local').
 
 `getdotenv` relies on the excellent [`dotenv`](https://www.npmjs.com/package/dotenv) parser and uses [`dotenv-expand`](https://www.npmjs.com/package/dotenv-expand) for recursive variable expansion.
 
-**So why not just use the very popular [`dotenv-cli`](https://www.npmjs.com/package/dotenv-cli) package to load dotenv file cascades?** A couple of reasons:
+The command-line version populates `process.env` from your dotenv files (you can also specify values inline) and can then execute a shell command within that context. The executing shell is configurable. Any child `getdotenv` instances will inherit as defaults the parent shell's environment and optionally its `getdotenv` settings.
 
-- `dotenv-cli` assumes all your `.env` files are located in your root directory. If you have a lot of environments, you probably want to sequester them into their own directory.
+You can always use `getdotenv` directly on the command line, but its REAL power comes into play when you use it as the foundation of your own CLI. This lets you set defaults globally and configure pre- and post-hooks that mutate your `getdotenv` context and do useful things like grab an AWS session from your dev environment and add it to the command execution context.
 
-- The `dotenv-cli` syntax requires the environment to be set (the `-c` argument) _before_ the shell command is articulated (after the `--`). This doesn't work if you want to write an NPM script that takes the environment as an argument, since in that case it would have to go at the end.
+When you plug your own [`commander`](https://www.npmjs.com/package/commander) CLI commands into the `getdotenv` base, they will execute within all of the environmental context created above!
 
 ## Installation
 
@@ -61,55 +58,63 @@ This function should take the expanded `dotenv` object as an argument and return
 If the corresponding value is a function, it will be executed with the current state of `dotenv` as its single argument and the result applied back to the `dotenv` object. Otherwise, the value will just be applied back to `dotenv`.
 
 Since keys will be evaluated progressively, each successive key function will have access to any previous ones. These keys can also override existing variables.
+
+## More to Come!
+
+Implementation always runs a little behind documentation. These topics & improvements are coming soon:
+
+- Rationalize the package's JSDOC to improve the API documentation below.
+- An example of dotenv-based environment config.
+- Integrating `getdotenv` into your npm scripts.
+- Creating a `getdotenv`-based CLI.
+- Some gotchas & tips around managing your shell execution context.
 
 # Command Line Interface
 
+Note that the defaults below can be changed in your own environment by deriving your base CLI using the `getCli` function.
+
 ```text
-Usage: getdotenv [options] [-- [command]]
-
-Load environment variables with a cascade of environment-aware
-dotenv files. You can:
-
-* Specify the directories containing your dotenv files.
-* Define dynamic variables progressively in terms of other variables and
-  other logic.
-* Specify a consolidated output file path.
-* Load variables for a specific environment or none.
-* Specify a default environment, override the default with an existing
-  environment variable, and override both with a direct setting.
-* Derive the default environment from the current git branch
-* Exclude public, private, global, environment-specific, or dynamic variables.
-* Execute a &&-delimited series of shell commands after loading variables,
-  optionally ignoring errors.
-* Place the shell commands inside the invocation to support npm script
-  arguments for other options.
-* Specify the token that identifies dotenv files (e.g. '.env').
-* Specify the token that identifies private vatiables (e.g. '.local').
-* Load AWS SSO session credentials from an AWS Toolkit profile.
+Usage: getdotenv [options] [command]
+
+Base CLI. All options except delimiters follow dotenv-expand rules.
 
 Options:
-  -p, --paths <strings...>            space-delimited paths to dotenv directory (default './')
-  -y, --dynamic-path <string>         dynamic variables path
-  -o, --output-path <string>          consolidated output file (follows dotenv-expand rules using loaded env vars)
-  -d, --default-environment <string>  default environment (prefix with $ to use environment variable)
-  -b, --branch-to-default             derive default environment from the current git branch (default: false)
-  -e, --environment <string>          designated environment (prefix with $ to use environment variable)
-  -n, --exclude-env                   exclude environment-specific variables (default: false)
-  -g, --exclude-global                exclude global & dynamic variables (default: false)
-  -r, --exclude-private               exclude private variables (default: false)
-  -u, --exclude-public                exclude public variables (default: false)
-  -z, --exclude-dynamic               exclude dynamic variables (default: false)
-  -c, --command <string>              shell command string
-  -l, --log                           log extracted variables (default: false)
-  -t, --dotenv-token <string>         token indicating a dotenv file (default: '.env')
-  -i, --private-token <string>        token indicating private variables (default: 'local')
-  -q, --quit-on-error                 terminate sequential process on error (default: false)
-  -a, --aws-sso-profile <string>      local AWS SSO profile (follows dotenv-expand rules)
-  -h, --help                          display help for command
+  -e, --env <string>            environment name
+  -p, --paths <string>          delimited list of paths to dotenv directory (default: "./")
+  --paths-delimiter <string>    regex paths delimiter (default: "\\s+")
+  -v, --vars <string>           delimited list KEY=VALUE pairs
+  --vars-delimiter <string>     regex vars delimiter (default: "\\s+")
+  --vars-assignor <string>      regex vars assignment operator (default: "=")
+  -y, --dynamic-path <string>   dynamic variables path
+  -o, --output-path <string>    consolidated output file, follows dotenv-expand rules using loaded env vars
+  -n, --exclude-env [bool]      exclude environment-specific variables (default: false)
+  -g, --exclude-global [bool]   exclude global & dynamic variables (default: false)
+  -r, --exclude-private [bool]  exclude private variables (default: false)
+  -u, --exclude-public [bool]   exclude public variables (default: false)
+  -z, --exclude-dynamic [bool]  exclude dynamic variables (default: false)
+  -l, --log [bool]              console log extracted variables (default: false)
+  -x, --suppress-dotenv         suppress dotenv loading (default: false)
+  -c, --command <string>        shell command string
+  -s, --shell <string>          execa shell option
+  --dotenv-token <string>       token indicating a dotenv file (default: ".env")
+  --private-token <string>      token indicating private variables (default: "local")
+  -h, --help                    display help for command
+
+Commands:
+  cmd                           execute shell command string (default command)
+  help [command]                display help for command
 ```
 
 # API Documentation
 
+## Constants
+
+<dl>
+<dt><a href="#getCli">getCli</a> ⇒ <code>object</code></dt>
+<dd><p>Generate a CLI for get-dotenv.</p>
+</dd>
+</dl>
+
 ## Functions
 
 <dl>
@@ -124,11 +129,35 @@ Options:
 ## Typedefs
 
 <dl>
+<dt><a href="#GetDotenvCliOptions">GetDotenvCliOptions</a> : <code>Object</code></dt>
+<dd><p>GetDotenv CLI Options type</p>
+</dd>
+<dt><a href="#GetDotenvPreHookCallback">GetDotenvPreHookCallback</a> ⇒ <code><a href="#GetDotenvCliOptions">GetDotenvCliOptions</a></code></dt>
+<dd><p>GetDotenv CLI Pre-hook Callback type. Transforms inbound options &amp; executes side effects.</p>
+</dd>
+<dt><a href="#GetDotenvPostHookCallback">GetDotenvPostHookCallback</a> : <code>function</code></dt>
+<dd><p>GetDotenv CLI Post-hook Callback type. Executes side effects within getdotenv context.</p>
+</dd>
+<dt><a href="#GetDotenvCliConfig">GetDotenvCliConfig</a> : <code>Object</code></dt>
+<dd><p>GetDotenv CLI Config type</p>
+</dd>
 <dt><a href="#OptionsType">OptionsType</a> : <code>Object</code></dt>
 <dd><p>get-dotenv options type</p>
 </dd>
 </dl>
 
+<a name="getCli"></a>
+
+## getCli ⇒ <code>object</code>
+Generate a CLI for get-dotenv.
+
+**Kind**: global constant  
+**Returns**: <code>object</code> - The CLI command.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [config] | [<code>GetDotenvCliConfig</code>](#GetDotenvCliConfig) | config object |
+
 <a name="getDotenv"></a>
 
 ## getDotenv([options]) ⇒ <code>Promise.&lt;object&gt;</code>
@@ -153,6 +182,72 @@ Synchronously process dotenv files of the form .env[.<ENV>][.<PRIVATETOKEN>]
 | --- | --- | --- |
 | [options] | [<code>OptionsType</code>](#OptionsType) | options object |
 
+<a name="GetDotenvCliOptions"></a>
+
+## GetDotenvCliOptions : <code>Object</code>
+GetDotenv CLI Options type
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| [cliInvocation] | <code>string</code> | cli invocation string (used for cli help) |
+| [dotenvToken] | <code>string</code> | token indicating a dotenv file |
+| [dynamicPath] | <code>string</code> | path to file exporting an object keyed to dynamic variable functions |
+| [env] | <code>string</code> | target environment |
+| [excludeDynamic] | <code>bool</code> | exclude dynamic variables |
+| [excludeEnv] | <code>bool</code> | exclude environment-specific variables |
+| [excludeGlobal] | <code>bool</code> | exclude global & dynamic variables |
+| [excludePrivate] | <code>bool</code> | exclude private variables |
+| [excludePublic] | <code>bool</code> | exclude public variables |
+| [log] | <code>bool</code> | log result to console |
+| [logger] | <code>function</code> | logger function |
+| [outputPath] | <code>string</code> | if populated, writes consolidated .env file to this path (follows [dotenv-expand rules](https://github.com/motdotla/dotenv-expand/blob/master/tests/.env)) |
+| [paths] | <code>string</code> | space-delimited list of input directory paths |
+| [privateToken] | <code>string</code> | token indicating private variables. |
+| [shell] | <code>bool</code> \| <code>string</code> | execa shell option |
+| [suppressDotenv] | <code>bool</code> | suppress dotenv loading |
+
+<a name="GetDotenvPreHookCallback"></a>
+
+## GetDotenvPreHookCallback ⇒ [<code>GetDotenvCliOptions</code>](#GetDotenvCliOptions)
+GetDotenv CLI Pre-hook Callback type. Transforms inbound options & executes side effects.
+
+**Kind**: global typedef  
+**Returns**: [<code>GetDotenvCliOptions</code>](#GetDotenvCliOptions) - transformed GetDotenv CLI Options object (undefined return value is ignored)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | [<code>GetDotenvCliOptions</code>](#GetDotenvCliOptions) | inbound GetDotenv CLI Options object |
+
+<a name="GetDotenvPostHookCallback"></a>
+
+## GetDotenvPostHookCallback : <code>function</code>
+GetDotenv CLI Post-hook Callback type. Executes side effects within getdotenv context.
+
+**Kind**: global typedef  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | [<code>GetDotenvCliOptions</code>](#GetDotenvCliOptions) | GetDotenv CLI Options object |
+| dotenv | <code>object</code> | dotenv object |
+
+<a name="GetDotenvCliConfig"></a>
+
+## GetDotenvCliConfig : <code>Object</code>
+GetDotenv CLI Config type
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| [config] | <code>object</code> | config options |
+| [config.defaultOptions] | [<code>GetDotenvCliOptions</code>](#GetDotenvCliOptions) | default options |
+| [config.preHook] | [<code>GetDotenvPreHookCallback</code>](#GetDotenvPreHookCallback) | transforms inbound options & executes side effects |
+| [config.postHook] | [<code>GetDotenvPostHookCallback</code>](#GetDotenvPostHookCallback) | executes side effects within getdotenv context |
+
 <a name="OptionsType"></a>
 
 ## OptionsType : <code>Object</code>
@@ -163,19 +258,20 @@ get-dotenv options type
 
 | Name | Type | Description |
 | --- | --- | --- |
-| [dotenvToken] | <code>string</code> | token indicating a dotenv file (default: '.env') |
+| [dotenvToken] | <code>string</code> | token indicating a dotenv file |
 | [dynamicPath] | <code>string</code> | path to file exporting an object keyed to dynamic variable functions |
 | [env] | <code>string</code> | target environment |
-| [excludeDynamic] | <code>bool</code> | exclude dynamic variables (default: false) |
-| [excludeEnv] | <code>bool</code> | exclude environment-specific variables (default: false) |
-| [excludeGlobal] | <code>bool</code> | exclude global & dynamic variables (default: false) |
-| [excludePrivate] | <code>bool</code> | exclude private variables (default: false) |
-| [excludePublic] | <code>bool</code> | exclude public variables (default: false) |
-| [loadProcess] | <code>bool</code> | load dotenv to process.env (default: false) |
-| [log] | <code>bool</code> | log result to console (default: false) |
+| [excludeDynamic] | <code>bool</code> | exclude dynamic variables |
+| [excludeEnv] | <code>bool</code> | exclude environment-specific variables |
+| [excludeGlobal] | <code>bool</code> | exclude global & dynamic variables |
+| [excludePrivate] | <code>bool</code> | exclude private variables |
+| [excludePublic] | <code>bool</code> | exclude public variables |
+| [loadProcess] | <code>bool</code> | load dotenv to process.env |
+| [log] | <code>bool</code> | log result to logger |
+| [logger] | <code>function</code> | logger function |
 | [outputPath] | <code>string</code> | if populated, writes consolidated .env file to this path (follows [dotenv-expand rules](https://github.com/motdotla/dotenv-expand/blob/master/tests/.env)) |
-| [paths] | <code>Array.&lt;string&gt;</code> | array of input directory paths (default ['./']) |
-| [privateToken] | <code>string</code> | token indicating private variables (default: 'local'). |
+| [paths] | <code>Array.&lt;string&gt;</code> | array of input directory paths |
+| [privateToken] | <code>string</code> | token indicating private variables |
 
 
 ---

package/bin/getdotenv/index.js

@@ -1,164 +1,8 @@
 #!/usr/bin/env node
 
-// Import npm packages.
-import spawn from 'cross-spawn';
-import { parseArgsStringToArgv } from 'string-argv';
+// lib imports
+import { getCli } from '../../lib/getCli.js';
 
-// Import package exports.
-import {
-  dotenvExpand,
-  getAwsSsoCredentials,
-  getDotenv,
-  parseBranch,
-} from '../../lib/index.js';
+const cli = getCli();
 
-// Create CLI.
-import { program } from 'commander';
-
-// CLI description.
-program
-  .name('getdotenv')
-  .usage('[options] [-- [command]]')
-  .description(
-    [
-      `Load environment variables with a cascade of environment-aware`,
-      `dotenv files. You can:`,
-      ``,
-      `* Specify the directories containing your dotenv files.`,
-      `* Define dynamic variables progressively in terms of other variables and`,
-      `  other logic.`,
-      `* Specify a consolidated output file path.`,
-      `* Load variables for a specific environment or none.`,
-      `* Specify a default environment, override the default with an existing`,
-      `  environment variable, and override both with a direct setting.`,
-      `* Derive the default environment from the current git branch`,
-      `* Exclude public, private, global, environment-specific, or dynamic variables.`,
-      `* Execute a &&-delimited series of shell commands after loading variables,`,
-      `  optionally ignoring errors.`,
-      `* Place the shell commands inside the invocation to support npm script`,
-      `  arguments for other options.`,
-      `* Specify the token that identifies dotenv files (e.g. '.env').`,
-      `* Specify the token that identifies private vatiables (e.g. '.local').`,
-      `* Load AWS SSO session credentials from an AWS Toolkit profile.`,
-    ].join('\n')
-  );
-
-// CLI options.
-program
-  .option(
-    '-p, --paths <strings...>',
-    "space-delimited paths to dotenv directory (default './')"
-  )
-  .option('-y, --dynamic-path <string>', 'dynamic variables path')
-  .option(
-    '-o, --output-path <string>',
-    'consolidated output file (follows dotenv-expand rules using loaded env vars)'
-  )
-  .option(
-    '-d, --default-environment <string>',
-    'default environment (prefix with $ to use environment variable)',
-    dotenvExpand
-  )
-  .option(
-    '-b, --branch-to-default',
-    'derive default environment from the current git branch (default: false)',
-    dotenvExpand
-  )
-  .option(
-    '-e, --environment <string>',
-    'designated environment (prefix with $ to use environment variable)',
-    dotenvExpand
-  )
-  .option(
-    '-n, --exclude-env',
-    'exclude environment-specific variables (default: false)'
-  )
-  .option(
-    '-g, --exclude-global',
-    'exclude global & dynamic variables (default: false)'
-  )
-  .option('-r, --exclude-private', 'exclude private variables (default: false)')
-  .option('-u, --exclude-public', 'exclude public variables (default: false)')
-  .option('-z, --exclude-dynamic', 'exclude dynamic variables (default: false)')
-  .option('-c, --command <string>', 'shell command string')
-  .option('-l, --log', 'log extracted variables (default: false)')
-  .option(
-    '-t, --dotenv-token <string>',
-    "token indicating a dotenv file (default: '.env')"
-  )
-  .option(
-    '-i, --private-token <string>',
-    "token indicating private variables (default: 'local')"
-  )
-  .option(
-    '-q, --quit-on-error',
-    'terminate sequential process on error (default: false)'
-  )
-  .option(
-    '-a, --aws-sso-profile <string>',
-    'local AWS SSO profile (follows dotenv-expand rules)'
-  );
-
-// Parse CLI options from command line.
-program.parse();
-const {
-  awsSsoProfile,
-  branchToDefault,
-  command,
-  defaultEnvironment,
-  dotenvToken,
-  dynamicPath,
-  environment,
-  excludeEnv,
-  excludeGlobal,
-  excludePrivate,
-  excludePublic,
-  log,
-  outputPath,
-  paths,
-  privateToken,
-  quitOnError,
-} = program.opts();
-
-if (command && program.args.length) program.error('command specified twice');
-
-if (branchToDefault) {
-  var { envToken } = parseBranch();
-}
-
-// Get environment.
-const env = environment ?? envToken ?? defaultEnvironment;
-
-// Load dotenvs.
-await getDotenv({
-  dotenvToken,
-  env,
-  excludeEnv,
-  excludeGlobal,
-  excludePrivate,
-  excludePublic,
-  loadProcess: true,
-  dynamicPath,
-  log,
-  outputPath,
-  paths,
-  privateToken,
-});
-
-// Get AWS SSO credentials.
-if (awsSsoProfile) getAwsSsoCredentials(dotenvExpand(awsSsoProfile));
-
-// Execute shell command.
-if (command || program.args.length) {
-  const argvs = (command ?? program.args.join(' '))
-    .split('&&')
-    .map((c) => parseArgsStringToArgv(c));
-
-  for (const argv of argvs) {
-    const { status } = spawn.sync(argv[0], argv.slice(1), {
-      stdio: 'inherit',
-    });
-
-    if (status && quitOnError) process.exit(status);
-  }
-}
+await cli.parseAsync();

package/dist/default/lib/dotenvDefaults.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dotenvDefaults = void 0;
+const dotenvDefaults = {
+  dotenvToken: '.env',
+  excludeDynamic: false,
+  excludeEnv: false,
+  excludeGlobal: false,
+  excludePrivate: false,
+  excludePublic: false,
+  loadProcess: false,
+  log: false,
+  logger: console.log,
+  paths: ['./'],
+  privateToken: 'local'
+};
+exports.dotenvDefaults = dotenvDefaults;

package/dist/default/lib/getCli.js

@@ -0,0 +1,172 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getCli = void 0;
+var _boolean = require("boolean");
+var _commander = require("commander");
+var _execa = require("execa");
+var _lodash = _interopRequireDefault(require("lodash.frompairs"));
+var _lodash2 = _interopRequireDefault(require("lodash.isstring"));
+var _dotenvDefaults = require("./dotenvDefaults.js");
+var _dotenvExpand = require("./dotenvExpand.js");
+var _getDotenv = require("./getDotenv.js");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// npm imports
+
+// lib imports
+
+const booleanExpand = value => (0, _boolean.boolean)((0, _dotenvExpand.dotenvExpand)(value));
+
+/**
+ * GetDotenv CLI Options type
+ *
+ * @typedef {Object} GetDotenvCliOptions
+ * @property {string} [cliInvocation] - cli invocation string (used for cli help)
+ * @property {string} [dotenvToken] - token indicating a dotenv file
+ * @property {string} [dynamicPath] - path to file exporting an object keyed to dynamic variable functions
+ * @property {string} [env] - target environment
+ * @property {bool} [excludeDynamic] - exclude dynamic variables
+ * @property {bool} [excludeEnv] - exclude environment-specific variables
+ * @property {bool} [excludeGlobal] - exclude global & dynamic variables
+ * @property {bool} [excludePrivate] - exclude private variables
+ * @property {bool} [excludePublic] - exclude public variables
+ * @property {bool} [log] - log result to console
+ * @property {function} [logger] - logger function
+ * @property {string} [outputPath] - if populated, writes consolidated .env file to this path (follows {@link https://github.com/motdotla/dotenv-expand/blob/master/tests/.env dotenv-expand rules})
+ * @property {string} [paths] - space-delimited list of input directory paths
+ * @property {string} [privateToken] - token indicating private variables.
+ * @property {bool|string} [shell] - execa shell option
+ * @property {bool} [suppressDotenv] - suppress dotenv loading
+ */
+
+/**
+ * GetDotenv CLI Pre-hook Callback type. Transforms inbound options & executes side effects.
+ *
+ * @async
+ * @callback GetDotenvPreHookCallback
+ * @param {GetDotenvCliOptions} options - inbound GetDotenv CLI Options object
+ * @returns {GetDotenvCliOptions} transformed GetDotenv CLI Options object (undefined return value is ignored)
+ */
+
+/**
+ * GetDotenv CLI Post-hook Callback type. Executes side effects within getdotenv context.
+ *
+ * @async
+ * @callback GetDotenvPostHookCallback
+ * @param {GetDotenvCliOptions} options - GetDotenv CLI Options object
+ * @param {object} dotenv - dotenv object
+ */
+
+/**
+ * GetDotenv CLI Config type
+ *
+ * @typedef {Object} GetDotenvCliConfig
+ * @property {object} [config] - config options
+ * @property {GetDotenvCliOptions} [config.defaultOptions] - default options
+ * @property {GetDotenvPreHookCallback} [config.preHook] - transforms inbound options & executes side effects
+ * @property {GetDotenvPostHookCallback} [config.postHook] - executes side effects within getdotenv context
+ */
+
+/**
+ * Generate a CLI for get-dotenv.
+ *
+ * @param {GetDotenvCliConfig} [config] - config object
+ * @returns {object} The CLI command.
+ */
+const getCli = function () {
+  let {
+    defaultOptions = {},
+    preHook,
+    postHook
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let {
+    cliInvocation = 'getdotenv',
+    command,
+    dotenvToken,
+    dynamicPath,
+    env,
+    excludeDynamic,
+    excludeEnv,
+    excludeGlobal,
+    excludePrivate,
+    excludePublic,
+    log,
+    outputPath,
+    paths,
+    pathsDelimiter = '\\s+',
+    privateToken,
+    shell,
+    suppressDotenv,
+    vars,
+    varsAssignor = '=',
+    varsDelimiter = '\\s+'
+  } = {
+    ..._dotenvDefaults.dotenvDefaults,
+    ...defaultOptions
+  };
+  if (Array.isArray(paths)) paths = paths.join(' ');
+  return new _commander.Command().name(cliInvocation)
+  // .usage('[options] [command] [command options] [commad args]')
+  .description('Base CLI. All options except delimiters follow dotenv-expand rules.').enablePositionalOptions().passThroughOptions().option('-e, --env <string>', 'environment name', _dotenvExpand.dotenvExpand, env).option('-p, --paths <string>', 'delimited list of paths to dotenv directory', _dotenvExpand.dotenvExpand, paths).option('--paths-delimiter <string>', 'regex paths delimiter', pathsDelimiter).option('-v, --vars <string>', 'delimited list KEY=VALUE pairs', _dotenvExpand.dotenvExpand, vars).option('--vars-delimiter <string>', 'regex vars delimiter', varsDelimiter).option('--vars-assignor <string>', 'regex vars assignment operator', varsAssignor).option('-y, --dynamic-path <string>', 'dynamic variables path', _dotenvExpand.dotenvExpand, dynamicPath).option('-o, --output-path <string>', 'consolidated output file, follows dotenv-expand rules using loaded env vars', _dotenvExpand.dotenvExpand, outputPath).option('-n, --exclude-env [bool]', 'exclude environment-specific variables', booleanExpand, excludeEnv ?? false).option('-g, --exclude-global [bool]', 'exclude global & dynamic variables', booleanExpand, excludeGlobal ?? false).option('-r, --exclude-private [bool]', 'exclude private variables', booleanExpand, excludePrivate ?? false).option('-u, --exclude-public [bool]', 'exclude public variables', booleanExpand, excludePublic ?? false).option('-z, --exclude-dynamic [bool]', 'exclude dynamic variables', booleanExpand, excludeDynamic ?? false).option('-l, --log [bool]', 'console log extracted variables', booleanExpand, log ?? false).option('-x, --suppress-dotenv', 'suppress dotenv loading', booleanExpand, suppressDotenv ?? false).option('-c, --command <string>', 'shell command string', _dotenvExpand.dotenvExpand, command).option('-s, --shell <string>', 'execa shell option', _dotenvExpand.dotenvExpand, shell).option('--dotenv-token <string>', 'token indicating a dotenv file', _dotenvExpand.dotenvExpand, dotenvToken).option('--private-token <string>', 'token indicating private variables', _dotenvExpand.dotenvExpand, privateToken).addCommand(new _commander.Command().name('cmd').description('execute shell command string (default command)').configureHelp({
+    showGlobalOptions: true
+  }).enablePositionalOptions().passThroughOptions().action(async (options, _ref) => {
+    let {
+      args,
+      parent
+    } = _ref;
+    if (args.length) await (0, _execa.execaCommand)(args.join(' '), {
+      stdio: 'inherit',
+      shell: parent.opts().shell
+    });
+  }), {
+    isDefault: true
+  }).hook('preSubcommand', async thisCommand => {
+    var _paths;
+    // Inherit options from parent command.
+    let options = {
+      ...(process.env['getdotenvOptions'] ? JSON.parse(process.env['getdotenvOptions']) : {}),
+      ...thisCommand.opts()
+    };
+
+    // Execute pre-hook.
+    if (preHook) options = (await preHook(options)) ?? options;
+
+    // Get options.
+    let {
+      command,
+      paths,
+      pathsDelimiter,
+      suppressDotenv,
+      vars,
+      varsDelimiter,
+      varsAssignor,
+      ...rest
+    } = options;
+
+    // Parse vars.
+    if (vars !== null && vars !== void 0 && vars.length) Object.assign(process.env, (0, _lodash.default)(vars.split(new RegExp(varsDelimiter)).map(v => v.split(new RegExp(varsAssignor)))));
+
+    // Execute getdotenv.
+    if ((_paths = paths) !== null && _paths !== void 0 && _paths.length && !suppressDotenv) {
+      var _paths2;
+      if ((0, _lodash2.default)(paths)) paths = (_paths2 = paths) === null || _paths2 === void 0 ? void 0 : _paths2.split(new RegExp(pathsDelimiter));
+      var dotenv = await (0, _getDotenv.getDotenv)({
+        ...rest,
+        loadProcess: true,
+        paths
+      });
+    }
+
+    // Execute post-hook.
+    if (postHook) await postHook(options, dotenv);
+
+    // Execute shell command.
+    if (command) await (0, _execa.execaCommand)(command, {
+      stdio: 'inherit',
+      shell
+    });
+  });
+};
+exports.getCli = getCli;