Function: cli()

Run the command.

Call Signature

export async function cli<G extends GunshiParamsConstraint>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>

Run the command.

Type Parameters

Name	Description
G extends GunshiParamsConstraint	A type extending GunshiParams to specify the shape of command and cli options.

Parameters

Name	Type	Description
args	string[]	Command line arguments
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 (optional)

Returns

Promise<string | undefined> — A rendered usage or undefined. if you will use CliOptions.usageSilent option, it will return rendered usage string.

Call Signature

export async function cli<
  A extends Args = Args,
  G extends GunshiParams = { args: A; extensions: {} }
>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>

Run the command.

Type Parameters

Name	Description
A extends Args = Args	The type of arguments defined in the command and cli options.
G extends GunshiParams = { args: A; extensions:	-

Parameters

Name	Type	Description
args	string[]	Command line arguments
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 (optional)

Returns

Promise<string | undefined> — A rendered usage or undefined. if you will use CliOptions.usageSilent option, it will return rendered usage string.

Call Signature

export async function cli<
  E extends ExtendContext = ExtendContext,
  G extends GunshiParams = { args: Args; extensions: E }
>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>

Run the command.

Type Parameters

Name	Description
E extends ExtendContext = ExtendContext	An ExtendContext type to specify the shape of command and cli options.
G extends GunshiParams = { args: Args; extensions: E }	-

Parameters

Name	Type	Description
args	string[]	Command line arguments
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 (optional)

Returns

Promise<string | undefined> — A rendered usage or undefined. if you will use CliOptions.usageSilent option, it will return rendered usage string.

Call Signature

export async function cli<G extends GunshiParams = DefaultGunshiParams>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>

Run the command.

Type Parameters

Name	Description
G extends GunshiParams = DefaultGunshiParams	A type extending GunshiParams to specify the shape of command and cli options.

Parameters

Name	Type	Description
args	string[]	Command line arguments
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 (optional)

Returns

Promise<string | undefined> — A rendered usage or undefined. if you will use CliOptions.usageSilent option, it will return rendered usage string.

Call Signature

export async function cli(args: string[], entry: SubCommandable, options?: CliOptions): Promise<string | undefined>

Run the command.

This overload accepts any command-like object using a loose structural type. It bypasses TypeScript contravariance issues with callback properties.

Note: This overload MUST be last in the overload list. TypeScript checks overloads in declaration order and selects the first matching one. The SubCommandable type is intentionally loose and would match any command, so placing it first would prevent proper type inference for more specific command types.

Parameters

Name	Type	Description
args	string[]	Command line arguments
entry	SubCommandable	A command-like object (command, command runner, or lazy command)
options	CliOptions	A CLI options (optional)

Returns

Promise<string | undefined> — A rendered usage or undefined. if you will use CliOptions.usageSilent option, it will return rendered usage string.