API Documentation
Back to top  

Classes, interfaces and traits

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).

« More »

CLI

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=bar or -flag. The supported formats depend on the used parser. Arguments are unlike options raw values. Options are defined using

« More »

CommandLine

The parser transforms a CLI (a model) into an @see \io\vertx\jphp\core\cli\CommandLine. This @see \io\vertx\jphp\core\cli\CommandLine has stored the argument and option values. Only instance of parser should create objects of this type.

« More »

Option

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.

« More »