CommandLineApplication Class

Namespace
Microsoft.Extensions.CommandLineUtils
Assemblies
  • Microsoft.Extensions.CommandLineUtils

Syntax

public class CommandLineApplication
class Microsoft.Extensions.CommandLineUtils.CommandLineApplication

Constructors

CommandLineApplication(System.Boolean)
public CommandLineApplication(bool throwOnUnexpectedArg = true)

Methods

Argument(System.String, System.String, System.Action<Microsoft.Extensions.CommandLineUtils.CommandArgument>, System.Boolean)
Return type:Microsoft.Extensions.CommandLineUtils.CommandArgument 
public CommandArgument Argument(string name, string description, Action<CommandArgument> configuration, bool multipleValues = false)
Argument(System.String, System.String, System.Boolean)
Return type:Microsoft.Extensions.CommandLineUtils.CommandArgument 
public CommandArgument Argument(string name, string description, bool multipleValues = false)
Command(System.String, System.Action<Microsoft.Extensions.CommandLineUtils.CommandLineApplication>, System.Boolean)
Return type:Microsoft.Extensions.CommandLineUtils.CommandLineApplication 
public CommandLineApplication Command(string name, Action<CommandLineApplication> configuration, bool throwOnUnexpectedArg = true)
Execute(System.String[])
Return type:System.Int32 
public int Execute(params string[] args)
GetFullNameAndVersion()
Return type:System.String 
public string GetFullNameAndVersion()
HelpOption(System.String)
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption HelpOption(string template)
OnExecute(System.Func<System.Int32>)
public void OnExecute(Func<int> invoke)
OnExecute(System.Func<System.Threading.Tasks.Task<System.Int32>>)
public void OnExecute(Func<Task<int>> invoke)
Option(System.String, System.String, Microsoft.Extensions.CommandLineUtils.CommandOptionType)
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption Option(string template, string description, CommandOptionType optionType)
Option(System.String, System.String, Microsoft.Extensions.CommandLineUtils.CommandOptionType, System.Action<Microsoft.Extensions.CommandLineUtils.CommandOption>)
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption Option(string template, string description, CommandOptionType optionType, Action<CommandOption> configuration)
ShowHelp(System.String)
public void ShowHelp(string commandName = null)
ShowHint()
public void ShowHint()
ShowRootCommandFullNameAndVersion()
public void ShowRootCommandFullNameAndVersion()
ShowVersion()
public void ShowVersion()
VersionOption(System.String, System.Func<System.String>, System.Func<System.String>)
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption VersionOption(string template, Func<string> shortFormVersionGetter, Func<string> longFormVersionGetter = null)
VersionOption(System.String, System.String, System.String)
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption VersionOption(string template, string shortFormVersion, string longFormVersion = null)

Fields

Arguments()
Return type:System.Collections.Generic.List<Microsoft.Extensions.CommandLineUtils.CommandArgument> 
public readonly List<CommandArgument> Arguments
Commands()
Return type:System.Collections.Generic.List<Microsoft.Extensions.CommandLineUtils.CommandLineApplication> 
public readonly List<CommandLineApplication> Commands
Options()
Return type:System.Collections.Generic.List<Microsoft.Extensions.CommandLineUtils.CommandOption> 
public readonly List<CommandOption> Options
RemainingArguments()
Return type:System.Collections.Generic.List<System.String> 
public readonly List<string> RemainingArguments

Properties

Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Description
Return type:System.String 
public string Description { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.FullName
Return type:System.String 
public string FullName { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Invoke
Return type:System.Func<System.Int32> 
public Func<int> Invoke { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.IsShowingInformation
Return type:System.Boolean 
public bool IsShowingInformation { get; protected set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.LongVersionGetter
Return type:System.Func<System.String> 
public Func<string> LongVersionGetter { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Name
Return type:System.String 
public string Name { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.OptionHelp
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption OptionHelp { get; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.OptionVersion
Return type:Microsoft.Extensions.CommandLineUtils.CommandOption 
public CommandOption OptionVersion { get; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Parent
Return type:Microsoft.Extensions.CommandLineUtils.CommandLineApplication 
public CommandLineApplication Parent { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.ShortVersionGetter
Return type:System.Func<System.String> 
public Func<string> ShortVersionGetter { get; set; }
Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Syntax
Return type:System.String 
public string Syntax { get; set; }