function launchMultiCommandCLI
launchMultiCommandCLI(
commands: ReadonlyArray<Command>,
description?: string,
name?: string,
version?: string,
envVarsEnabled?: boolean,
configEnabled?: boolean,
keyValueServiceEnabled?: boolean,
serviceProviders?: ReadonlyArray<ServiceProvider>,
): Promise<RunResult>

Launch a DefaultRuntimeCLI with multiple specified Command instances.

Parameters

commands: ReadonlyArray<Command>

the Command instances to add to the CLI.

optional
description: string

optional description of the CLI.

optional
name: string

optional name of the CLI. If not provided, process.execPath will be used in an attempt to derive the name.

optional
version: string

optional version of the CLI.

optional
envVarsEnabled: boolean = false

optionally support checking env variables for default argument values.

optional
configEnabled: boolean = false

optionally enable configuration file support for default argument values.

optional
keyValueServiceEnabled: boolean = false

optionally provide a KeyValueService implementation: configEnabled must be true in this case

optional
serviceProviders: ReadonlyArray<ServiceProvider>

optional array of ServiceProvider instances to add to the CLI.

Return Type

Promise<RunResult>

Usage

import { launchMultiCommandCLI } from ".";