@cloud-copilot/cli 0.1.38 → 0.2.0

package/dist/cjs/arguments/enumArrayArgument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enumArrayArgument.js","sourceRoot":"","sources":["../../../src/arguments/enumArrayArgument.ts"],"names":[],"mappings":";;AAaA,8CA+CC;AA/CD,SAAgB,iBAAiB,CAE/B,OAAU;IACV,OAAO;QACL,WAAW,EACT,OAAO,CAAC,WAAW;YACnB,oDAAoD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACtF,cAAc,EAAE,KAAK,EACnB,YAA4C,EAC5C,MAAgB,EAC8B,EAAE;YAChD,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACvB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAA;YACpE,CAAC;YACD,MAAM,aAAa,GAAa,EAAE,CAAA;YAClC,MAAM,WAAW,GAAuB,EAAE,CAAA;YAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;gBACtF,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBAC3B,CAAC;qBAAM,CAAC;oBACN,WAAW,CAAC,IAAI,CAAC,KAAyB,CAAC,CAAA;gBAC7C,CAAC;YACH,CAAC;YAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,OAAO;oBACL,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,sCAAsC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;iBAC9H,CAAA;YACH,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,CAAA;QAC5C,CAAC;QACD,YAAY,EAAE,KAAK,EACjB,OAAuC,EACvC,SAA6B,EAC7B,EAAE;YACF,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAA;YAC1B,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,oBAAoB,EAAE,GAAG,EAAE,CAAC,IAAI;KACjC,CAAA;AACH,CAAC"}

package/dist/cjs/arguments/mapArgument.d.ts

@@ -0,0 +1,18 @@
+import { Argument, PerArgumentArgs } from './argument.js';
+type MapResult = Record<string, string[]>;
+/**
+ * Creates a map argument where the first value is the key and the rest are values.
+ *
+ * --arg-name key1 key1Value1 key1Value2 --arg-name key2 key2Value1 key2Value2
+ *
+ * @param options the description and optional default value
+ * @returns a map argument
+ */
+export declare function mapArgument<const O extends {
+    defaultValue: MapResult;
+} & PerArgumentArgs>(options: O): Argument<MapResult>;
+export declare function mapArgument<const O extends {
+    defaultValue?: undefined;
+} & PerArgumentArgs>(options: O): Argument<MapResult | undefined>;
+export {};
+//# sourceMappingURL=mapArgument.d.ts.map

package/dist/cjs/arguments/mapArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapArgument.d.ts","sourceRoot":"","sources":["../../../src/arguments/mapArgument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAmB,MAAM,eAAe,CAAA;AAE1E,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AAEzC;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS;IAAE,YAAY,EAAE,SAAS,CAAA;CAAE,GAAG,eAAe,EACvF,OAAO,EAAE,CAAC,GACT,QAAQ,CAAC,SAAS,CAAC,CAAA;AACtB,wBAAgB,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS;IAAE,YAAY,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG,eAAe,EACxF,OAAO,EAAE,CAAC,GACT,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA"}

package/dist/cjs/arguments/mapArgument.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapArgument = mapArgument;
+function mapArgument(options) {
+    return {
+        description: options.description + `. Each instance requires a key and at least one value.`,
+        validateValues: async (currentValue, values) => {
+            const [first, ...rest] = values;
+            if (!first) {
+                return { valid: false, message: 'a key is required and at least one value is required' };
+            }
+            if (rest.length < 1) {
+                return { valid: false, message: `${first} requires at least one value` };
+            }
+            if (currentValue && first in currentValue) {
+                return { valid: false, message: `${first} is set multiple times` };
+            }
+            return {
+                valid: true,
+                value: {
+                    [first]: rest
+                }
+            };
+        },
+        reduceValues: async (current, newValue) => {
+            if (!current) {
+                return { ...newValue };
+            }
+            return { ...current, ...newValue };
+        },
+        defaultValue: options.defaultValue,
+        acceptMultipleValues: () => true
+    };
+}
+//# sourceMappingURL=mapArgument.js.map

