Cli Subcommand¶

1

import "std/io/cli-subcommand";

CliSubcommand struct¶

A subcommand of a CLI parser. It groups options, flags and nested subcommands under a name and is responsible for parsing the slice of arguments that belongs to it. The root of a CliParser is itself a CliSubcommand.

Constructors¶

ctor¶

1

public p CliSubcommand.ctor(CliSubcommand* parent, const String& versionString, const String& name, const String& description = String(""))

Construct a subcommand

Parameters

Methods¶

parse¶

1

public f<int> CliSubcommand.parse(unsigned int argc, string[] argv, int layer = 1)

Parse the arguments belonging to this subcommand, dispatching to nested subcommands as needed

Parameters

Returns: int — Exit code of the parse run

getName¶

1

public const f<const String&> CliSubcommand.getName()

Retrieve the name of the subcommand

Returns: const String& — Name of the subcommand

getDescription¶

1

public const f<const String&> CliSubcommand.getDescription()

Retrieve the description of the subcommand

Returns: const String& — Description of the subcommand

setVersion¶

1

public p CliSubcommand.setVersion(const String& versionString)

Set the version string reported by the subcommand

Parameters

setFooter¶

1

public p CliSubcommand.setFooter(const String& footerString)

Set the footer text shown at the bottom of the subcommand's help output

Parameters

setCallback¶

1

public p CliSubcommand.setCallback(p() callback)

Set the callback invoked when this subcommand is selected without a nested subcommand

Parameters

allowUnknownOptions¶

1

public p CliSubcommand.allowUnknownOptions()

Allow unknown options on this subcommand and all of its nested subcommands

addAlias¶

1

public p CliSubcommand.addAlias(string subCommand)

Add an alternative name (alias) for the subcommand

Parameters

addAlias¶

1

public p CliSubcommand.addAlias(const String& subCommand)

Add an alternative name (alias) for the subcommand

Parameters

addSubcommand¶

1

public f<CliSubcommand&> CliSubcommand.addSubcommand(string name, string description)

Register a nested subcommand

Parameters

Returns: CliSubcommand& — Reference to the newly created subcommand

addSubcommand¶

1

public f<CliSubcommand&> CliSubcommand.addSubcommand(const String& name, const String& description)

Register a nested subcommand

Parameters

Returns: CliSubcommand& — Reference to the newly created subcommand

addOption¶

1

public f<CliOption<string>&> CliSubcommand.addOption<StrOrConstStrObjRef, TargetVarOrCallbackString>(StrOrConstStrObjRef name, TargetVarOrCallbackString output, StrOrConstStrObjRef description)

Register a string option on the subcommand. If the name does not start with a dash, the option is treated as a positional argument.

Parameters

Returns: CliOption<string>& — Reference to the newly created option

addOption¶

1

public f<CliOption<String>&> CliSubcommand.addOption<StrOrConstStrObjRef, TargetVarOrCallbackStringObj>(StrOrConstStrObjRef name, TargetVarOrCallbackStringObj output, StrOrConstStrObjRef description)

Register a String option on the subcommand. If the name does not start with a dash, the option is treated as a positional argument.

Parameters

Returns: CliOption<String>& — Reference to the newly created option

addOption¶

1

public f<CliOption<int>&> CliSubcommand.addOption<StrOrConstStrObjRef, TargetVarOrCallbackInt>(StrOrConstStrObjRef name, TargetVarOrCallbackInt output, StrOrConstStrObjRef description)

Register an int option on the subcommand. If the name does not start with a dash, the option is treated as a positional argument.

Parameters

Returns: CliOption<int>& — Reference to the newly created option

addOption¶

1

public f<CliOption<FilePath>&> CliSubcommand.addOption<StrOrConstStrObjRef, TargetVarOrCallbackFilePath>(StrOrConstStrObjRef name, TargetVarOrCallbackFilePath output, StrOrConstStrObjRef description)

Register a FilePath option on the subcommand. If the name does not start with a dash, the option is treated as a positional argument.

Parameters

Returns: CliOption<FilePath>& — Reference to the newly created option

addFlag¶

1

public f<CliOption<bool>&> CliSubcommand.addFlag<StrOrConstStrObjRef, TargetVarOrCallbackBool>(StrOrConstStrObjRef name, TargetVarOrCallbackBool output, StrOrConstStrObjRef description)

Register a boolean flag on the subcommand

Parameters

Returns: CliOption<bool>& — Reference to the newly created flag

printHelpItem¶

1

public p CliSubcommand.printHelpItem()

Print the subcommand's name, aliases and description as a single help entry