Package com.codename1.cli

package com.codename1.cli

Command-line applications: picocli-style annotations that the build turns into a parser, with help, version, subcommands and exit codes.

A class annotated CommandLine.Command is a command; its fields annotated CommandLine.Option and CommandLine.Parameters receive the arguments. The build reads the annotations, generates the code that binds them and writes main, so a command-line tool is a module with commands and nothing else, and it compiles to a native executable for Linux, macOS and Windows like any backend.

The same commands work in a backend with controllers. There the server is the serve subcommand, and the command line with no arguments starts it as before, so maintenance tasks such as a migration or an administrator account ship in the server's own binary.

Class	Description
Ansi	Styled terminal text, built fluently:
Ansi.Color	A foreground or background color: one of the 16 basic colors, an index into the 256-color palette, or a 24-bit RGB value.
ArgSpec	What an option and a positional parameter have in common.
CommandBinding	The code the build generates for one @Command class, through which the parser creates the command, sets its fields and runs it without reflection.
CommandLine	Parses a command line into an annotated command and runs it.
CommandLine.Command	Marks a command class.
CommandLine.IExitCodeGenerator	Implemented by a Runnable command that has an exit code to report.
CommandLine.ITypeConverter<K>	Converts the text of an argument to a type the build does not know.
CommandLine.Option	Marks a field that receives an option.
CommandLine.ParameterException	A command line that does not parse.
CommandLine.Parameters	Marks a field that receives positional parameters.
CommandLine.ParentCommand	Marks a field of a subcommand that receives its enclosing command.
CommandLine.Server	Starts the server of a backend that also has commands.
CommandLine.Spec	Marks a CommandSpec field that receives the command's own model.
CommandSpec	The model of one command: its name, help text, options, positional parameters and subcommands.
Console	What a command needs to know about the terminal it writes to, and the entry point of the console API.
Console.ColorLevel	How many colors the terminal shows, the level Ansi converts colors down to.
Console.Style	The styles Console.style(String, Console.Style...) can apply.
Key	One key press read from a terminal in raw mode, decoded from the bytes and escape sequences terminals send.
Key.Type	What was pressed.
LiveRegion	The last few lines of the terminal, redrawn in place: what progress bars, spinners and prompts are drawn on.
MultiProgress	Several progress bars drawn together, one line each, for work that runs in parallel:
OptionSpec	The model of one option, written by the build from an CommandLine.Option.
PositionalParamSpec	The model of one positional parameter, written by the build from a CommandLine.Parameters.
ProgressBar	A progress bar with a percentage, a count, a rate and the time left:
Prompt	Questions a command asks the person running it:
Prompt.Cancelled	Thrown when the person cancels a question.
Prompt.Labeler<T>	Turns a choice into the label a selection list shows.
Prompt.MultiSelect<T>	A multiple-choice list with options: labels, preselected choices, limits.
Prompt.Select<T>	A single-choice list with options: labels, a default, page size, filtering.
Prompt.Text	A text question with options: a default, a validator, masking.
Prompt.Validator	Checks an answer before a text prompt accepts it.
Spinner	An animated indicator for work of unknown length, ending in a status line:
Spinner.Frames	The animation frames.
Table	Rows and columns rendered as text, aligned by the columns each cell takes on a terminal, so styled cells, wide characters and emoji line up:
Table.Align	How a column's cells line up.
Table.Border	The lines drawn around and between cells.
Tree	A hierarchy rendered the way tree prints a directory: