Class Cli

Hierarchy

Cli

Index

Properties

Accessors

Methods

Properties

Protected _argv

_argv: string[]

Protected _parsedCommands

_parsedCommands: CommandConfig[] = []

Protected _rootCommand

_rootCommand: CommandConfig

Protected _runningCommand

_runningCommand: CommandConfig

config

config: Config

events

events: Dispatcher

Protected globalOptions

globalOptions: OptionConfig[] = []

helpers

helpers: Helpers

log

log: Log

parseCommands

parseCommands: boolean = true

Accessors

argv

get argv(): string[]

- Defined in src/core/Cli.ts:68
Returns string[]

getSubCommands

get getSubCommands(): SubCommandsGetFunction

- Defined in src/core/Cli.ts:56
Returns SubCommandsGetFunction

parseArguments

get parseArguments(): ParseArgumentsFunction

- Defined in src/core/Cli.ts:54
Returns ParseArgumentsFunction

parsedCommands

get parsedCommands(): CommandConfig[]

- Defined in src/core/Cli.ts:36
Returns CommandConfig[]

rootCommand

get rootCommand(): CommandConfig

- Defined in src/core/Cli.ts:34
Returns CommandConfig

runningCommand

get runningCommand(): CommandConfig

- Defined in src/core/Cli.ts:32
Returns CommandConfig

transformOptions

get transformOptions(): TransformOptionsFunction

- Defined in src/core/Cli.ts:52
Returns TransformOptionsFunction

Methods

configure

configure(config: CliConfig): this

- Defined in src/core/Cli.ts:58
Parameters
- config: CliConfig
Returns this

Protected executeCommand

executeCommand(config: CommandConfig): Promise<void>

- Defined in src/core/Cli.ts:136
Parameters
- config: CommandConfig
Returns Promise<void>

fail

fail(msg?: string): void

- Defined in src/core/Cli.ts:233
Parameters
- Optional msg: string
Returns void

global

global(key: string, config: OptionConfig): this
global(config: OptionConfig): this

- Defined in src/core/Cli.ts:240
Parameters
- key: string
- config: OptionConfig
Returns this
- Defined in src/core/Cli.ts:241
Parameters
- config: OptionConfig
Returns this

globals

globals(configs: OptionConfig[] | object): this

- Defined in src/core/Cli.ts:257
Parameters
- configs: OptionConfig[] | object
Returns this

helper

helper(name: string, config?: HelperOptionsConfig): this

- Defined in src/core/Cli.ts:222
Parameters
- name: string
- Optional config: HelperOptionsConfig
Returns this

parse

parse(config: CommandConfig): this

- Defined in src/core/Cli.ts:85
Parameters
- config: CommandConfig
Returns this

start

start(requirePath: string): this

- Defined in src/core/Cli.ts:73
Parameters
- requirePath: string
Returns this

use

use<T>(plugin: Plugin<T>): void

- Defined in src/core/Cli.ts:266
Type parameters
- T: BasePluginConfig
Parameters
- plugin: Plugin<T>
Returns void

useArgv

useArgv(argv: string[]): this

- Defined in src/core/Cli.ts:63
Parameters
- argv: string[]
Returns this

Generated using TypeDoc