Class TigerCliCommandAliasBuilder

Namespace

ItTiger.TigerCli.Commands

Assembly

ItTiger.TigerCli.dll

Configures a command alias registered via AddCommandAlias(string, string, Action<TigerCliCommandAliasBuilder>?). An alias is an alternate entry point into the existing command tree: it owns no handler, settings, or providers, and the target command owns parsing, prompting, validation, and execution. The alias may own only its help/menu presentation.

public sealed class TigerCliCommandAliasBuilder

Inheritance

object

TigerCliCommandAliasBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

At resolution time real commands win over aliases; a matched alias resolves to its target command, so parsing, prompting, providers, validation, prompt-mode inheritance, and execution all run on the target unchanged. <app> <alias> --help shows the alias name and description plus an Alias for: <target> note, while the arguments and options come from the target command's settings. Aliases are root-level single-token names mapping to an existing command path; multi-token alias paths are not supported.

Methods

CommandMenu(CommandMenuMode)

Sets the alias's command-menu opinion. The alias has its own eligibility chain (app level → alias) and does not inherit the target's menu eligibility, so a target hidden from the menu can still be reached through a visible alias.

public TigerCliCommandAliasBuilder CommandMenu(CommandMenuMode mode)

Parameters

mode CommandMenuMode

Returns

TigerCliCommandAliasBuilder

HideFromHelp()

Hides the alias from generated help. The alias still resolves on the command line and may still appear in the command menu (controlled separately via CommandMenu(CommandMenuMode)).

public TigerCliCommandAliasBuilder HideFromHelp()

Returns

TigerCliCommandAliasBuilder

SetDescription(string, string?)

Sets the alias's own description, shown in the help "Aliases" section and the alias's command help. When omitted, the alias falls back to the target command's description. The description may contain TigerCli markup.

public TigerCliCommandAliasBuilder SetDescription(string description, string? resourceKey = null)

Parameters

description string

Fallback description used when no resource key is provided or when the key fails to resolve.

resourceKey string

Optional resource key resolved through the app ResourceManager registered via UseAppResources against the active run culture. Missing keys silently fall back to description.

Returns

TigerCliCommandAliasBuilder