Function: cli()
ts
function cli<Options>(
args,
entry,
opts): Promise<undefined | string>;
Run the command.
Type Parameters
Type Parameter | Default type |
---|---|
Options extends ArgOptions | ArgOptions |
Parameters
Parameter | Type | Description |
---|---|---|
args | string [] | Command line arguments |
entry | | Command <Options > | CommandRunner <Options > | A entry command or an inline command runner |
opts | CommandOptions <Options > | A command options |
Returns
Promise
<undefined
| string
>
A rendered usage or undefined. if you will use CommandOptions.usageSilent option, it will return rendered usage string.