CommandLineBuilderExtensions 类

定义

命名空间:

System.CommandLine.Builder

程序集:

System.CommandLine.dll

为 CommandLineBuilder 提供扩展方法。

public ref class CommandLineBuilderExtensions abstract sealed

public static class CommandLineBuilderExtensions

type CommandLineBuilderExtensions = class

Public Module CommandLineBuilderExtensions

继承

Object

CommandLineBuilderExtensions

方法

AddMiddleware(CommandLineBuilder, Action<InvocationContext>, MiddlewareOrder)	在调用命令处理程序之前，将中间件委托添加到调用的调用管道。
AddMiddleware(CommandLineBuilder, InvocationMiddleware, MiddlewareOrder)	在调用命令处理程序之前，将中间件委托添加到调用的调用管道。
CancelOnProcessTermination(CommandLineBuilder)	通过 可在调用期间传递给 ICommandHandler 的 启用进程终止CancellationToken的信号和处理。
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[])	将应用程序配置为在命令行上使用指定选项别名之一时显示帮助。
UseHelpBuilder<TBuilder>(TBuilder, Func<BindingContext,HelpBuilder>)	指定在 HelpBuilder 请求帮助时用于设置帮助输出格式的 。
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) 当在命令行输入中指定时，该选项将使正常的命令处理短路，而是在退出之前写出版本信息。