vertx-lang-scala-docs_2.12 3.5.3.CR1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package cli
  Definition Classes
    core
- Argument
- CLI
- CommandLine
- Option
-  package datagram
  Definition Classes
    core
-  package dns
  Definition Classes
    core
-  package eventbus
  Definition Classes
    core
-  package file
  Definition Classes
    core
-  package http
  Definition Classes
    core
-  package metrics
  Definition Classes
    core
-  package net
  Definition Classes
    core
-  package parsetools
  Definition Classes
    core
-  package shareddata
  Definition Classes
    core
-  package streams
  Definition Classes
    core

p

io.vertx.scala.core

# cli 

#### package cli

 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

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

2.  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=bar` or `-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 `hidden` attribute to `true`.

   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.

3.  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.

4.  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.

### Value Members

1.  object Argument
2.  object CLI
3.  object CommandLine
4.  object Option

### Ungrouped