CLIDefinition
Input shape accepted by createCLISchema.
Every field except name is optional. Commands accept either definitions or already-built schemas. Plugins are execution state and have no definition field.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/cli/index.ts - Source link:
src/core/cli/index.ts:573
Signatures
interface CLIDefinition {}Members
Properties
name
Program name used in help text, usage lines, and completion scripts.
name: string;inheritName
Whether .run() should replace name with the invoked program name.
inheritName?: boolean | undefined;version
Program version shown by --version.
version?: string | undefined;versionAlias
Short version alias without its leading dash.
versionAlias?: string | undefined;description
Program description shown in root help.
description?: string | undefined;defaultCommandRouted
Whether the default command is also exposed as a named top-level route.
defaultCommandRouted?: boolean | undefined;configSettings
Config discovery settings, as a definition or an already-built value.
configSettings?: ConfigSettingsDefinition | ConfigSettings | undefined;packageJsonSettings
Manifest auto-discovery settings.
packageJsonSettings?: ResolvedManifestSettings | undefined;helpLinks
OSC 8 hyperlink targets for the root-help header.
helpLinks?: HelpLinks | undefined;hasBuiltInCompletions
Whether built-in .completions() registration is active.
hasBuiltInCompletions?: boolean | undefined;completionsFlag
Eager --completions <shell> flag configuration.
completionsFlag?: CompletionsFlagConfig | undefined;helpConfig
Consumer-configured root-help defaults.
helpConfig?: HelpConfig | undefined;flagSettings
Flag-parsing behavior settings.
flagSettings?: ParseOptions | undefined;builtins
Which built-in flags the root keeps.
builtins?: BuiltinsConfig | undefined;envPrefix
CLI-wide environment namespace for relative env bindings, used verbatim ('ACME_' turns TOKEN into ACME_TOKEN).
envPrefix?: string | undefined;commands
Registered command definitions or built schemas, in registration order.
commands?: readonly (CommandDefinition | CommandSchema)[] | undefined;defaultCommand
Default command dispatched when no subcommand matches.
defaultCommand?: CommandDefinition | CommandSchema | undefined;