Class Cli

Constructors

constructor

new Cli(): Cli
Creates a new Cli instance with empty menus and actions registries. Use addMenu(), addAction(), and run() to build and execute the CLI.

Returns Cli
- Defined in cli.ts:20

Methods

`Static`write

write(text: string, color?: ColorName): void
Writes text to stdout with optional chalk color styling.
Parameters
- text: string
  Text to write.
- Optionalcolor: ColorName
  Optional chalk color name.
Returns void
- Defined in cli.ts:36

`Protected`buildGlobalChoice

buildGlobalChoice(value: string, label: string, item: Action | Menu): Choice
Builds a global choice entry for a Menu or Action.
Parameters
- value: string
  Choice value/name.
- label: string
  Display label.
- item: Action | Menu
  Menu or Action instance.
Returns Choice
- Defined in cli.ts:50

`Protected`menuBelongsToAncestor

menuBelongsToAncestor(
menuName: string | undefined,
ancestorName: string,
): boolean
Returns true if menuName equals ancestorName or has it in its parents chain.
Parameters
- menuName: string | undefined
- ancestorName: string
Returns boolean
- Defined in cli.ts:88

`Protected`isVisibleGlobalItem

isVisibleGlobalItem(
globalItem: Action | Menu,
currentMenuName?: string,
): boolean
Returns true when a global item can be shown in currentMenuName.
Parameters
- globalItem: Action | Menu
- OptionalcurrentMenuName: string
Returns boolean
- Defined in cli.ts:115

`Protected`getGlobalItems

getGlobalItems(currentMenuName?: string): (Action | Menu)[]
Collects all global menus and actions to be added as choices in every menu.
Parameters
- OptionalcurrentMenuName: string
Returns (Action | Menu)[]
- Defined in cli.ts:129

`Protected`getActionTypeBack

getActionTypeBack(menu: MenuChoice | MenuField): ActionGoto | undefined
Creates a "back" action for the given menu, or returns undefined if none should be shown.
Parameters
- menu: MenuChoice | MenuField
  MenuField or MenuChoice to navigate back from.
Returns ActionGoto | undefined
- Defined in cli.ts:155

`Protected`resolveTargetParent

resolveTargetParent(
menu: Menu | undefined,
runtimeParent?: string,
): string | undefined
Resolves the parent menu name, prioritizing runtime parameter over Menu parent list.
Parameters
- menu: Menu | undefined
  The current menu context.
- OptionalruntimeParent: string
  Runtime-provided parent name override.
Returns string | undefined
- Defined in cli.ts:172

`Protected`runMenuInput

runMenuInput(item: MenuInput, parentName?: string): Promise<void>
Executes an input menu interaction and handles its callback.
Parameters
- item: MenuInput
  MenuInput to run.
- OptionalparentName: string
  Optional parent menu name for navigation context.
Returns Promise<void>
- Defined in cli.ts:206

`Protected`runMenuEditor

runMenuEditor(item: MenuEditor, parentName?: string): Promise<void>
Executes an editor menu interaction (opens $EDITOR with pre-populated content).
Parameters
- item: MenuEditor
  MenuEditor to run.
- OptionalparentName: string
  Optional parent menu name for navigation context.
Returns Promise<void>
- Defined in cli.ts:273

`Protected`runMenuChoices

runMenuChoices(item: MenuChoice, parentName?: string): Promise<void>
Executes a choice menu interaction and handles selected items or callbacks.
Parameters
- item: MenuChoice
  MenuChoice to run.
- OptionalparentName: string
  Optional parent menu name for navigation context.
Returns Promise<void>
- Defined in cli.ts:289

`Protected`runMenuField

runMenuField(item: MenuField, parentName?: string): Promise<void>
Executes a field menu interaction (choice + optional input sequence).
Parameters
- item: MenuField
  MenuField to run.
- OptionalparentName: string
  Optional parent menu name for navigation context.
Returns Promise<void>
- Defined in cli.ts:370

`Protected`runActionGoto

runActionGoto(item: ActionGoto, parentName?: string): Promise<void>
Executes a goto action: records the target and returns control to the caller.
Parameters
- item: ActionGoto
  ActionGoto to execute.
- OptionalparentName: string
  Optional parent menu name for navigation context.
Returns Promise<void>
- Defined in cli.ts:511

addPlugin

addPlugin(plugin: PluginJson): this
Registers a plugin and merges its translations, menus and actions.
Parameters
- plugin: PluginJson
  Plugin definition.
Returns this
Current Cli instance for chaining.
- Defined in cli.ts:526

getMenus

getMenus(): Menu[]
Returns all registered menus.

Returns Menu[]
- Defined in cli.ts:540

getMenu

getMenu(name: string): Menu | undefined
Returns a menu by name.
Parameters
- name: string
  Menu name.
Returns Menu | undefined
- Defined in cli.ts:549

addMenu

addMenu(
menu: MenuChoiceJson | MenuInputJson | MenuFieldJson | MenuEditorJson,
plugin?: string,
): this
Adds a menu from JSON config.
Parameters
- menu: MenuChoiceJson | MenuInputJson | MenuFieldJson | MenuEditorJson
  Menu JSON definition.
