Vert.x Core provides an API for parsing command line arguments passed to programs. It’s also able to print help
messages detailing the options available for a command line tool. Even if such features are far from
the Vert.x core topics, this API is used in the Launcher
class that you can use in fat-jar
and in the vertx
command line tools. In addition, it’s polyglot (can be used from any supported language) and is
used in Vert.x Shell.
Vert.x CLI provides a model to describe your command line interface, but also a parser. This parser supports different types of syntax:
-
POSIX like options (ie.
tar -zxvf foo.tar.gz
) -
GNU like long options (ie.
du --human-readable --max-depth=1
) -
Java like properties (ie.
java -Djava.awt.headless=true -Djava.net.useSystemProxies=true Foo
) -
Short options with value attached (ie.
gcc -O2 foo.c
) -
Long options with single hyphen (ie.
ant -projecthelp
)
Using the CLI api is a 3-steps process:
-
The definition of the command line interface
-
The parsing of the user command line
-
The query / interrogation
Definition Stage
Each command line interface must define the set of options and arguments that will be used. It also requires a
name. The CLI API uses the Option
and Argument
classes to
describe options and arguments:
var cli = CLI.create("copy").setSummary("A command line interface to copy files.").addOption(Option(
longName = "directory",
shortName = "R",
description = "enables directory support",
flag = true)).addArgument(Argument(
index = 0,
description = "The source",
argName = "source")).addArgument(Argument(
index = 1,
description = "The destination",
argName = "target"))
As you can see, you can create a new CLI
using
CLI.create
. The passed string is the name of the CLI. Once created you
can set the summary and description. The summary is intended to be short (one line), while the description can
contain more details. Each option and argument are also added on the CLI
object using the
addArgument
and
addOption
methods.
Options
An Option
is a command line parameter identified by a key present in the user command
line. Options must have at least a long name or a short name. Long name are generally used using a --
prefix,
while short names are used with a single -
. Names are case-sensitive; however, case-insensitive name matching
will be used during the Query / Interrogation Stage if no exact match is found.
Options can get a description displayed in the usage (see below). Options can receive 0, 1 or several values. An
option receiving 0 values is a flag
, and must be declared using
setFlag
. By default, options receive a single value, however, you can
configure the option to receive several values using setMultiValued
:
var cli = CLI.create("some-name").setSummary("A command line interface illustrating the options valuation.").addOption(Option(
longName = "flag",
shortName = "f",
flag = true,
description = "a flag")).addOption(Option(
longName = "single",
shortName = "s",
description = "a single-valued option")).addOption(Option(
longName = "multiple",
shortName = "m",
multiValued = true,
description = "a multi-valued option"))
Options can be marked as mandatory. A mandatory option not set in the user command line throws an exception during the parsing:
var cli = CLI.create("some-name").addOption(Option(
longName = "mandatory",
required = true,
description = "a mandatory option"))
Non-mandatory options can have a default value. This value would be used if the user does not set the option in the command line:
var cli = CLI.create("some-name").addOption(Option(
longName = "optional",
defaultValue = "hello",
description = "an optional option with a default value"))
An option can be hidden using the setHidden
method. Hidden option are
not listed in the usage, but can still be used in the user command line (for power-users).
If the option value is contrained to a fixed set, you can set the different acceptable choices:
var cli = CLI.create("some-name").addOption(Option(
longName = "color",
defaultValue = "green",
choices = listOf("blue", "red", "green"),
description = "a color"))
Options can also be instantiated from their JSON form.
Arguments
Unlike options, arguments do not have a key and are identified by their index. For example, in
java com.acme.Foo
, com.acme.Foo
is an argument.
Arguments do not have a name, there are identified using a 0-based index. The first parameter has the
index 0
:
var cli = CLI.create("some-name").addArgument(Argument(
index = 0,
description = "the first argument",
argName = "arg1")).addArgument(Argument(
index = 1,
description = "the second argument",
argName = "arg2"))
If you don’t set the argument indexes, it computes it automatically by using the declaration order.
var cli = CLI.create("some-name").addArgument(Argument(
description = "the first argument",
argName = "arg1")).addArgument(Argument(
description = "the second argument",
argName = "arg2"))
The argName
is optional and used in the usage message.
As options, Argument
can:
-
be hidden using
setHidden
-
be mandatory using
setRequired
-
have a default value using
setDefaultValue
-
receive several values using
setMultiValued
- only the last argument can be multi-valued.
Arguments can also be instantiated from their JSON form.
Usage generation
Once your CLI
instance is configured, you can generate the usage message:
var cli = CLI.create("copy").setSummary("A command line interface to copy files.").addOption(Option(
longName = "directory",
shortName = "R",
description = "enables directory support",
flag = true)).addArgument(Argument(
index = 0,
description = "The source",
argName = "source")).addArgument(Argument(
index = 0,
description = "The destination",
argName = "target"))
var builder = java.lang.StringBuilder()
cli.usage(builder)
It generates an usage message like this one:
Usage: copy [-R] source target
A command line interface to copy files.
-R,--directory enables directory support
If you need to tune the usage message, check the UsageMessageFormatter
class.
Parsing Stage
Once your CLI
instance is configured, you can parse the user command line to evaluate
each option and argument:
var commandLine = cli.parse(userCommandLineArguments)
The parse
method returns a CommandLine
object containing the values. By default, it validates the user command line and checks that each mandatory options
and arguments have been set as well as the number of values received by each option. You can disable the
validation by passing false
as second parameter of parse
.
This is useful if you want to check an argument or option is present even if the parsed command line is invalid.
You can check whether or not the
CommandLine
is valid using isValid
.
Query / Interrogation Stage
Once parsed, you can retrieve the values of the options and arguments from the
CommandLine
object returned by the parse
method:
var commandLine = cli.parse(userCommandLineArguments)
var opt = commandLine.getOptionValue<Any>("my-option")
var flag = commandLine.isFlagEnabled("my-flag")
var arg0 = commandLine.getArgumentValue<Any>(0)
One of your options can be marked as "help". If a user command line enabled a "help" option, the validation won’t fail, but you have the opportunity to check if the user asks for help:
var cli = CLI.create("test").addOption(Option(
longName = "help",
shortName = "h",
flag = true,
help = true)).addOption(Option(
longName = "mandatory",
required = true))
var line = cli.parse(java.util.Collections.singletonList("-h"))
// The parsing does not fail and let you do:
if (!line.isValid() && line.isAskingForHelp()) {
var builder = java.lang.StringBuilder()
cli.usage(builder)
stream.print(builder.toString())
}