Skip to content

Interface: CliManifest

Makaio Framework


Makaio Framework / contracts / CliManifest

Defined in: ../../../packages/contracts/src/extension/manifest.ts:236

Describes the top-level CLI command an extension contributes.

Serializable and framework-agnostic. The executable extension, ExtensionCliContribution, adds the interactive handler and typed subcommand definitions. The CLI router uses this manifest for help generation and command discovery without loading handler code.

readonly description: string

Defined in: ../../../packages/contracts/src/extension/manifest.ts:240

One-line description shown in help text.


readonly optional hasInteractive?: boolean

Defined in: ../../../packages/contracts/src/extension/manifest.ts:255

Whether this extension provides an interactive TUI handler.

When true, invoking the bare command (without a subcommand) launches the interactive handler. When false or omitted, bare invocation shows help. This is a serializable declaration in descriptor.json; the executable handler itself lives in ExtensionCliContribution.interactive.

Named hasInteractive (not interactive) to avoid a type conflict with the ExtensionCliContribution property of the same short name, which carries the function implementation rather than a boolean flag.


readonly name: string

Defined in: ../../../packages/contracts/src/extension/manifest.ts:238

Top-level command name (e.g. 'account-manager').


readonly optional subcommands?: readonly CliSubcommandManifest[]

Defined in: ../../../packages/contracts/src/extension/manifest.ts:242

Non-interactive subcommands registered under this command.