- Optionalplugin: string
  Optional plugin namespace override.
Returns this
Current Cli instance for chaining.
- Defined in cli.ts:560
addMenu(menu: Menu, plugin?: string): this
Adds an existing Menu instance.
Parameters
- menu: Menu
  Menu instance.
- Optionalplugin: string
  Optional plugin namespace override.
Returns this
Current Cli instance for chaining.
- Defined in cli.ts:569

getActions

getActions(): Action[]
Returns all registered actions.

Returns Action[]
- Defined in cli.ts:610

getAction

getAction(name: string): Action | undefined
Returns an action by name.
Parameters
- name: string
  Action name.
Returns Action | undefined
- Defined in cli.ts:619

addAction

addAction(action: ActionFunctionJson | ActionGotoJson, plugin?: string): this
Adds an action from JSON config.
Parameters
- action: ActionFunctionJson | ActionGotoJson
  Action JSON definition.
- Optionalplugin: string
  Optional plugin namespace override.
Returns this
Current Cli instance for chaining.
- Defined in cli.ts:630
addAction(action: Action, plugin?: string): this
Adds an existing Action instance.
Parameters
- action: Action
  Action instance.
- Optionalplugin: string
  Optional plugin namespace override.
Returns this
Current Cli instance for chaining.
- Defined in cli.ts:639

delAction

delAction(name: string): this
Deletes an action by name.
Parameters
- name: string
  Action name.
Returns this
Current Cli instance for chaining.
- Defined in cli.ts:683

trigger

trigger(menu: Menu, type: string, parent?: string): void | Promise<unknown>
Triggers a shortcut flow from a menu.

Supported built-in shortcuts:
- "back": navigates to the computed parent.
- "exit": executes the global exit action.
Parameters
- menu: Menu
  Current menu context.
- type: string
  Trigger type.
- Optionalparent: string
  Optional runtime parent override.
Returns void | Promise<unknown>
- Defined in cli.ts:699

load

load(): this
Rebuilds reverse links by injecting menus/actions into their parent menus.

Returns this
Current Cli instance for chaining.
- Defined in cli.ts:733

run

run(): Promise<Cli>
Runs the default entry item ("main").

Returns Promise<Cli>
- Defined in cli.ts:762
run(value: string, parent?: string | Action | Menu): Promise<Cli>
Runs an item by name.
Parameters
- value: string
  Menu/action name.
- Optionalparent: string | Action | Menu
  Optional parent context (name or instance).
Returns Promise<Cli>
- Defined in cli.ts:770
run(value: Action | Menu, parent?: string | Action | Menu): Promise<Cli>
Runs an item instance directly.
Parameters
- value: Action | Menu
  Menu or Action instance.
- Optionalparent: string | Action | Menu
  Optional parent context (name or instance).
Returns Promise<Cli>
- Defined in cli.ts:778

toJson

toJson(): Omit<PluginJson, "name" | "version" | "translations">
Serializes current menus and actions into plugin-compatible JSON.

Returns Omit<PluginJson, "name" | "version" | "translations">
- Defined in cli.ts:815

Properties

`Protected`menus

menus: Record<string, Menu>

`Protected`actions

actions: Record<string, Action>

Class Cli

Index

Constructors

Methods

Properties

Constructors

constructor

Returns Cli

Methods

Staticwrite

Parameters

Returns void

ProtectedbuildGlobalChoice

Parameters

Returns Choice

ProtectedmenuBelongsToAncestor

Parameters

Returns boolean

ProtectedisVisibleGlobalItem

Parameters

Returns boolean

ProtectedgetGlobalItems

Parameters

Returns (Action | Menu)[]

ProtectedgetActionTypeBack

Parameters

Returns ActionGoto | undefined

ProtectedresolveTargetParent

Parameters

Returns string | undefined

ProtectedrunMenuInput

Parameters

Returns Promise<void>

ProtectedrunMenuEditor

Parameters

Returns Promise<void>

ProtectedrunMenuChoices

Parameters

Returns Promise<void>

ProtectedrunMenuField

Parameters

Returns Promise<void>

ProtectedrunActionGoto

Parameters

Returns Promise<void>

addPlugin

Parameters

Returns this

getMenus

Returns Menu[]

getMenu

Parameters

Returns Menu | undefined

addMenu

Parameters

Returns this

Parameters

Returns this

getActions

Returns Action[]

getAction

Parameters

Returns Action | undefined

addAction

Parameters

Returns this

Parameters

Returns this

delAction

Parameters

Returns this

trigger

Parameters

Returns void | Promise<unknown>

load

Returns this

run

Returns Promise<Cli>

Parameters

Returns Promise<Cli>

`Static`write

`Protected`buildGlobalChoice

`Protected`menuBelongsToAncestor

`Protected`isVisibleGlobalItem

`Protected`getGlobalItems

`Protected`getActionTypeBack

`Protected`resolveTargetParent

`Protected`runMenuInput

`Protected`runMenuEditor

`Protected`runMenuChoices

`Protected`runMenuField

`Protected`runActionGoto

`Protected`menus

`Protected`actions