CommandLineBuilderExtensions.UseSuggestDirective(CommandLineBuilder) Method

Reference

Definition

Namespace:: System.CommandLine.Builder

Assembly:: System.CommandLine.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enables the use of the [suggest] directive which when specified in command line input short circuits normal command handling and writes a newline-delimited list of suggestions suitable for use by most shells to provide command line completions.

public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Builder::CommandLineBuilder ^ UseSuggestDirective(System::CommandLine::Builder::CommandLineBuilder ^ builder);

public static System.CommandLine.Builder.CommandLineBuilder UseSuggestDirective (this System.CommandLine.Builder.CommandLineBuilder builder);

static member UseSuggestDirective : System.CommandLine.Builder.CommandLineBuilder -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseSuggestDirective (builder As CommandLineBuilder) As CommandLineBuilder

Parameters

builder: CommandLineBuilder

A command line builder.

Returns

CommandLineBuilder

The same instance of CommandLineBuilder.

Remarks

The dotnet-suggest tool requires the suggest directive to be enabled for an application to provide completions.

Applies to

Share via