Home Basic usage Argument long and short names
Post
Cancel

Argument long and short names

The argument long and short names are different than the argument name. The argument name is used as a key when managing the arguments, ex: create argument or get a value of an argument.

Argument long name

The argument long name is usually a single word or a set of words separated by a dash - all in lower case.

Argument without value:

1
2
var myOptionArg = CliArg.New("ForceUpdate")
                    .WithLongName("force-update");

Argument with value:

1
2
var myOtherArg = CliArg.New<bool>("ForceUpdate")
                    .WithLongName("force-update");

Usage from shell:

1
2
3
> myApp --force-update
...
> myOtherApp --force-update true

Argument short name

The argument short name is usually a single character or an abbreviation of multiple words in lower case.

Argument without value:

1
2
var myOptionArg = CliArg.New("ForceUpdate")
                    .WithShortName("f");

Argument with value:

1
2
var myOtherArg = CliArg.New<bool>("ForceUpdate")
                    .WithShortName("f");

Usage from shell

1
2
3
> myApp -f
...
> myOtherApp -f true