@wooksjs/event-cli 0.4.10 → 0.4.12

package/dist/index.d.ts

@@ -1,282 +1,266 @@
-import { CliHelpRenderer } from '@prostojs/cli-help';
-import minimist from 'minimist';
-import { TCliEntry } from '@prostojs/cli-help';
-import { TCliHelpOptions } from '@prostojs/cli-help';
-import { TConsoleBase } from '@prostojs/logger';
-import { TEmpty } from '@wooksjs/event-core';
-import { TEventOptions } from '@wooksjs/event-core';
-import { TGenericContextStore } from '@wooksjs/event-core';
-import { TProstoRouterPathHandle } from '@prostojs/router';
-import { TWooksHandler } from '@wooksjs/wooks';
-import { TWooksHandler as TWooksHandler_2 } from 'wooks';
-import { TWooksOptions } from 'wooks';
-import { Wooks } from 'wooks';
-import { WooksAdapterBase } from 'wooks';
-
-export declare const cliShortcuts: {
-    cli: string;
-};
-
-/**
- * Factory for WooksCli App
- * @param opts TWooksCliOptions
- * @param wooks Wooks | WooksAdapterBase
- * @returns WooksCli
- */
-export declare function createCliApp(opts?: TWooksCliOptions, wooks?: Wooks | WooksAdapterBase): WooksCli;
-
-export declare function createCliContext(data: Omit<TCliEventData, 'type'>, options: TEventOptions): {
-    getCtx: () => TCliContextStore & TGenericContextStore<TCliEventData>;
-    restoreCtx: () => TGenericContextStore<TEmpty>;
-    clearCtx: () => null;
-    store: <K extends "flags" | keyof TGenericContextStore<TCliEventData>>(key: K) => {
-        value: (TCliContextStore & TGenericContextStore<TCliEventData>)[K];
-        hook: <K2 extends keyof Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>(key2: K2) => {
-            value: Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K][K2];
-            isDefined: boolean;
-        };
-        init: <K2_1 extends keyof Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>(key2: K2_1, getter: () => Required<Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>[K2_1]) => Required<Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>[K2_1];
-        set: <K2_2 extends keyof Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>(key2: K2_2, v: Required<(TCliContextStore & TGenericContextStore<TCliEventData>)[K]>[K2_2]) => Required<(TCliContextStore & TGenericContextStore<TCliEventData>)[K]>[K2_2];
-        get: <K2_3 extends keyof Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>(key2: K2_3) => Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K][K2_3];
-        has: <K2_4 extends keyof Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>(key2: K2_4) => boolean;
-        del: <K2_5 extends keyof Required<TCliContextStore & TGenericContextStore<TCliEventData>>[K]>(key2: K2_5) => void;
-        entries: () => [string, unknown][];
-        clear: () => void;
-    };
-    getStore: <K_1 extends "flags" | keyof TGenericContextStore<TCliEventData>>(key: K_1) => (TCliContextStore & TGenericContextStore<TCliEventData>)[K_1];
-    setStore: <K_2 extends "flags" | keyof TGenericContextStore<TCliEventData>>(key: K_2, v: (TCliContextStore & TGenericContextStore<TCliEventData>)[K_2]) => void;
-};
-
-export declare interface TCliContextStore {
-    flags?: {
-        [name: string]: boolean | string;
-    };
-}
-
-export declare interface TCliEventData {
-    argv: string[];
-    pathParams: string[];
-    command: string;
-    opts?: minimist.Opts;
-    type: 'CLI';
-    cliHelp: TCliHelpRenderer;
-}
-
-export declare type TCliHelpCustom = {
-    handler: TWooksHandler<any>;
-    /**
-     * ### Callback for registered path
-     *
-     * @param path registered path
-     * @param aliasType 0 - direct command, 1 - direct alias, 2 - computed alias
-     */
-    cb?: <T>(path: string, aliasType: number, route?: TProstoRouterPathHandle<T>) => void;
-};
-
-export declare type TCliHelpRenderer = CliHelpRenderer<TCliHelpCustom>;
-
-export declare interface TWooksCliEntry<T> extends Omit<TCliEntry<TWooksHandler_2<T>>, 'custom' | 'command'> {
-    onRegister?: TCliHelpCustom['cb'];
-    handler: TWooksHandler_2<T>;
-}
-
-export declare interface TWooksCliOptions {
-    onError?(e: Error): void;
-    onNotFound?: TWooksHandler_2<unknown>;
-    onUnknownCommand?: (params: string[], raiseError: () => void) => unknown;
-    logger?: TConsoleBase;
-    eventOptions?: TEventOptions;
-    cliHelp?: TCliHelpRenderer | TCliHelpOptions;
-    router?: TWooksOptions['router'];
-}
-
-/**
- * ## useAutoHelp
- * ### Composable
- *
- * Prints help if `--help` option provided.
- *
- * ```js
- *  // example of use: print help and exit
- *  app.cli('test', () => {
- *      useAutoHelp() && process.exit(0)
- *      return 'hit test command'
- *  })
- *
- *  // add option -h to print help, no colors
- *  app.cli('test/nocolors', () => {
- *      useAutoHelp(['help', 'h'], false) && process.exit(0)
- *      return 'hit test nocolors command'
- *  })
- * ```
- * @param keys default `['help']` - list of options to trigger help render
- * @param colors default `true`, prints with colors when true
- * @returns true when --help was provided. Otherwise returns false
- */
-export declare function useAutoHelp(keys?: string[], colors?: boolean): true | undefined;
-
-/**
- * Wrapper on top of useEventContext that provides
- * proper context types for CLI event
- * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
- */
-export declare function useCliContext<T extends TEmpty>(): {
-    getCtx: () => TCliContextStore & T & TGenericContextStore<TCliEventData>;
-    restoreCtx: () => TGenericContextStore<TEmpty>;
-    clearCtx: () => null;
-    store: <K extends "flags" | keyof TGenericContextStore<TCliEventData> | keyof T>(key: K) => {
-        value: (TCliContextStore & T & TGenericContextStore<TCliEventData>)[K];
-        hook: <K2 extends keyof Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>(key2: K2) => {
-            value: Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K][K2];
-            isDefined: boolean;
-        };
-        init: <K2_1 extends keyof Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>(key2: K2_1, getter: () => Required<Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>[K2_1]) => Required<Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>[K2_1];
-        set: <K2_2 extends keyof Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>(key2: K2_2, v: Required<(TCliContextStore & T & TGenericContextStore<TCliEventData>)[K]>[K2_2]) => Required<(TCliContextStore & T & TGenericContextStore<TCliEventData>)[K]>[K2_2];
-        get: <K2_3 extends keyof Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>(key2: K2_3) => Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K][K2_3];
-        has: <K2_4 extends keyof Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>(key2: K2_4) => boolean;
-        del: <K2_5 extends keyof Required<TCliContextStore & T & TGenericContextStore<TCliEventData>>[K]>(key2: K2_5) => void;
-        entries: () => [string, unknown][];
-        clear: () => void;
-    };
-    getStore: <K_1 extends "flags" | keyof TGenericContextStore<TCliEventData> | keyof T>(key: K_1) => (TCliContextStore & T & TGenericContextStore<TCliEventData>)[K_1];
-    setStore: <K_2 extends "flags" | keyof TGenericContextStore<TCliEventData> | keyof T>(key: K_2, v: (TCliContextStore & T & TGenericContextStore<TCliEventData>)[K_2]) => void;
-};
-
-/**
- * ## useCliHelp
- * ### Composable
- * ```js
- * // example of printing cli instructions
- * const { print } = useCliHelp()
- * // print with colors
- * print(true)
- * // print with no colors
- * // print(false)
- * ```
- * @returns
- */
-export declare function useCliHelp(): {
-    getCliHelp: () => TCliHelpRenderer;
-    getEntry: () => TCliEntry<TCliHelpCustom>;
-    render: (width?: number, withColors?: boolean) => string[];
-    print: (withColors?: boolean) => void;
-};
-
-/**
- * Getter for Cli Option value
- *
- * @param name name of the option
- * @returns value of a CLI option
- */
-export declare function useCliOption(name: string): string | boolean;
-
-/**
- * Get CLI Options
- *
- * @returns an object with CLI options
- */
-export declare function useCliOptions(): {
-    [name: string]: string | boolean;
-};
-
-/**
- * ##useCommandLookupHelp
- * ### Composable
- *
- * Tries to find valid command based on provided command.
- *
- * If manages to find a valid command, throws an error
- * suggesting a list of valid commands
- *
- * Best to use in `onUnknownCommand` callback:
- *
- * ```js
- *  const app = createCliApp({
- *      onUnknownCommand: (path, raiseError) => {
- *          // will throw an error suggesting a list
- *          // of valid commands if could find some
- *          useCommandLookupHelp()
- *          // fallback to a regular error handler
- *          raiseError()
- *      },
- *  })
- * ```
- *
- * @param lookupDepth depth of search in backwards
- * @example
- *
- * For provided command `run test:drive dir`
- *  - lookup1: `run test:drive dir`  (deep = 0)
- *  - lookup2: `run test:drive`      (deep = 1)
- *  - lookup3: `run test`            (deep = 2)
- *  - lookup4: `run`                 (deep = 3)
- * ...
- */
-export declare function useCommandLookupHelp(lookupDepth?: number): void;
-
-export declare class WooksCli extends WooksAdapterBase {
-    protected opts?: TWooksCliOptions | undefined;
-    protected logger: TConsoleBase;
-    protected cliHelp: TCliHelpRenderer;
-    constructor(opts?: TWooksCliOptions | undefined, wooks?: Wooks | WooksAdapterBase);
-    /**
-     * ### Register CLI Command
-     * Command path segments may be separated by / or space.
-     *
-     * For example the folowing path are interpreted the same:
-     * - "command test use:dev :name"
-     * - "command/test/use:dev/:name"
-     *
-     * Where name will become an argument
-     *
-     * ```js
-     * // example without options
-     * app.cli('command/:arg', () => 'arg = ' + useRouteParams().params.arg )
-     *
-     * // example with options
-     * app.cli('command/:arg', {
-     *   description: 'Description of the command',
-     *   options: [{ keys: ['project', 'p'], description: 'Description of the option', value: 'myProject' }],
-     *   args: { arg: 'Description of the arg' },
-     *   aliases: ['cmd'],  // alias "cmd/:arg" will be registered
-     *   examples: [{
-     *      description: 'Example of usage with someProject',
-     *      cmd: 'argValue -p=someProject',
-     *      // will result in help display:
-     *      // "# Example of usage with someProject\n" +
-     *      // "$ myCli command argValue -p=someProject\n"
-     *   }],
-     *   handler: () => 'arg = ' + useRouteParams().params.arg
-     * })
-     * ```
-     *
-     * @param path command path
-     * @param _options handler or options
-     *
-     * @returns
-     */
-    cli<ResType = unknown, ParamsType = Record<string, string | string[]>>(path: string, _options: TWooksCliEntry<ResType> | TWooksHandler_2<ResType>): TProstoRouterPathHandle<ParamsType>;
-    protected alreadyComputedAliases: boolean;
-    protected computeAliases(): void;
-    /**
-     * ## run
-     * ### Start command processing
-     * Triggers command processing
-     *
-     * By default takes `process.argv.slice(2)` as a command
-     *
-     * It's possible to replace the command by passing an argument
-     *
-     * @param _argv optionally overwrite `process.argv.slice(2)` with your `argv` array
-     */
-    run(_argv?: string[], _opts?: minimist.Opts): Promise<void>;
-    protected onError(e: Error): void;
-    /**
-     * Triggers `unknown command` processing and callbacks
-     * @param pathParams `string[]` containing command
-     */
-    onUnknownCommand(pathParams: string[]): void;
-    protected error(e: string | Error): void;
-}
-
-export { }
+import * as _wooksjs_event_core from '@wooksjs/event-core';
+import { TEventOptions, TEmpty } from '@wooksjs/event-core';
+import * as _prostojs_cli_help from '@prostojs/cli-help';
+import { CliHelpRenderer, TCliHelpOptions, TCliEntry } from '@prostojs/cli-help';
+import * as _prostojs_router from '@prostojs/router';
+import { TProstoRouterPathHandle } from '@prostojs/router';
+import { TWooksHandler, TWooksOptions, WooksAdapterBase, Wooks } from 'wooks';
+import minimist from 'minimist';
+import { TConsoleBase } from '@prostojs/logger';
+
+interface TCliEventData {
+    argv: string[];
+    pathParams: string[];
+    command: string;
+    opts?: minimist.Opts;
+    type: 'CLI';
+    cliHelp: TCliHelpRenderer;
+}
+interface TCliContextStore {
+    flags?: {
+        [name: string]: boolean | string;
+    };
+}
+type TCliHelpCustom = {
+    handler: TWooksHandler<any>;
+    /**
+     * ### Callback for registered path
+     *
+     * @param path registered path
+     * @param aliasType 0 - direct command, 1 - direct alias, 2 - computed alias
+     */
+    cb?: <T>(path: string, aliasType: number, route?: TProstoRouterPathHandle<T>) => void;
+};
+type TCliHelpRenderer = CliHelpRenderer<TCliHelpCustom>;
+
+declare function createCliContext(data: Omit<TCliEventData, 'type'>, options: TEventOptions): {
+    getCtx: () => TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>;
+    restoreCtx: () => _wooksjs_event_core.TGenericContextStore<TEmpty>;
+    clearCtx: () => null;
+    store: <K extends "flags" | keyof _wooksjs_event_core.TGenericContextStore<TCliEventData>>(key: K) => {
+        value: (TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K];
+        hook: <K2 extends keyof Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2) => {
+            value: Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K][K2];
+            isDefined: boolean;
+        };
+        init: <K2_1 extends keyof Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_1, getter: () => Required<Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>[K2_1]) => Required<Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>[K2_1];
+        set: <K2_2 extends keyof Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_2, v: Required<(TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K]>[K2_2]) => Required<(TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K]>[K2_2];
+        get: <K2_3 extends keyof Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_3) => Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K][K2_3];
+        has: <K2_4 extends keyof Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_4) => boolean;
+        del: <K2_5 extends keyof Required<TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_5) => void;
+        entries: () => [string, unknown][];
+        clear: () => void;
+    };
+    getStore: <K_1 extends "flags" | keyof _wooksjs_event_core.TGenericContextStore<TCliEventData>>(key: K_1) => (TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K_1];
+    setStore: <K_2 extends "flags" | keyof _wooksjs_event_core.TGenericContextStore<TCliEventData>>(key: K_2, v: (TCliContextStore & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K_2]) => void;
+};
+/**
+ * Wrapper on top of useEventContext that provides
+ * proper context types for CLI event
+ * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
+ */
+declare function useCliContext<T extends TEmpty>(): {
+    getCtx: () => TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>;
+    restoreCtx: () => _wooksjs_event_core.TGenericContextStore<TEmpty>;
+    clearCtx: () => null;
+    store: <K extends "flags" | keyof _wooksjs_event_core.TGenericContextStore<TCliEventData> | keyof T>(key: K) => {
+        value: (TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K];
+        hook: <K2 extends keyof Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2) => {
+            value: Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K][K2];
+            isDefined: boolean;
+        };
+        init: <K2_1 extends keyof Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_1, getter: () => Required<Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>[K2_1]) => Required<Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>[K2_1];
+        set: <K2_2 extends keyof Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_2, v: Required<(TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K]>[K2_2]) => Required<(TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K]>[K2_2];
+        get: <K2_3 extends keyof Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_3) => Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K][K2_3];
+        has: <K2_4 extends keyof Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_4) => boolean;
+        del: <K2_5 extends keyof Required<TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>>[K]>(key2: K2_5) => void;
+        entries: () => [string, unknown][];
+        clear: () => void;
+    };
+    getStore: <K_1 extends "flags" | keyof _wooksjs_event_core.TGenericContextStore<TCliEventData> | keyof T>(key: K_1) => (TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K_1];
+    setStore: <K_2 extends "flags" | keyof _wooksjs_event_core.TGenericContextStore<TCliEventData> | keyof T>(key: K_2, v: (TCliContextStore & T & _wooksjs_event_core.TGenericContextStore<TCliEventData>)[K_2]) => void;
+};
+
+declare const cliShortcuts: {
+    cli: string;
+};
+interface TWooksCliOptions {
+    onError?(e: Error): void;
+    onNotFound?: TWooksHandler<unknown>;
+    onUnknownCommand?: (params: string[], raiseError: () => void) => unknown;
+    logger?: TConsoleBase;
+    eventOptions?: TEventOptions;
+    cliHelp?: TCliHelpRenderer | TCliHelpOptions;
+    router?: TWooksOptions['router'];
+}
+interface TWooksCliEntry<T> extends Omit<TCliEntry<TWooksHandler<T>>, 'custom' | 'command'> {
+    onRegister?: TCliHelpCustom['cb'];
+    handler: TWooksHandler<T>;
+}
+declare class WooksCli extends WooksAdapterBase {
+    protected opts?: TWooksCliOptions | undefined;
+    protected logger: TConsoleBase;
+    protected cliHelp: TCliHelpRenderer;
+    constructor(opts?: TWooksCliOptions | undefined, wooks?: Wooks | WooksAdapterBase);
+    /**
+     * ### Register CLI Command
+     * Command path segments may be separated by / or space.
+     *
+     * For example the folowing path are interpreted the same:
+     * - "command test use:dev :name"
+     * - "command/test/use:dev/:name"
+     *
+     * Where name will become an argument
+     *
+     * ```js
+     * // example without options
+     * app.cli('command/:arg', () => 'arg = ' + useRouteParams().params.arg )
+     *
+     * // example with options
+     * app.cli('command/:arg', {
+     *   description: 'Description of the command',
+     *   options: [{ keys: ['project', 'p'], description: 'Description of the option', value: 'myProject' }],
+     *   args: { arg: 'Description of the arg' },
+     *   aliases: ['cmd'],  // alias "cmd/:arg" will be registered
+     *   examples: [{
+     *      description: 'Example of usage with someProject',
+     *      cmd: 'argValue -p=someProject',
+     *      // will result in help display:
+     *      // "# Example of usage with someProject\n" +
+     *      // "$ myCli command argValue -p=someProject\n"
+     *   }],
+     *   handler: () => 'arg = ' + useRouteParams().params.arg
+     * })
+     * ```
+     *
+     * @param path command path
+     * @param _options handler or options
+     *
+     * @returns
+     */
+    cli<ResType = unknown, ParamsType = Record<string, string | string[]>>(path: string, _options: TWooksCliEntry<ResType> | TWooksHandler<ResType>): _prostojs_router.TProstoRouterPathHandle<ParamsType>;
+    protected alreadyComputedAliases: boolean;
+    protected computeAliases(): void;
+    /**
+     * ## run
+     * ### Start command processing
+     * Triggers command processing
+     *
+     * By default takes `process.argv.slice(2)` as a command
+     *
+     * It's possible to replace the command by passing an argument
+     *
+     * @param _argv optionally overwrite `process.argv.slice(2)` with your `argv` array
+     */
+    run(_argv?: string[], _opts?: minimist.Opts): Promise<void>;
+    protected onError(e: Error): void;
+    /**
+     * Triggers `unknown command` processing and callbacks
+     * @param pathParams `string[]` containing command
+     */
+    onUnknownCommand(pathParams: string[]): void;
+    protected error(e: string | Error): void;
+}
+/**
+ * Factory for WooksCli App
+ * @param opts TWooksCliOptions
+ * @param wooks Wooks | WooksAdapterBase
+ * @returns WooksCli
+ */
+declare function createCliApp(opts?: TWooksCliOptions, wooks?: Wooks | WooksAdapterBase): WooksCli;
+
+/**
+ * Get CLI Options
+ *
+ * @returns an object with CLI options
+ */
+declare function useCliOptions(): {
+    [name: string]: string | boolean;
+};
+/**
+ * Getter for Cli Option value
+ *
+ * @param name name of the option
+ * @returns value of a CLI option
+ */
+declare function useCliOption(name: string): string | boolean;
+
+/**
+ * ## useCliHelp
+ * ### Composable
+ * ```js
+ * // example of printing cli instructions
+ * const { print } = useCliHelp()
+ * // print with colors
+ * print(true)
+ * // print with no colors
+ * // print(false)
+ * ```
+ * @returns
+ */
+declare function useCliHelp(): {
+    getCliHelp: () => TCliHelpRenderer;
+    getEntry: () => _prostojs_cli_help.TCliEntry<TCliHelpCustom>;
+    render: (width?: number, withColors?: boolean) => string[];
+    print: (withColors?: boolean) => void;
+};
+/**
+ * ## useAutoHelp
+ * ### Composable
+ *
+ * Prints help if `--help` option provided.
+ *
+ * ```js
+ *  // example of use: print help and exit
+ *  app.cli('test', () => {
+ *      useAutoHelp() && process.exit(0)
+ *      return 'hit test command'
+ *  })
+ *
+ *  // add option -h to print help, no colors
+ *  app.cli('test/nocolors', () => {
+ *      useAutoHelp(['help', 'h'], false) && process.exit(0)
+ *      return 'hit test nocolors command'
+ *  })
+ * ```
+ * @param keys default `['help']` - list of options to trigger help render
+ * @param colors default `true`, prints with colors when true
+ * @returns true when --help was provided. Otherwise returns false
+ */
+declare function useAutoHelp(keys?: string[], colors?: boolean): true | undefined;
+/**
+ * ##useCommandLookupHelp
+ * ### Composable
+ *
+ * Tries to find valid command based on provided command.
+ *
+ * If manages to find a valid command, throws an error
+ * suggesting a list of valid commands
+ *
+ * Best to use in `onUnknownCommand` callback:
+ *
+ * ```js
+ *  const app = createCliApp({
+ *      onUnknownCommand: (path, raiseError) => {
+ *          // will throw an error suggesting a list
+ *          // of valid commands if could find some
+ *          useCommandLookupHelp()
+ *          // fallback to a regular error handler
+ *          raiseError()
+ *      },
+ *  })
+ * ```
+ *
+ * @param lookupDepth depth of search in backwards
+ * @example
+ *
+ * For provided command `run test:drive dir`
+ *  - lookup1: `run test:drive dir`  (deep = 0)
+ *  - lookup2: `run test:drive`      (deep = 1)
+ *  - lookup3: `run test`            (deep = 2)
+ *  - lookup4: `run`                 (deep = 3)
+ * ...
+ */
+declare function useCommandLookupHelp(lookupDepth?: number): void;
+
+export { type TCliContextStore, type TCliEventData, type TCliHelpCustom, type TCliHelpRenderer, type TWooksCliEntry, type TWooksCliOptions, WooksCli, cliShortcuts, createCliApp, createCliContext, useAutoHelp, useCliContext, useCliHelp, useCliOption, useCliOptions, useCommandLookupHelp };