@moostjs/event-cli 0.5.28 → 0.5.30

package/dist/index.cjs

@@ -1,4 +1,3 @@
-"use strict";
 //#region rolldown:runtime
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -32,16 +31,46 @@ function getCliMate() {
 
 //#endregion
 //#region packages/event-cli/src/decorators/cli.decorator.ts
-function Cli(path) {
+/**
+* ## Define CLI Command
+* ### @MethodDecorator
+*
+* 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
+*
+* @param path - command path
+* @returns
+*/ function Cli(path) {
 	return getCliMate().decorate("handlers", {
 		path: path?.replace(/\s+/g, "/"),
 		type: "CLI"
 	}, true);
 }
-function CliAlias(alias) {
+/**
+* ## Define CLI Command Alias
+* ### @MethodDecorator
+*
+* Use it to define alias for @Cli('...') command
+*
+* @param path - command alias path
+* @returns
+*/ function CliAlias(alias) {
 	return getCliMate().decorate("cliAliases", alias, true);
 }
-function CliExample(cmd, description) {
+/**
+* ## Define CLI Example
+* ### @MethodDecorator
+*
+* Use it to define example for Cli Help display
+*
+* @param path - command alias path
+* @returns
+*/ function CliExample(cmd, description) {
 	return getCliMate().decorate("cliExamples", {
 		cmd,
 		description
@@ -57,11 +86,35 @@ function formatParams(keys) {
 
 //#endregion
 //#region packages/event-cli/src/decorators/option.decorator.ts
-function CliOption(...keys) {
+/**
+* ## Define CLI Option
+* ### @ParameterDecorator
+* Use together with @Description('...') to document cli option
+*
+* ```ts
+* │   @Cli('command')
+* │   command(
+* │      @Description('Test option...')
+* │      @CliOption('test', 't')
+* │      test: boolean,
+* │   ) {
+* │       return `test=${ test }`
+* │   }
+* ```
+*
+* @param keys list of keys (short and long alternatives)
+* @returns
+*/ function CliOption(...keys) {
 	const mate = getCliMate();
 	return mate.apply(mate.decorate("cliOptionsKeys", keys, false), (0, moost.Resolve)(() => (0, __wooksjs_event_cli.useCliOption)(keys[0]), formatParams(keys).join(", ")));
 }
-function CliGlobalOption(option) {
+/**
+* ## Define Global CLI Option
+* ### @ClassDecorator
+* The option described here will appear in every command instructions
+* @param option keys and description of CLI option
+* @returns
+*/ function CliGlobalOption(option) {
 	const mate = getCliMate();
 	return mate.decorate("cliOptions", option, true);
 }
@@ -80,25 +133,54 @@ function _define_property$1(obj, key, value) {
 }
 const LOGGER_TITLE = "moost-cli";
 const CONTEXT_TYPE = "CLI";
-var MoostCli = class {
+/**
+* ## Moost Cli Adapter
+*
+* Moost Adapter for CLI events
+*
+* ```ts
+* │  // Quick example
+* │  import { MoostCli, Cli, CliOption, cliHelpInterceptor } from '@moostjs/event-cli'
+* │  import { Moost, Param } from 'moost'
+* │
+* │  class MyApp extends Moost {
+* │      @Cli('command/:arg')
+* │      command(
+* │         @Param('arg')
+* │         arg: string,
+* │         @CliOption('test', 't')
+* │         test: boolean,
+* │      ) {
+* │          return `command run with flag arg=${ arg }, test=${ test }`
+* │      }
+* │  }
+* │
+* │  const app = new MyApp()
+* │  app.applyGlobalInterceptors(cliHelpInterceptor())
+* │
+* │  const cli = new MoostCli()
+* │  app.adapter(cli)
+* │  app.init()
+* ```
+*/ var MoostCli = class {
 	async onNotFound() {
 		const pathParams = (0, __wooksjs_event_cli.useCliContext)().store("event").get("pathParams") || [];
 		const response = await (0, moost.defineMoostEventHandler)({
 			loggerTitle: LOGGER_TITLE,
 			getIterceptorHandler: () => this.moost?.getGlobalInterceptorHandler(),
 			getControllerInstance: () => this.moost,
-			callControllerMethod: () => undefined,
+			callControllerMethod: () => void 0,
 			logErrors: this.opts?.debug,
 			targetPath: "",
 			handlerType: "__SYSTEM__"
 		})();
-		if (response === undefined) this.cliApp.onUnknownCommand(pathParams);
+		if (response === void 0) this.cliApp.onUnknownCommand(pathParams);
 		return response;
 	}
 	onInit(moost$1) {
 		this.moost = moost$1;
 		const boolean = Object.entries(this.optionTypes).filter(([_key, val]) => val.length === 1 && val[0] === Boolean).map(([key, _val]) => key);
-		this.cliApp.run(undefined, { boolean });
+		this.cliApp.run(void 0, { boolean });
 	}
 	bindHandler(opts) {
 		let fn;
@@ -121,7 +203,7 @@ var MoostCli = class {
 			});
 			const meta = getCliMate().read(opts.fakeInstance, opts.method);
 			const classMeta = getCliMate().read(opts.fakeInstance);
-			const cliOptions = new Map();
+			const cliOptions = /* @__PURE__ */ new Map();
 			[
 				...this.opts?.globalCliOptions?.length ? this.opts.globalCliOptions : [],
 				...classMeta?.cliOptions || [],
@@ -155,7 +237,7 @@ var MoostCli = class {
 				handler: fn,
 				onRegister: (path$1, aliasType, route) => {
 					opts.register(handler, path$1, route?.getArgs() || routerBinding.getArgs());
-					if (this.opts?.debug) opts.logHandler(`${"\x1B[36m"}(${aliasTypes[aliasType]})${"\x1B[32m"}${path$1}`);
+					if (this.opts?.debug) opts.logHandler(`(${aliasTypes[aliasType]})${path$1}`);
 				}
 			});
 			opts.register(handler, targetPath, routerBinding.getArgs());
@@ -193,7 +275,18 @@ const aliasTypes = [
 
 //#endregion
 //#region packages/event-cli/src/interceptors/help.interceptor.ts
-const cliHelpInterceptor = (opts) => (0, moost.defineInterceptorFn)(() => {
+/**
+* ### Interceptor Factory for CliHelpRenderer
+*
+* By default intercepts cli calls with flag --help
+* and prints help.
+*
+* ```js
+* new Moost().applyGlobalInterceptors(cliHelpInterceptor({ colors: true }))
+* ```
+* @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+* @returns TInterceptorFn
+*/ const cliHelpInterceptor = (opts) => (0, moost.defineInterceptorFn)(() => {
 	try {
 		if ((0, __wooksjs_event_cli.useAutoHelp)(opts?.helpOptions, opts?.colors)) return "";
 	} catch (error) {}
@@ -202,7 +295,27 @@ const cliHelpInterceptor = (opts) => (0, moost.defineInterceptorFn)(() => {
 		if (!getMethod()) (0, __wooksjs_event_cli.useCommandLookupHelp)(opts.lookupLevel);
 	}
 }, moost.TInterceptorPriority.BEFORE_ALL);
-const CliHelpInterceptor = (...opts) => (0, moost.Intercept)(cliHelpInterceptor(...opts));
+/**
+* ## @Decorator
+* ### Interceptor Factory for CliHelpRenderer
+*
+* By default intercepts cli calls with flag --help
+* and prints help.
+*
+* ```ts
+* // default configuration
+* • @CliHelpInterceptor({ helpOptions: 'help', colors: true })
+*
+* // additional option -h to invoke help renderer
+* • @CliHelpInterceptor({ helpOptions: ['help', 'h'], colors: true })
+*
+* // redefine cli option to invoke help renderer
+* • @CliHelpInterceptor({ helpOptions: ['usage'] })
+* ```
+*
+* @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+* @returns Decorator
+*/ const CliHelpInterceptor = (...opts) => (0, moost.Intercept)(cliHelpInterceptor(...opts));
 
 //#endregion
 //#region packages/event-cli/src/quick-cli.ts
@@ -216,7 +329,23 @@ function _define_property(obj, key, value) {
 	else obj[key] = value;
 	return obj;
 }
-var CliApp = class extends moost.Moost {
+/**
+* Quick CLI App factory class.
+*
+* Use this class to quickly build a CLI application with controllers, help options,
+* and global CLI options. It extends the Moost class and wraps the initialization of MoostCli.
+*
+* @example
+* ```typescript
+* import { CliApp } from '@wooksjs/event-cli'
+* import { Commands } from './commands.controller.ts'
+* new CliApp()
+*  .controllers(Commands)
+*  .useHelp({ name: 'myCli' })
+*  .useOptions([{ keys: ['help'], description: 'Display instructions for the command.' }])
+*  .start()
+* ```
+*/ var CliApp = class extends moost.Moost {
 	/**
 	* Registers one or more CLI controllers.
 	*
@@ -269,7 +398,7 @@ var CliApp = class extends moost.Moost {
 				maxWidth: this._helpOpts.maxWidth,
 				maxLeft: this._helpOpts.maxLeft,
 				mark: this._helpOpts.mark
-			} : undefined },
+			} : void 0 },
 			globalCliOptions: this._globalOpts
 		});
 		this.adapter(cli);
@@ -285,13 +414,13 @@ var CliApp = class extends moost.Moost {
 };
 
 //#endregion
-exports.Cli = Cli
-exports.CliAlias = CliAlias
-exports.CliApp = CliApp
-exports.CliExample = CliExample
-exports.CliGlobalOption = CliGlobalOption
-exports.CliHelpInterceptor = CliHelpInterceptor
-exports.CliOption = CliOption
+exports.Cli = Cli;
+exports.CliAlias = CliAlias;
+exports.CliApp = CliApp;
+exports.CliExample = CliExample;
+exports.CliGlobalOption = CliGlobalOption;
+exports.CliHelpInterceptor = CliHelpInterceptor;
+exports.CliOption = CliOption;
 Object.defineProperty(exports, 'Controller', {
   enumerable: true,
   get: function () {
@@ -310,7 +439,7 @@ Object.defineProperty(exports, 'Intercept', {
     return moost.Intercept;
   }
 });
-exports.MoostCli = MoostCli
+exports.MoostCli = MoostCli;
 Object.defineProperty(exports, 'Optional', {
   enumerable: true,
   get: function () {
@@ -323,7 +452,7 @@ Object.defineProperty(exports, 'Param', {
     return moost.Param;
   }
 });
-exports.cliHelpInterceptor = cliHelpInterceptor
+exports.cliHelpInterceptor = cliHelpInterceptor;
 Object.defineProperty(exports, 'useCliContext', {
   enumerable: true,
   get: function () {

package/dist/index.d.ts

@@ -4,11 +4,70 @@ import * as moost from 'moost';
 import { TMoostAdapter, Moost, TMoostAdapterOptions } from 'moost';
 export { Controller, Description, Intercept, Optional, Param, TInterceptorPriority, defineInterceptorFn } from 'moost';
 
+/**
+ * ## Define CLI Command
+ * ### @MethodDecorator
+ *
+ * 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
+ *
+ * @param path - command path
+ * @returns
+ */
 declare function Cli(path?: string): MethodDecorator;
+/**
+ * ## Define CLI Command Alias
+ * ### @MethodDecorator
+ *
+ * Use it to define alias for @Cli('...') command
+ *
+ * @param path - command alias path
+ * @returns
+ */
 declare function CliAlias(alias: string): MethodDecorator;
+/**
+ * ## Define CLI Example
+ * ### @MethodDecorator
+ *
+ * Use it to define example for Cli Help display
+ *
+ * @param path - command alias path
+ * @returns
+ */
 declare function CliExample(cmd: string, description?: string): MethodDecorator;
 
+/**
+ * ## Define CLI Option
+ * ### @ParameterDecorator
+ * Use together with @Description('...') to document cli option
+ *
+ * ```ts
+ * │   @Cli('command')
+ * │   command(
+ * │      @Description('Test option...')
+ * │      @CliOption('test', 't')
+ * │      test: boolean,
+ * │   ) {
+ * │       return `test=${ test }`
+ * │   }
+ * ```
+ *
+ * @param keys list of keys (short and long alternatives)
+ * @returns
+ */
 declare function CliOption(...keys: string[]): ParameterDecorator;
+/**
+ * ## Define Global CLI Option
+ * ### @ClassDecorator
+ * The option described here will appear in every command instructions
+ * @param option keys and description of CLI option
+ * @returns
+ */
 declare function CliGlobalOption(option: {
     keys: string[];
     description?: string;
@@ -21,14 +80,53 @@ interface TCliHandlerMeta {
     path: string;
 }
 interface TMoostCliOpts {
+    /**
+     * WooksCli options or instance
+     */
     wooksCli?: WooksCli | TWooksCliOptions;
+    /**
+     * more internal logs are printed when true
+     */
     debug?: boolean;
+    /**
+     * Array of cli options applicable to every cli command
+     */
     globalCliOptions?: Array<{
         keys: string[];
         description?: string;
         type?: TFunction;
     }>;
 }
+/**
+ * ## Moost Cli Adapter
+ *
+ * Moost Adapter for CLI events
+ *
+ * ```ts
+ * │  // Quick example
+ * │  import { MoostCli, Cli, CliOption, cliHelpInterceptor } from '@moostjs/event-cli'
+ * │  import { Moost, Param } from 'moost'
+ * │
+ * │  class MyApp extends Moost {
+ * │      @Cli('command/:arg')
+ * │      command(
+ * │         @Param('arg')
+ * │         arg: string,
+ * │         @CliOption('test', 't')
+ * │         test: boolean,
+ * │      ) {
+ * │          return `command run with flag arg=${ arg }, test=${ test }`
+ * │      }
+ * │  }
+ * │
+ * │  const app = new MyApp()
+ * │  app.applyGlobalInterceptors(cliHelpInterceptor())
+ * │
+ * │  const cli = new MoostCli()
+ * │  app.adapter(cli)
+ * │  app.init()
+ * ```
+ */
 declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
     protected opts?: TMoostCliOpts | undefined;
     readonly name = "cli";
@@ -41,16 +139,57 @@ declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
     bindHandler<T extends object = object>(opts: TMoostAdapterOptions<TCliHandlerMeta, T>): void;
 }
 
+/**
+ * ### Interceptor Factory for CliHelpRenderer
+ *
+ * By default intercepts cli calls with flag --help
+ * and prints help.
+ *
+ * ```js
+ * new Moost().applyGlobalInterceptors(cliHelpInterceptor({ colors: true }))
+ * ```
+ * @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+ * @returns TInterceptorFn
+ */
 declare const cliHelpInterceptor: (opts?: {
+    /**
+     * CLI Options that invoke help
+     * ```js
+     * helpOptions: ['help', 'h']
+     * ```
+     */
     helpOptions?: string[];
+    /**
+     * Enable colored help
+     */
     colors?: boolean;
+    /**
+     * Enable lookup for a command
+     */
     lookupLevel?: number;
 }) => moost.TInterceptorFn;
-declare const CliHelpInterceptor: (opts?: {
-    helpOptions?: string[] | undefined;
-    colors?: boolean | undefined;
-    lookupLevel?: number | undefined;
-} | undefined) => ClassDecorator & MethodDecorator;
+/**
+ * ## @Decorator
+ * ### Interceptor Factory for CliHelpRenderer
+ *
+ * By default intercepts cli calls with flag --help
+ * and prints help.
+ *
+ * ```ts
+ * // default configuration
+ * • @CliHelpInterceptor({ helpOptions: 'help', colors: true })
+ *
+ * // additional option -h to invoke help renderer
+ * • @CliHelpInterceptor({ helpOptions: ['help', 'h'], colors: true })
+ *
+ * // redefine cli option to invoke help renderer
+ * • @CliHelpInterceptor({ helpOptions: ['usage'] })
+ * ```
+ *
+ * @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+ * @returns Decorator
+ */
+declare const CliHelpInterceptor: (...opts: Parameters<typeof cliHelpInterceptor>) => ClassDecorator & MethodDecorator;
 
 type THelpOptions = {
     name?: string;
@@ -61,13 +200,66 @@ type THelpOptions = {
     colors?: boolean;
     lookupLevel?: number;
 };
+/**
+ * Quick CLI App factory class.
+ *
+ * Use this class to quickly build a CLI application with controllers, help options,
+ * and global CLI options. It extends the Moost class and wraps the initialization of MoostCli.
+ *
+ * @example
+ * ```typescript
+ * import { CliApp } from '@wooksjs/event-cli'
+ * import { Commands } from './commands.controller.ts'
+ * new CliApp()
+ *  .controllers(Commands)
+ *  .useHelp({ name: 'myCli' })
+ *  .useOptions([{ keys: ['help'], description: 'Display instructions for the command.' }])
+ *  .start()
+ * ```
+ */
 declare class CliApp extends Moost {
     protected _helpOpts?: THelpOptions;
     protected _globalOpts?: TMoostCliOpts['globalCliOptions'];
+    /**
+     * Registers one or more CLI controllers.
+     *
+     * (Shortcut for `registerControllers` method.)
+     *
+     * @param {...(object|Function|[string, object|Function])} controllers - List of controllers.
+     *   Each controller can be an object, a class, or a tuple with a name and the controller.
+     * @returns {this} The CliApp instance for method chaining.
+     */
     controllers(...controllers: Array<object | Function | [string, object | Function]>): this;
+    /**
+     * Configures the CLI help options.
+     *
+     * This method sets the help options for the CLI. It ensures that colored output is enabled
+     * (unless explicitly disabled) and that the lookup level defaults to 3 if not provided.
+     *
+     * @param {THelpOptions} helpOpts - Help options configuration.
+     * @param {boolean} helpOpts.colors - Enable colored output.
+     * @param {number} helpOpts.lookupLevel - Level for help lookup.
+     * @returns {this} The CliApp instance for method chaining.
+     */
     useHelp(helpOpts: THelpOptions): this;
+    /**
+     * Sets the global CLI options.
+     *
+     * @param {TMoostCliOpts['globalCliOptions']} globalOpts - Global options for the CLI.
+     * @returns {this} The CliApp instance for method chaining.
+     */
     useOptions(globalOpts: TMoostCliOpts['globalCliOptions']): this;
+    /**
+     * Starts the CLI application.
+     *
+     * This method creates a MoostCli instance using the configured help and global options,
+     * attaches it via the adapter, applies the CLI help interceptor (if help options are set),
+     * and then initializes the application.
+     *
+     * @returns {any} The result of the initialization process.
+     */
     start(): Promise<void>;
 }
 
-export { Cli, CliAlias, CliApp, CliExample, CliGlobalOption, CliHelpInterceptor, CliOption, MoostCli, type TCliHandlerMeta, type TMoostCliOpts, cliHelpInterceptor };
+export { Cli, CliAlias, CliApp, CliExample, CliGlobalOption, CliHelpInterceptor, CliOption, MoostCli, cliHelpInterceptor };
+export type { TCliHandlerMeta, TMoostCliOpts };

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { Controller, Description, Intercept, Moost, Optional, Param, Resolve, TInterceptorPriority, defineInterceptorFn, defineMoostEventHandler, getMoostMate, setInfactLoggingOptions, useControllerContext } from "moost";
-import { WooksCli, createCliApp, useAutoHelp, useCliContext, useCliOption, useCommandLookupHelp } from "@wooksjs/event-cli";
+import { Controller, Description, Intercept, Intercept as Intercept$1, Moost, Optional, Param, Resolve, TInterceptorPriority, defineInterceptorFn, defineMoostEventHandler, getMoostMate, setInfactLoggingOptions, useControllerContext } from "moost";
+import { WooksCli, createCliApp, useAutoHelp, useCliContext, useCliContext as useCliContext$1, useCliOption, useCommandLookupHelp } from "@wooksjs/event-cli";
 
 //#region packages/event-cli/src/meta-types.ts
 function getCliMate() {
@@ -8,16 +8,46 @@ function getCliMate() {
 
 //#endregion
 //#region packages/event-cli/src/decorators/cli.decorator.ts
-function Cli(path) {
+/**
+* ## Define CLI Command
+* ### @MethodDecorator
+*
+* 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
+*
+* @param path - command path
+* @returns
+*/ function Cli(path) {
 	return getCliMate().decorate("handlers", {
 		path: path?.replace(/\s+/g, "/"),
 		type: "CLI"
 	}, true);
 }
-function CliAlias(alias) {
+/**
+* ## Define CLI Command Alias
+* ### @MethodDecorator
+*
+* Use it to define alias for @Cli('...') command
+*
+* @param path - command alias path
+* @returns
+*/ function CliAlias(alias) {
 	return getCliMate().decorate("cliAliases", alias, true);
 }
-function CliExample(cmd, description) {
+/**
+* ## Define CLI Example
+* ### @MethodDecorator
+*
+* Use it to define example for Cli Help display
+*
+* @param path - command alias path
+* @returns
+*/ function CliExample(cmd, description) {
 	return getCliMate().decorate("cliExamples", {
 		cmd,
 		description
@@ -33,11 +63,35 @@ function formatParams(keys) {
 
 //#endregion
 //#region packages/event-cli/src/decorators/option.decorator.ts
-function CliOption(...keys) {
+/**
+* ## Define CLI Option
+* ### @ParameterDecorator
+* Use together with @Description('...') to document cli option
+*
+* ```ts
+* │   @Cli('command')
+* │   command(
+* │      @Description('Test option...')
+* │      @CliOption('test', 't')
+* │      test: boolean,
+* │   ) {
+* │       return `test=${ test }`
+* │   }
+* ```
+*
+* @param keys list of keys (short and long alternatives)
+* @returns
+*/ function CliOption(...keys) {
 	const mate = getCliMate();
 	return mate.apply(mate.decorate("cliOptionsKeys", keys, false), Resolve(() => useCliOption(keys[0]), formatParams(keys).join(", ")));
 }
-function CliGlobalOption(option) {
+/**
+* ## Define Global CLI Option
+* ### @ClassDecorator
+* The option described here will appear in every command instructions
+* @param option keys and description of CLI option
+* @returns
+*/ function CliGlobalOption(option) {
 	const mate = getCliMate();
 	return mate.decorate("cliOptions", option, true);
 }
@@ -56,25 +110,54 @@ function _define_property$1(obj, key, value) {
 }
 const LOGGER_TITLE = "moost-cli";
 const CONTEXT_TYPE = "CLI";
-var MoostCli = class {
+/**
+* ## Moost Cli Adapter
+*
+* Moost Adapter for CLI events
+*
+* ```ts
+* │  // Quick example
+* │  import { MoostCli, Cli, CliOption, cliHelpInterceptor } from '@moostjs/event-cli'
+* │  import { Moost, Param } from 'moost'
+* │
+* │  class MyApp extends Moost {
+* │      @Cli('command/:arg')
+* │      command(
+* │         @Param('arg')
+* │         arg: string,
+* │         @CliOption('test', 't')
+* │         test: boolean,
+* │      ) {
+* │          return `command run with flag arg=${ arg }, test=${ test }`
+* │      }
+* │  }
+* │
+* │  const app = new MyApp()
+* │  app.applyGlobalInterceptors(cliHelpInterceptor())
+* │
+* │  const cli = new MoostCli()
+* │  app.adapter(cli)
+* │  app.init()
+* ```
+*/ var MoostCli = class {
 	async onNotFound() {
-		const pathParams = useCliContext().store("event").get("pathParams") || [];
+		const pathParams = useCliContext$1().store("event").get("pathParams") || [];
 		const response = await defineMoostEventHandler({
 			loggerTitle: LOGGER_TITLE,
 			getIterceptorHandler: () => this.moost?.getGlobalInterceptorHandler(),
 			getControllerInstance: () => this.moost,
-			callControllerMethod: () => undefined,
+			callControllerMethod: () => void 0,
 			logErrors: this.opts?.debug,
 			targetPath: "",
 			handlerType: "__SYSTEM__"
 		})();
-		if (response === undefined) this.cliApp.onUnknownCommand(pathParams);
+		if (response === void 0) this.cliApp.onUnknownCommand(pathParams);
 		return response;
 	}
 	onInit(moost) {
 		this.moost = moost;
 		const boolean = Object.entries(this.optionTypes).filter(([_key, val]) => val.length === 1 && val[0] === Boolean).map(([key, _val]) => key);
-		this.cliApp.run(undefined, { boolean });
+		this.cliApp.run(void 0, { boolean });
 	}
 	bindHandler(opts) {
 		let fn;
@@ -97,7 +180,7 @@ var MoostCli = class {
 			});
 			const meta = getCliMate().read(opts.fakeInstance, opts.method);
 			const classMeta = getCliMate().read(opts.fakeInstance);
-			const cliOptions = new Map();
+			const cliOptions = /* @__PURE__ */ new Map();
 			[
 				...this.opts?.globalCliOptions?.length ? this.opts.globalCliOptions : [],
 				...classMeta?.cliOptions || [],
@@ -131,7 +214,7 @@ var MoostCli = class {
 				handler: fn,
 				onRegister: (path$1, aliasType, route) => {
 					opts.register(handler, path$1, route?.getArgs() || routerBinding.getArgs());
-					if (this.opts?.debug) opts.logHandler(`${"\x1B[36m"}(${aliasTypes[aliasType]})${"\x1B[32m"}${path$1}`);
+					if (this.opts?.debug) opts.logHandler(`(${aliasTypes[aliasType]})${path$1}`);
 				}
 			});
 			opts.register(handler, targetPath, routerBinding.getArgs());
@@ -169,7 +252,18 @@ const aliasTypes = [
 
 //#endregion
 //#region packages/event-cli/src/interceptors/help.interceptor.ts
-const cliHelpInterceptor = (opts) => defineInterceptorFn(() => {
+/**
+* ### Interceptor Factory for CliHelpRenderer
+*
+* By default intercepts cli calls with flag --help
+* and prints help.
+*
+* ```js
+* new Moost().applyGlobalInterceptors(cliHelpInterceptor({ colors: true }))
+* ```
+* @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+* @returns TInterceptorFn
+*/ const cliHelpInterceptor = (opts) => defineInterceptorFn(() => {
 	try {
 		if (useAutoHelp(opts?.helpOptions, opts?.colors)) return "";
 	} catch (error) {}
@@ -178,7 +272,27 @@ const cliHelpInterceptor = (opts) => defineInterceptorFn(() => {
 		if (!getMethod()) useCommandLookupHelp(opts.lookupLevel);
 	}
 }, TInterceptorPriority.BEFORE_ALL);
-const CliHelpInterceptor = (...opts) => Intercept(cliHelpInterceptor(...opts));
+/**
+* ## @Decorator
+* ### Interceptor Factory for CliHelpRenderer
+*
+* By default intercepts cli calls with flag --help
+* and prints help.
+*
+* ```ts
+* // default configuration
+* • @CliHelpInterceptor({ helpOptions: 'help', colors: true })
+*
+* // additional option -h to invoke help renderer
+* • @CliHelpInterceptor({ helpOptions: ['help', 'h'], colors: true })
+*
+* // redefine cli option to invoke help renderer
+* • @CliHelpInterceptor({ helpOptions: ['usage'] })
+* ```
+*
+* @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+* @returns Decorator
+*/ const CliHelpInterceptor = (...opts) => Intercept$1(cliHelpInterceptor(...opts));
 
 //#endregion
 //#region packages/event-cli/src/quick-cli.ts
@@ -192,7 +306,23 @@ function _define_property(obj, key, value) {
 	else obj[key] = value;
 	return obj;
 }
-var CliApp = class extends Moost {
+/**
+* Quick CLI App factory class.
+*
+* Use this class to quickly build a CLI application with controllers, help options,
+* and global CLI options. It extends the Moost class and wraps the initialization of MoostCli.
+*
+* @example
+* ```typescript
+* import { CliApp } from '@wooksjs/event-cli'
+* import { Commands } from './commands.controller.ts'
+* new CliApp()
+*  .controllers(Commands)
+*  .useHelp({ name: 'myCli' })
+*  .useOptions([{ keys: ['help'], description: 'Display instructions for the command.' }])
+*  .start()
+* ```
+*/ var CliApp = class extends Moost {
 	/**
 	* Registers one or more CLI controllers.
 	*
@@ -245,7 +375,7 @@ var CliApp = class extends Moost {
 				maxWidth: this._helpOpts.maxWidth,
 				maxLeft: this._helpOpts.maxLeft,
 				mark: this._helpOpts.mark
-			} : undefined },
+			} : void 0 },
 			globalCliOptions: this._globalOpts
 		});
 		this.adapter(cli);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/event-cli",
-  "version": "0.5.28",
+  "version": "0.5.30",
   "description": "@moostjs/event-cli",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -37,14 +37,16 @@
     "url": "https://github.com/moostjs/moostjs/issues"
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-cli#readme",
+  "peerDependencies": {
+    "@wooksjs/event-core": "^0.6.1",
+    "wooks": "^0.6.1",
+    "moost": "^0.5.30"
+  },
   "dependencies": {
-    "@wooksjs/event-cli": "^0.6.0",
-    "@wooksjs/event-core": "^0.6.0",
-    "wooks": "^0.6.0",
-    "moost": "^0.5.28"
+    "@wooksjs/event-cli": "^0.6.1"
   },
   "devDependencies": {
-    "vitest": "^3.0.5"
+    "vitest": "3.2.4"
   },
   "scripts": {
     "pub": "pnpm publish --access public",