## Uses of Interface
io.vertx.core.cli.CLI

- Packages that use CLI
  Package | Description
  --- | ---
  io.vertx.core.cli |
  io.vertx.core.cli.annotations |
  io.vertx.core.spi.launcher |
  io.vertx.ext.shell.command |
  io.vertx.ext.shell.command.base |
  io.vertx.reactivex.core.cli |
  io.vertx.rxjava.core.cli |
  io.vertx.rxjava3.core.cli |

- - ### Uses of CLI in io.vertx.core.cli

    Methods in io.vertx.core.cli that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | CLI.`addArgument(Argument arg)` Adds an argument.
    `CLI` | CLI.`addArguments(List<Argument> args)` Adds a set of arguments.
    `CLI` | CLI.`addOption(Option option)` Adds an option.
    `CLI` | CLI.`addOptions(List<Option> options)` Adds a set of options.
    `CLI` | CommandLine.`cli()`
    `static CLI` | CLI.`create(Class<?> clazz)` Creates an instance of `CLI` from the given Java class.
    `static CLI` | CLI.`create(String name)` Creates an instance of `CLI` using the default implementation.
    `CLI` | CLI.`removeArgument(int index)` Removes an argument identified by its index.
    `CLI` | CLI.`removeOption(String name)` Removes an option identified by its name.
    `CLI` | CLI.`setArguments(List<Argument> args)` Sets the list of arguments.
    `CLI` | CLI.`setDescription(String desc)`
    `CLI` | CLI.`setHidden(boolean hidden)` Sets whether or not the current instance of `CLI` must be hidden.
    `CLI` | CLI.`setName(String name)` Sets the name of the CLI.
    `CLI` | CLI.`setOptions(List<Option> options)` Sets the list of arguments.
    `CLI` | CLI.`setPriority(int priority)` Sets the priority of the CLI.
    `CLI` | CLI.`setSummary(String summary)` Sets the summary of the CLI.
    `CLI` | CLI.`usage(StringBuilder builder)` Generates the usage / help of the current `CLI`.
    `CLI` | CLI.`usage(StringBuilder builder, String prefix)` Generates the usage / help of the current `CLI`.

    Methods in io.vertx.core.cli with parameters of type CLI
    Modifier and Type | Method and Description
    --- | ---
    `void` | UsageMessageFormatter.`computeUsageLine(StringBuilder buffer, String prefix, CLI cli)`
    `static CommandLine` | CommandLine.`create(CLI cli)` Creates a command line object from the `CLI`.
    `void` | UsageMessageFormatter.`usage(StringBuilder builder, CLI cli)` Computes the usage of the given `CLI`.
    `void` | UsageMessageFormatter.`usage(StringBuilder builder, String prefix, CLI cli)` Computes the usage of the given `CLI`.

    Method parameters in io.vertx.core.cli with type arguments of type CLI
    Modifier and Type | Method and Description
    --- | ---
    `protected StringBuilder` | UsageMessageFormatter.`renderCommands(StringBuilder sb, Collection<CLI> commands)`

  - ### Uses of CLI in io.vertx.core.cli.annotations

    Methods in io.vertx.core.cli.annotations that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `static CLI` | CLIConfigurator.`define(Class<?> clazz)` Creates an instance of the given class, and extracts the metadata from the given class.

  - ### Uses of CLI in io.vertx.core.spi.launcher

    Methods in io.vertx.core.spi.launcher that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | ExecutionContext.`cli()`
    `CLI` | DefaultCommandFactory.`define()`
    `CLI` | CommandFactory.`define()` Creates a new `CLI` instance.

  - ### Uses of CLI in io.vertx.ext.shell.command

    Methods in io.vertx.ext.shell.command that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | AnnotatedCommand.`cli()`
    `default CLI` | Command.`cli()`

    Methods in io.vertx.ext.shell.command with parameters of type CLI
    Modifier and Type | Method and Description
    --- | ---
    `static CommandBuilder` | CommandBuilder.`command(CLI cli)` Create a new commmand with its `CLI` descriptor.

  - ### Uses of CLI in io.vertx.ext.shell.command.base

    Methods in io.vertx.ext.shell.command.base that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | Echo.`cli()`

  - ### Uses of CLI in io.vertx.reactivex.core.cli

    Methods in io.vertx.reactivex.core.cli that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | CLI.`getDelegate()`

    Methods in io.vertx.reactivex.core.cli with parameters of type CLI
    Modifier and Type | Method and Description
    --- | ---
    `static CLI` | CLI.`newInstance(CLI arg)`

    Constructors in io.vertx.reactivex.core.cli with parameters of type CLI
    Constructor and Description
    `CLI(CLI delegate)`

  - ### Uses of CLI in io.vertx.rxjava.core.cli

    Methods in io.vertx.rxjava.core.cli that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | CLI.`getDelegate()`

    Methods in io.vertx.rxjava.core.cli with parameters of type CLI
    Modifier and Type | Method and Description
    --- | ---
    `static CLI` | CLI.`newInstance(CLI arg)`

    Constructors in io.vertx.rxjava.core.cli with parameters of type CLI
    Constructor and Description
    `CLI(CLI delegate)`

  - ### Uses of CLI in io.vertx.rxjava3.core.cli

    Methods in io.vertx.rxjava3.core.cli that return CLI
    Modifier and Type | Method and Description
    --- | ---
    `CLI` | CLI.`getDelegate()`

    Methods in io.vertx.rxjava3.core.cli with parameters of type CLI
    Modifier and Type | Method and Description
    --- | ---
    `static CLI` | CLI.`newInstance(CLI arg)`

    Constructors in io.vertx.rxjava3.core.cli with parameters of type CLI
    Constructor and Description
    `CLI(CLI delegate)`

Copyright © 2025 Eclipse. All rights reserved.