package cli
- Alphabetic
- Public
- All
Type Members
-
class
Argument extends AnyRef
Defines a command line argument.
Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The first index is 0 (because we are in the computer world).
-
class
CLI extends AnyRef
Interface defining a command-line interface (in other words a command such as 'run', 'ls'...).
Interface defining a command-line interface (in other words a command such as 'run', 'ls'...). This interface is polyglot to ease reuse such as in Vert.x Shell.
A command line interface has a name, and defines a set of options and arguments. Options are key-value pair such as
-foo=baror-flag. The supported formats depend on the used parser. Arguments are unlike options raw values. Options are defined using Option, while argument are defined using Argument.Command line interfaces also define a summary and a description. These attributes are used in the usage generation . To disable the help generation, set the
hiddenattribute totrue.Command Line Interface object does not contains "value", it's a model. It must be evaluated by a parser that returns a io.vertx.scala.core.cli.CommandLine object containing the argument and option values.
-
class
CommandLine extends AnyRef
The parser transforms a CLI (a model) into an io.vertx.scala.core.cli.CommandLine.
The parser transforms a CLI (a model) into an io.vertx.scala.core.cli.CommandLine. This io.vertx.scala.core.cli.CommandLine has stored the argument and option values. Only instance of parser should create objects of this type.
-
class
Option extends AnyRef
Models command line options.
Models command line options. Options are values passed to a command line interface using -x or --x. Supported syntaxes depend on the parser.
Short name is generally used with a single dash, while long name requires a double-dash.