This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Shell 3.3.1! |
Label
Option Label has no functional behaviour within a shell itself other than
what a default help
command outputs. Within a command documentation
a type of an option is documented but this is not always super useful. Thus
you may want to give better descriptive word for an option.
Label is not supported with legacy annotation .
|
-
Programmatic
-
Annotation
CommandRegistration labelOption() {
return CommandRegistration.builder()
.withOption()
.longNames("arg")
.label("MYLABEL")
.and()
.build();
}
void labelOption(
@Option(label = "MYLABEL") String arg
) {
}
Defining label is then shown in help
.
my-shell:>help labelOption
NAME
labelOption -
SYNOPSIS
labelOption --arg MYLABEL
OPTIONS
--arg MYLABEL
[Optional]