Interface: CliArgManifest

Makaio Framework / contracts / CliArgManifest

Interface: CliArgManifest

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

Describes a single positional argument or named option for a CLI subcommand.

This is the serializable, framework-agnostic counterpart to CliSubcommandDefinition — it carries only metadata, no handler.

Properties

description

readonly description: string

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

One-line description shown in help text.

name

readonly name: string

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

Argument or option name. For positional args this is the display name shown in usage text. For named options it is the schema field name. The CLI adapter converts it to a kebab-case long flag when registering Commander options (e.g. 'clientId' -> --client-id).

positional?

readonly optional positional?: boolean

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

When true, treat as a positional argument rather than a named option.

required?

readonly optional required?: boolean

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

When true, the CLI parser rejects invocations that omit this argument.

short?

readonly optional short?: string

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

Short single-character flag alias (e.g. '-p').

type?

readonly optional type?: "string" | "number" | "boolean"

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

Value type for this argument or option. Used by manifest-based CLI registration to determine whether an option takes a value or is a boolean flag. Defaults to 'string' when omitted. Manifest-based registration also uses this metadata to coerce numeric values before they reach the subcommand’s Zod schema.