Skip to content

ShellCompletionOptions

Shell completion setup options.

public sealed class ShellCompletionOptions

Gets or sets an optional custom bash profile path.

public string? BashProfilePath { get; set; }

string

Gets or sets a value indicating whether shell completion management is enabled.

public bool Enabled { get; set; }

bool

Gets or sets an optional custom fish profile path.

public string? FishProfilePath { get; set; }

string

Gets or sets an optional custom nushell profile path.

public string? NuProfilePath { get; set; }

string

Gets or sets an optional custom PowerShell profile path.

public string? PowerShellProfilePath { get; set; }

string

Gets or sets an optional preferred shell override. When set, runtime detection is bypassed.

public ShellKind? PreferredShell { get; set; }

ShellKind?

Gets or sets a value indicating whether setup prompt should appear only once.

public bool PromptOnce { get; set; }

bool

Gets or sets shell completion setup mode.

public ShellCompletionSetupMode SetupMode { get; set; }

ShellCompletionSetupMode

Gets or sets an optional custom state file path. When null, platform defaults are used.

public string? StateFilePath { get; set; }

string

Gets or sets an optional custom zsh profile path.

public string? ZshProfilePath { get; set; }

string