Cli.RunAsync<TDefinition>(String[], CliSettings, CancellationToken) Method

Parses a command line string array and runs the handler asynchronously for the indicated command.

Definition

Namespace: DotMake.CommandLine
Assembly: DotMake.CommandLine (in DotMake.CommandLine.dll) Version: 2.0.0

C#
public static Task<int> RunAsync<TDefinition>(
	string[] args = null,
	CliSettings settings = null,
	CancellationToken cancellationToken = default
)

Parameters

args String[] (Optional): The string array typically passed to a program. This is usually the special variable args available in Program.cs (new style with top-level statements) or the string array passed to the program's Main method (old style). If not specified or null, args will be retrieved automatically from the current process via GetArgs().
settings CliSettings (Optional): The settings for the parser's grammar and behaviors.
cancellationToken CancellationToken (Optional): The token to monitor for cancellation requests.

Type Parameters

TDefinition: The definition class for the command. A command builder for this class should be automatically generated by the source generator.

Return Value

Task<Int32>
The exit code for the invocation.

Example

C#

//In Program.cs, to go async, add this single line:
await Cli.RunAsync<RootCliCommand>(args);

C#
//In Program.cs, to go async, add this single line for returning exit code:
return await Cli.RunAsync<RootCliCommand>(args);