CLISchema
Runtime descriptor for the CLI program.
Stores the program name, version, description, and registered commands.
Built incrementally by CLIBuilder.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/cli/index.ts - Source link:
packages/dreamcli/src/core/cli/index.ts:147
Signatures
interface CLISchema {}Members
Properties
commands
Registered commands (type-erased for heterogeneous storage).
commands: readonly ErasedCommand[];configSettings
Config discovery settings.
When defined, .run() auto-discovers and loads a config file before command dispatch.
Set via the .config() builder method.
configSettings: ConfigSettings | undefined;defaultCommand
Default command dispatched when no subcommand matches.
When set, the CLI root behaves like a hybrid command group: subcommands dispatch by name as usual, but empty argv or flags-only argv falls through to this command instead of showing root help.
Set via the .default() builder method.
defaultCommand: ErasedCommand | undefined;description
Program description (shown in root help).
description: string | undefined;hasBuiltInCompletions
Whether built-in .completions() command registration is active.
hasBuiltInCompletions: boolean;inheritName
Whether .run() should replace name with the invoked program name.
Set via the cli({ inherit: true }) factory form.
inheritName: boolean;name
Program name (used in help text, usage lines, and completion scripts).
name: string;packageJsonSettings
Package.json auto-discovery settings. When defined, .run() discovers the nearest package.json and merges metadata before dispatch.
Set via the .packageJson() builder method.
packageJsonSettings: PackageJsonSettings | undefined;plugins
Registered CLI plugins.
plugins: readonly CLIPlugin[];version
Program version (shown by --version).
version: string | undefined;