CommandLineBuilderExtensions.RegisterWithDotnetSuggest 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.

Ensures that the application is registered with the dotnet-suggest tool to enable command line completions.

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

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

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

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

Parameters

builder: CommandLineBuilder

A command line builder.

Returns

CommandLineBuilder

The same instance of CommandLineBuilder.

Remarks

For command line completions to work, users must install the dotnet-suggest tool as well as the appropriate shim script for their shell.

Applies to

Share via