cli

Generated reference page for the cli function export.

• Import: @kjanat/dreamcli
• Export kind: function
• Declared in: src/core/cli/index.ts
• Source link: src/core/cli/index.ts:2274

Signatures

Overload 1

function cli(name: string, options?: Omit<CLIOptions, "name">): CLIBuilder;

Overload 2

function cli(options: CLIOptions): CLIBuilder;

Members

Members

cli

Create a new CLI program builder.

The CLI name is used in help text, usage lines, and generated completion scripts.

(name: string, options?: Omit<CLIOptions, "name">): CLIBuilder;

cli

Create a new CLI program builder from an options object.

(options: CLIOptions): CLIBuilder;

Examples

cli('mycli')
  .version('1.0.0')
  .description('My awesome tool')
  .command(deploy)
  .command(login)
  .run();

cli({ inherit: true })
  .command(deploy)
  .run();

Related Examples

• Basic single-command CLI. - examples/basic.ts
• The v3 flag-type family in one command. - examples/flag-types.ts
• Help rendering configuration. - examples/help-config.ts
• Interactive prompts with config file fallback. - examples/interactive.ts
• Mixed machine-readable JSON and human-readable side-channel output. - examples/json-mode.ts
• Middleware patterns: auth guard, request timing, error handling. - examples/middleware.ts
• Multi-command CLI with nested command groups (git-like). - examples/multi-command.ts
• Output channel extras: colors, hyperlinks, and exit codes without throwing. - examples/output-extras.ts
• Parser-level controls: negation, duplicate policy, and spelling parity. - examples/parser-control.ts
• Spinner and progress bar usage. - examples/spinner-progress.ts
• Standard Schema validation for custom flags and args. - examples/standard-schema.ts
• Single-transport launcher (language-server style). - examples/transport-launcher.ts

See Also

• Examples overview
• Example Hover
• API overview
• @kjanat/dreamcli