CommandLineBuilder 类

定义

命名空间:

System.CommandLine.Builder

程序集:

System.CommandLine.dll

启用命令行配置的组合。

public ref class CommandLineBuilder

public class CommandLineBuilder

type CommandLineBuilder = class

Public Class CommandLineBuilder

继承

Object

CommandLineBuilder

构造函数

CommandLineBuilder(Command)

启用命令行配置的组合。

属性

Command	生成器使用分析程序根的命令。
EnableDirectives	确定分析程序是否识别命令行指令。
EnableLegacyDoubleDashBehavior	确定在命令行中分析双短划线 (--) 时的行为。
EnablePosixBundling	确定分析程序是否识别并扩展 POSIX 样式的捆绑选项。
ResponseFileHandling	配置分析程序对响应文件的处理。 启用后，将展开以 @ 有效文件路径开头的命令行令牌，就像插入命令行一样。

方法

Build()	基于命令行生成器的配置创建分析程序。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

扩展方法

AddMiddleware(CommandLineBuilder, Action<InvocationContext>, MiddlewareOrder)	在调用命令处理程序之前，将中间件委托添加到调用管道中。
AddMiddleware(CommandLineBuilder, InvocationMiddleware, MiddlewareOrder)	在调用命令处理程序之前，将中间件委托添加到调用管道中。
CancelOnProcessTermination(CommandLineBuilder)	通过 CancellationToken 可在调用期间传递给 ICommandHandler 的 ，启用进程终止的信号和处理。
EnableDirectives(CommandLineBuilder, Boolean)	使分析程序能够识别命令行指令。
EnableLegacyDoubleDashBehavior(CommandLineBuilder, Boolean)	确定在命令行中分析双短划线 (--) 时的行为。
EnablePosixBundling(CommandLineBuilder, Boolean)	使分析程序能够识别和扩展 POSIX 样式的捆绑选项。
ParseResponseFileAs(CommandLineBuilder, ResponseFileHandling)	配置分析程序对响应文件的处理。 启用后，将展开以 @ 有效文件路径开头的命令行令牌，就像插入命令行一样。
RegisterWithDotnetSuggest(CommandLineBuilder)	确保向工具注册应用程序以 dotnet-suggest 启用命令行完成。
UseDefaults(CommandLineBuilder)	使用默认配置。
UseEnvironmentVariableDirective(CommandLineBuilder)	允许使用 [env:key=value] 指令，从而允许在调用期间从命令行设置环境变量。
UseExceptionHandler(CommandLineBuilder, Action<Exception,InvocationContext>, Nullable<Int32>)	使异常处理程序能够捕获调用期间命令处理程序引发的任何未经处理的异常。
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	将应用程序配置为在命令行上使用指定选项别名之一时显示帮助。
UseHelp(CommandLineBuilder, Nullable<Int32>)	将应用程序配置为在命令行上指定以下选项之一时显示帮助： -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	将应用程序配置为在命令行上使用指定选项别名之一时显示帮助。
UseLocalizationResources(CommandLineBuilder, LocalizationResources)	指定在显示帮助、错误消息和其他面向用户的字符串时要使用的本地化资源。
UseParseDirective(CommandLineBuilder, Nullable<Int32>)	启用 指令的使用 [parse] ，当在命令行上指定指令时，该指令将缩短正常的命令处理，并显示一个说明命令行输入分析结果的关系图。
UseParseErrorReporting(CommandLineBuilder, Nullable<Int32>)	配置命令行，以在分析命令行输入时将错误信息写入标准错误。
UseSuggestDirective(CommandLineBuilder)	允许使用 指令， [suggest] 该指令在命令行中指定时，输入短路正常命令处理，并编写适合大多数 shell 用来提供命令行完成的换行符的建议列表。
UseTypoCorrections(CommandLineBuilder, Int32)	将应用程序配置为在检测到分析错误时提供替代建议。
UseVersionOption(CommandLineBuilder)	启用选项 (默认为别名 --version) 在命令行输入中指定时，该选项会使正常的命令处理短路，而是在退出之前写出版本信息。
UseVersionOption(CommandLineBuilder, String[])	启用选项 (默认为别名 --version) 在命令行输入中指定时，该选项会使正常的命令处理短路，而是在退出之前写出版本信息。