Interface CommandConfig<TOptions>

Configuration for a CLI command

interface CommandConfig<TOptions = Record<string, unknown>> {
    action: (args: string[], options: TOptions) => void | Promise<void>;
    arguments?: ArgumentConfig[];
    description: string;
    name: string;
    options?: OptionConfig[];
}

Type Parameters

TOptions = Record<string, unknown>

Index

Properties

action arguments? description name options?

Properties

action

action: (args: string[], options: TOptions) => void | Promise<void>

Command action handler

`Optional`arguments

arguments?: ArgumentConfig[]

Command arguments

description

description: string

Command description

name

name: string

Command name

`Optional`options

options?: OptionConfig[]

Command options