package/dist/cjs/arguments/mapArgument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapArgument.js","sourceRoot":"","sources":["../../../src/arguments/mapArgument.ts"],"names":[],"mappings":";;AAkBA,kCAmCC;AAnCD,SAAgB,WAAW,CAEzB,OAAU;IACV,OAAO;QACL,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,wDAAwD;QAC3F,cAAc,EAAE,KAAK,EACnB,YAAmC,EACnC,MAAgB,EACqB,EAAE;YACvC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,CAAA;YAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,sDAAsD,EAAE,CAAA;YAC1F,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,KAAK,8BAA8B,EAAE,CAAA;YAC1E,CAAC;YACD,IAAI,YAAY,IAAI,KAAK,IAAI,YAAY,EAAE,CAAC;gBAC1C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,KAAK,wBAAwB,EAAE,CAAA;YACpE,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,IAAI;gBACX,KAAK,EAAE;oBACL,CAAC,KAAK,CAAC,EAAE,IAAI;iBACd;aACF,CAAA;QACH,CAAC;QACD,YAAY,EAAE,KAAK,EAAE,OAA8B,EAAE,QAAmB,EAAE,EAAE;YAC1E,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAA;YACxB,CAAC;YACD,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAA;QACpC,CAAC;QACD,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,oBAAoB,EAAE,GAAG,EAAE,CAAC,IAAI;KACjC,CAAA;AACH,CAAC"}

package/dist/cjs/arguments/numberArguments.d.ts

