Function: cli()
ts
function cli<G>(
argv,
entry,
options): Promise<undefined | string>;Run the command.
Type Parameters
| Type Parameter | Default type |
|---|---|
G extends GunshiParams<{ args: Args; extensions: { }; }> | DefaultGunshiParams |
Parameters
| Parameter | Type | Description |
|---|---|---|
argv | string[] | - |
entry | | Command<G> | CommandRunner<G> | LazyCommand<G> | A entry command, an inline command runner, or a lazily-loaded command |
options | CliOptions<G> | A CLI options |
Returns
Promise<undefined | string>
A rendered usage or undefined. if you will use CliOptions.usageSilent option, it will return rendered usage string.