@@ -0,0 +1,17 @@
+export declare const numberArgument: {
+    <const O extends {
+        defaultValue: number;
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<number>;
+    <const O extends {
+        defaultValue?: undefined;
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<number | undefined>;
+};
+export declare const numberArrayArgument: {
+    <const O extends {
+        defaultValue: number[];
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<number[]>;
+    <const O extends {
+        defaultValue?: undefined;
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<number[] | undefined>;
+};
+//# sourceMappingURL=numberArguments.d.ts.map

package/dist/cjs/arguments/numberArguments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numberArguments.d.ts","sourceRoot":"","sources":["../../../src/arguments/numberArguments.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,cAAc;;;;;;;CAAwE,CAAA;AAEnG,eAAO,MAAM,mBAAmB;;;;;;;CAG/B,CAAA"}

package/dist/cjs/arguments/numberArguments.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.numberArrayArgument = exports.numberArgument = void 0;
+const arrayValueArgument_js_1 = require("./arrayValueArgument.js");
+const singleValueArgument_js_1 = require("./singleValueArgument.js");
+function validateNumber(rawValue) {
+    const num = Number(rawValue);
+    if (isNaN(num)) {
+        return { valid: false, message: `expects a number but received ${rawValue}` };
+    }
+    return { valid: true, value: num };
+}
+exports.numberArgument = (0, singleValueArgument_js_1.singleValueArgument)(validateNumber, '. One number required.');
+exports.numberArrayArgument = (0, arrayValueArgument_js_1.arrayValueArgument)(validateNumber, '. One or more numbers required.');
+//# sourceMappingURL=numberArguments.js.map

package/dist/cjs/arguments/numberArguments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numberArguments.js","sourceRoot":"","sources":["../../../src/arguments/numberArguments.ts"],"names":[],"mappings":";;;AACA,mEAA4D;AAC5D,qEAA8D;AAE9D,SAAS,cAAc,CAAC,QAAgB;IACtC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC5B,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,iCAAiC,QAAQ,EAAE,EAAE,CAAA;IAC/E,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;AACpC,CAAC;AAEY,QAAA,cAAc,GAAG,IAAA,4CAAmB,EAAS,cAAc,EAAE,wBAAwB,CAAC,CAAA;AAEtF,QAAA,mBAAmB,GAAG,IAAA,0CAAkB,EACnD,cAAc,EACd,iCAAiC,CAClC,CAAA"}

package/dist/cjs/arguments/singleValueArgument.d.ts

@@ -0,0 +1,15 @@
+import { Argument, PerArgumentArgs, ValidatedValues } from './argument.js';
+type SingleValueValidator<ValueType> = (rawValue: string) => Promise<ValidatedValues<ValueType>> | ValidatedValues<ValueType>;
+/**
+ * Creates a single value argument factory for a specific type
+ */
+export declare function singleValueArgument<ValueType>(validator: SingleValueValidator<ValueType>, descriptionSuffix?: string): {
+    <const O extends {
+        defaultValue: ValueType;
+    } & PerArgumentArgs>(options: O): Argument<ValueType>;
+    <const O extends {
+        defaultValue?: undefined;
+    } & PerArgumentArgs>(options: O): Argument<ValueType | undefined>;
+};
+export {};
+//# sourceMappingURL=singleValueArgument.d.ts.map

package/dist/cjs/arguments/singleValueArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleValueArgument.d.ts","sourceRoot":"","sources":["../../../src/arguments/singleValueArgument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE1E,KAAK,oBAAoB,CAAC,SAAS,IAAI,CACrC,QAAQ,EAAE,MAAM,KACb,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,GAAG,eAAe,CAAC,SAAS,CAAC,CAAA;AAErE;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAC3C,SAAS,EAAE,oBAAoB,CAAC,SAAS,CAAC,EAC1C,iBAAiB,GAAE,MAAW;WAEA,CAAC,SAAS;QAAE,YAAY,EAAE,SAAS,CAAA;KAAE,GAAG,eAAe,WAC1E,CAAC,GACT,QAAQ,CAAC,SAAS,CAAC;WACQ,CAAC,SAAS;QAAE,YAAY,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,eAAe,WAC3E,CAAC,GACT,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;EAkCnC"}

package/dist/cjs/arguments/singleValueArgument.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.singleValueArgument = singleValueArgument;
+/**
+ * Creates a single value argument factory for a specific type
+ */
+function singleValueArgument(validator, descriptionSuffix = '') {
+    function createArgument(options) {
+        return {
+            description: options.description + descriptionSuffix,
+            validateValues: async (currentValue, values) => {
+                if (currentValue !== undefined && currentValue != options.defaultValue) {
+                    return {
+                        valid: false,
+                        message: 'expects a single values but was set multiple times'
+                    };
+                }
+                if (values.length == 0) {
+                    return { valid: false, message: 'a value is required' };
+                }
+                if (values.length > 1) {
+                    return {
+                        valid: false,
+                        message: 'expects a single value but received ' + values.join(', ')
+                    };
+                }
+                return validator(values[0]);
+            },
+            reduceValues: async (current, newValue) => newValue,
+            defaultValue: options.defaultValue
+        };
+    }
+    return createArgument;
+}
+//# sourceMappingURL=singleValueArgument.js.map

package/dist/cjs/arguments/singleValueArgument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleValueArgument.js","sourceRoot":"","sources":["../../../src/arguments/singleValueArgument.ts"],"names":[],"mappings":";;AASA,kDA2CC;AA9CD;;GAEG;AACH,SAAgB,mBAAmB,CACjC,SAA0C,EAC1C,oBAA4B,EAAE;IAQ9B,SAAS,cAAc,CAErB,OAAU;QACV,OAAO;YACL,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,iBAAiB;YACpD,cAAc,EAAE,KAAK,EACnB,YAAmC,EACnC,MAAgB,EACqB,EAAE;gBACvC,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBACvE,OAAO;wBACL,KAAK,EAAE,KAAK;wBACZ,OAAO,EAAE,oDAAoD;qBAC9D,CAAA;gBACH,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBACvB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAA;gBACzD,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,OAAO;wBACL,KAAK,EAAE,KAAK;wBACZ,OAAO,EAAE,sCAAsC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;qBACpE,CAAA;gBACH,CAAC;gBAED,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YAC7B,CAAC;YACD,YAAY,EAAE,KAAK,EAAE,OAA8B,EAAE,QAAmB,EAAE,EAAE,CAAC,QAAQ;YACrF,YAAY,EAAE,OAAO,CAAC,YAAY;SACnC,CAAA;IACH,CAAC;IAED,OAAO,cAAc,CAAA;AACvB,CAAC"}

package/dist/cjs/arguments/stringArguments.d.ts

@@ -0,0 +1,17 @@
+export declare const stringArgument: {
+    <const O extends {
+        defaultValue: string;
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<string>;
+    <const O extends {
+        defaultValue?: undefined;
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<string | undefined>;
+};
+export declare const stringArrayArgument: {
+    <const O extends {
+        defaultValue: string[];
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<string[]>;
+    <const O extends {
+        defaultValue?: undefined;
+    } & import("./argument.js").PerArgumentArgs>(options: O): import("./argument.js").Argument<string[] | undefined>;
+};
+//# sourceMappingURL=stringArguments.d.ts.map

package/dist/cjs/arguments/stringArguments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringArguments.d.ts","sourceRoot":"","sources":["../../../src/arguments/stringArguments.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc;;;;;;;CAM1B,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;;;CAM/B,CAAA"}

package/dist/cjs/arguments/stringArguments.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringArrayArgument = exports.stringArgument = void 0;
+const arrayValueArgument_js_1 = require("./arrayValueArgument.js");
+const singleValueArgument_js_1 = require("./singleValueArgument.js");
+exports.stringArgument = (0, singleValueArgument_js_1.singleValueArgument)((rawValue) => ({
+    valid: true,
+    value: rawValue
+}), '. One string required.');
+exports.stringArrayArgument = (0, arrayValueArgument_js_1.arrayValueArgument)((rawValue) => ({
+    valid: true,
+    value: rawValue
+}), '. One or more strings required.');
+//# sourceMappingURL=stringArguments.js.map

package/dist/cjs/arguments/stringArguments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringArguments.js","sourceRoot":"","sources":["../../../src/arguments/stringArguments.ts"],"names":[],"mappings":";;;AAAA,mEAA4D;AAC5D,qEAA8D;AAEjD,QAAA,cAAc,GAAG,IAAA,4CAAmB,EAC/C,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACb,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,QAAQ;CAChB,CAAC,EACF,wBAAwB,CACzB,CAAA;AAEY,QAAA,mBAAmB,GAAG,IAAA,0CAAkB,EACnD,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACb,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,QAAQ;CAChB,CAAC,EACF,iCAAiC,CAClC,CAAA"}

package/dist/cjs/cli.d.ts

@@ -1,97 +1,41 @@
-/**
- * A boolean argument that has no values.
- */
-export type BooleanArgument = {
-    /**
-     * The single character flag for the argument.
-     */
-    character: string;
-    /**
-     * The type of the argument.
-     */
-    type: 'boolean';
-    /**
-     * The description of the argument.
-     */
-    description: string;
+import { Argument } from './arguments/argument.js';
+type ParsedArguments<T extends Record<string, Argument<any>>> = {
+    [K in keyof T as K]: T[K] extends Argument<infer V> ? V : never;
 };
 /**
- * A standard argument that has one or more values.
+ * A subcommand that can be used in the CLI.
  */
-export type StandardArgument = {
-    /**
-     * Whether the argument accepts single or multiple values.
-     */
-    values: 'single' | 'multiple';
-    /**
-     * The type of the values accepted.
-     */
-    type: 'string' | 'number';
-    /**
-     * The description of the argument.
-     */
-    description: string;
-};
-export type EnumArgument<ValidValues extends readonly string[]> = {
-    /**
-     * Whether the argument accepts single or multiple values.
-     */
-    values: 'single' | 'multiple';
-    /**
-     * Must be 'enum' for an enum argument.
-     */
-    type: 'enum';
-    /**
-     * The valid values for the argument.
-     */
-    validValues: ValidValues;
-    /**
-     * The description of the argument.
-     */
-    description: string;
-};
-/**
- * A CLI argument that can be accepted for a command.
- */
-export type CliArgument = BooleanArgument | StandardArgument | EnumArgument<readonly string[]>;
 export type Subcommand = {
     description: string;
-    options: Record<string, CliArgument>;
-};
-export type OptionConfig = {
-    type: 'string' | 'number' | 'boolean';
-    values: 'single' | 'multiple';
-    description: string;
-    character?: string;
+    arguments: Record<string, Argument<any>>;
 };
 /**
  * A map of CLI argument keys to their configuration.
  */
-export type Config<T extends Record<string, CliArgument>> = T;
-/**
- * Create a type safe configuration for CLI arguments.
- *
- * @param config the configuration for the CLI arguments.
- * @returns the configuration object.
- */
-export declare function createConfig<T extends Record<string, CliArgument>>(config: T): T;
-type ParsedArgs<T extends Record<string, CliArgument>> = {
-    [K in keyof T as K]: T[K] extends {
-        type: 'string';
-    } ? T[K]['values'] extends 'single' ? string | undefined : string[] : T[K] extends {
-        type: 'number';
-    } ? T[K]['values'] extends 'single' ? number | undefined : number[] : T[K] extends {
-        type: 'boolean';
-    } ? boolean : T[K] extends EnumArgument<readonly string[]> ? T[K]['values'] extends 'single' ? T[K]['validValues'][number] | undefined : T[K]['validValues'][number][] : never;
-};
+export type Config<T extends Record<string, Argument<any>>> = T;
+interface ConsoleLogger {
+    log: (...args: any[]) => void;
+}
 /**
  * Additional arguments that can be used to configure the CLI parser.
  */
-export interface AdditionalCliArguments {
+export interface AdditionalCliOptions {
     /**
      * The version of the CLI command. If provided, the CLI provides a --version flag that prints the version and exits.
-     */
-    version?: string;
+     *
+     * If a string is provided, it is printed as-is.
+     * If an object it can have the following properties:
+     * - currentVersion: the current version of the CLI. This can be a string or a function that returns a Promise<string> or string.
+     * - checkForUpdates: Can be:
+     *   - a string name of the npm package to check for updates
+     *   - a function that returns a Promise<string | null> that returns the latest version or null if no update is available.
+     * - updateMessage: a function that takes the current version and latest version and returns a string message to display when an update is available.
+     */
+    version?: string | {
+        currentVersion: string | (() => Promise<string> | string);
+        checkForUpdates?: string | (() => Promise<string | null>);
+        updateMessage?: (current: string, latest: string) => string;
+    };
     /**
      * The argument string from the CLI. If not provided, the process.argv.slice(2) is used.
      */
@@ -128,10 +72,14 @@ export interface AdditionalCliArguments {
      * Defaults to false
      */
     allowOperandsFromStdin?: boolean;
+    /**
+     * A logger to use for printing help messages. If not provided, console.log is used.
+     */
+    consoleLogger?: ConsoleLogger;
 }
-export type SelectedSubcommandWithArgs<C extends Record<string, Subcommand>, O extends Record<string, CliArgument>, A extends AdditionalCliArguments> = keyof C extends never ? {
+export type SelectedSubcommandWithArgs<C extends Record<string, Subcommand>, O extends Record<string, Argument<any>>, A extends AdditionalCliOptions> = keyof C extends never ? {
     subcommand: never;
-    args: ParsedArgs<O>;
+    args: ParsedArguments<O>;
     operands: string[];
     anyValues: boolean;
     printHelp: () => void;
@@ -140,21 +88,21 @@ export type SelectedSubcommandWithArgs<C extends Record<string, Subcommand>, O e
 } ? {
     [K in keyof C]: {
         subcommand: K;
-        args: ParsedArgs<C[K]['options']> & ParsedArgs<O>;
+        args: ParsedArguments<C[K]['arguments']> & ParsedArguments<O>;
         operands: string[];
         anyValues: boolean;
         printHelp: () => void;
     };
 }[keyof C] : {
     subcommand: undefined;
-    args: ParsedArgs<O>;
+    args: ParsedArguments<O>;
     operands: string[];
     anyValues: boolean;
     printHelp: () => void;
 } | {
     [K in keyof C]: {
         subcommand: K;
-        args: ParsedArgs<C[K]['options']> & ParsedArgs<O>;
+        args: ParsedArguments<C[K]['arguments']> & ParsedArguments<O>;
         operands: string[];
         anyValues: boolean;
         printHelp: () => void;
@@ -168,11 +116,11 @@ type Only<A, B> = {
  *
  * @param command the name of the command arguments are being parsed for.
  * @param subcommands the list of subcommands that can be used, if any.
- * @param cliOptions the configuration options for the CLI command.
- * @param additionalArgs additional arguments to be used for parsing and displaying help.
+ * @param cliArgs the configuration options for the CLI command.
+ * @param additionalOptions additional arguments to be used for parsing and displaying help.
  * @returns the parsed arguments, operands, and subcommand if applicable.
  */
-export declare function parseCliArguments<const O extends Record<string, CliArgument>, const C extends Record<string, Subcommand>, const A extends AdditionalCliArguments>(command: string, subcommands: C, cliOptions: Config<O>, additionalArgs?: Only<A, AdditionalCliArguments>): SelectedSubcommandWithArgs<C, O, A>;
-export declare function printHelpContents<O extends Record<string, CliArgument>, C extends Record<string, Subcommand>>(command: string, subcommands: C, cliOptions: O, additionalArgs?: AdditionalCliArguments, selectedSubcommand?: string | undefined): void;
+export declare function parseCliArguments<const O extends Record<string, Argument<any>>, const C extends Record<string, Subcommand>, const A extends AdditionalCliOptions>(command: string, subcommands: C, cliArgs: Config<O>, additionalOptions?: Only<A, AdditionalCliOptions>): Promise<SelectedSubcommandWithArgs<C, O, A>>;
+export declare function printHelpContents<O extends Record<string, Argument<any>>, C extends Record<string, Subcommand>>(command: string, subcommands: C, cliOptions: O, additionalArgs?: AdditionalCliOptions, selectedSubcommand?: string | undefined): void;
 export {};
 //# sourceMappingURL=cli.d.ts.map

package/dist/cjs/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,WAAW,SAAS,SAAS,MAAM,EAAE,IAAI;IAChE;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,gBAAgB,GAAG,YAAY,CAAC,SAAS,MAAM,EAAE,CAAC,CAAA;AAE9F,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;CACrC,CAAA;AAUD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;IACrC,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAA;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAA;AAE7D;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAEhF;AAED,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI;KACtD,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;QAChC,IAAI,EAAE,QAAQ,CAAA;KACf,GACG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,QAAQ,GAC7B,MAAM,GAAG,SAAS,GAClB,MAAM,EAAE,GACV,CAAC,CAAC,CAAC,CAAC,SAAS;QACT,IAAI,EAAE,QAAQ,CAAA;KACf,GACD,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,QAAQ,GAC7B,MAAM,GAAG,SAAS,GAClB,MAAM,EAAE,GACV,CAAC,CAAC,CAAC,CAAC,SAAS;QACT,IAAI,EAAE,SAAS,CAAA;KAChB,GACD,OAAO,GACP,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,SAAS,MAAM,EAAE,CAAC,GAC1C,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,QAAQ,GAC7B,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,GACvC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,EAAE,GAC/B,KAAK;CAChB,CAAA;AASD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACrC,CAAC,SAAS,sBAAsB,IAC9B,MAAM,CAAC,SAAS,KAAK,GACrB;IACE,UAAU,EAAE,KAAK,CAAA;IACjB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB,GACD,CAAC,SAAS;IAAE,iBAAiB,EAAE,IAAI,CAAA;CAAE,GACnC;KACG,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,UAAU,EAAE,CAAC,CAAA;QACb,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;QACjD,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,SAAS,EAAE,MAAM,IAAI,CAAA;KACtB;CACF,CAAC,MAAM,CAAC,CAAC,GAEN;IACE,UAAU,EAAE,SAAS,CAAA;IACrB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB,GACD;KACG,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,UAAU,EAAE,CAAC,CAAA;QACb,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;QACjD,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,SAAS,EAAE,MAAM,IAAI,CAAA;KACtB;CACF,CAAC,MAAM,CAAC,CAAC,CAAA;AAEpB,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACjD,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAEd;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EAC3C,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAC1C,KAAK,CAAC,CAAC,SAAS,sBAAsB,EAEtC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,EACrB,cAAc,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,sBAAsB,CAAC,GAC/C,0BAA0B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CA8TrC;AA+MD,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACrC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAEpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,CAAC,EACb,cAAc,CAAC,EAAE,sBAAsB,EACvC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,GACtC,IAAI,CA4EN"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAGlD,KAAK,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI;KAC7D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChE,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;CACzC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAA;AAS/D,UAAU,aAAa;IACrB,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;OAUG;IAEH,OAAO,CAAC,EACJ,MAAM,GACN;QACE,cAAc,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAA;QACzD,eAAe,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;QACzD,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAA;KAC5D,CAAA;IAEL;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC9B;AAED,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvC,CAAC,SAAS,oBAAoB,IAC5B,MAAM,CAAC,SAAS,KAAK,GACrB;IACE,UAAU,EAAE,KAAK,CAAA;IACjB,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB,GACD,CAAC,SAAS;IAAE,iBAAiB,EAAE,IAAI,CAAA;CAAE,GACnC;KACG,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,UAAU,EAAE,CAAC,CAAA;QACb,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QAC7D,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,SAAS,EAAE,MAAM,IAAI,CAAA;KACtB;CACF,CAAC,MAAM,CAAC,CAAC,GAEN;IACE,UAAU,EAAE,SAAS,CAAA;IACrB,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB,GACD;KACG,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,UAAU,EAAE,CAAC,CAAA;QACb,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QAC7D,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,SAAS,EAAE,MAAM,IAAI,CAAA;KACtB;CACF,CAAC,MAAM,CAAC,CAAC,CAAA;AAEpB,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACjD,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAEd;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC7C,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAC1C,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAEpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAClB,iBAAiB,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,oBAAoB,CAAC,GAChD,OAAO,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAsM9C;AAsID,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAEpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,CAAC,EACb,cAAc,CAAC,EAAE,oBAAoB,EACrC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,GACtC,IAAI,CA+EN"}