Uses of Package
picocli
Packages that use picocli
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion functionality.Provides classes and interfaces that form a framework for creating picocli annotation processors.
Provides tools for generating GraalVM configuration files from a picocli CommandSpec model.
Provides tools for generating man-page documentation in AsciiDoc format from a picocli CommandSpec model.
Provides utility classes for internal use in the picocli-codegen module.
Provides classes and interfaces for integrating picocli with JLine 2.
-
ClassDescriptionCommandLine interpreter that uses reflection to initialize an annotated user object with values obtained from the command line arguments.Deprecated.A
Commandmay define one or moreArgGroups: a group of options, positional parameters or a mixture of the two.Annotate your class with@Commandwhen you want more control over the format of the generated help message.Exception indicating that multiple named elements have incorrectly used the same name.Exception indicating a problem while invoking a command or subcommand.A collection of methods and inner classes that provide fine-grained control over the contents and layout of the usage help message to display to end users when help is requested or invalid input values were specified.Provides methods and inner classes to support using ANSI escape codes in usage help messages.Defines the interface for an ANSI escape sequence.A set of pre-defined ANSI escape code styles and colors, and a set of convenience methods for parsing text with embedded markup style names, as well as convenience methods for converting styles to strings with embedded escape codes.Encapsulates rich text with styles and colors.All usage help message are generated with a color scheme that assigns certain styles and colors to common parts of a usage message: the command name, options, positional parameters and option parameters.Builder class to createColorSchemeinstances.Policy for handling text that is longer than the column width: span multiple columns, wrap to the next row, or simply truncate the portion that doesn't fit.When customizing online help forOptiondetails, a customIOptionRenderercan be used to create textual representation of an Option in a tabular format: one or more rows, each containing one or more columns.When customizing online help for positional parameters details, a customIParameterRenderercan be used to create textual representation of a Parameters field in a tabular format: one or more rows, each containing one or more columns.When customizing online usage help for an option parameter or a positional parameter, a customIParamLabelRenderercan be used to render the parameter name or label to a String.Use a Layout to format usage help text for options and parameters in tabular format.Responsible for spacing outCommandLine.Help.Ansi.Textvalues according to theCommandLine.Help.Columndefinitions the table was created with.Helper class to index positions in aHelp.TextTable.Controls the visibility of certain aspects of the usage help message.Provides default value for a command.Classes implementing this interface know how to handle Exceptions that occurred while executing theRunnable,CallableorMethoduser object of the command.Implementations are responsible for "executing" the user input and returning an exit code.Interface that provides the appropriate exit code that will be returned from theexecutemethod for an exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method.@Command-annotated classes can implement this interface to specify an exit code that will be returned from theexecutemethod when the command is successfully invoked.Factory for instantiating classes that are registered declaratively with annotation attributes, likeCommandLine.Command.subcommands(),CommandLine.Option.converter(),CommandLine.Parameters.converter()andCommandLine.Command.versionProvider().Deprecated.useCommandLine.IHelpCommandInitializable2insteadHelp commands that provide usage help for other commands can implement this interface to be initialized with the information they need.Creates theCommandLine.Helpinstance used to render the usage help message.Renders a section of the usage help message.Provides a way to modify how the command model is built.Determines the option name transformation of negatable boolean options.Exception indicating a problem duringCommandLineinitialization.Options or positional parameters can be assigned aIParameterConsumerthat implements custom logic to process the parameters for this option or this position.Classes implementing this interface know how to handleParameterExceptions(usually from invalid user input).Options, positional parameters and commands can be assigned aIParameterPreprocessorthat implements custom logic to preprocess the parameters for this option, position or command.Deprecated.UseCommandLine.IExecutionStrategyinstead.Deprecated.useCommandLine.IExecutionStrategyinstead, seeCommandLine.execute(String...)When parsing command line arguments and initializing fields annotated with@Optionor@Parameters, String values can be converted to any type for which aITypeConverteris registered.Provides version information for a command.TheArgGroupSpecclass models agroupof arguments (options, positional parameters or a mixture of the two).Builder responsible for creating validArgGroupSpecobjects.Models the shared attributes ofCommandLine.Model.OptionSpecandCommandLine.Model.PositionalParamSpec.TheCommandSpecclass models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command.Internal interface to allow annotation processors to construct a command model at compile time.Customizable getter for obtaining the current value of an option or positional parameter.The scope of a getter/setter binding is the context where the current value should be gotten from or set to.Customizable setter for modifying the value of an option or positional parameter.Encapculates type information for an option or parameter to make this information available both at runtime and at compile time (whenClassvalues are not available).Utility class for getting resource bundle strings.TheOptionSpecclass models aspects of a named option of a command, including whether it is required or optional, the option parameters supported (or required) by the option, and attributes for the usage help message describing the option.Builder responsible for creating validOptionSpecobjects.Models parser configuration specification.ThePositionalParamSpecclass models aspects of a positional parameter of a command, including whether it is required or optional, and attributes for the usage help message describing the positional parameter.Builder responsible for creating validPositionalParamSpecobjects.This class allows applications to specify a custom binding that will be invoked for unmatched arguments.Models the usage help message specification and can be used to customize the usage help message.Exception indicating something went wrong while parsing command line options.Encapsulates the result of parsing an array of command line arguments.Builds immutableParseResultinstances.A group's multiplicity specifies how many matches of a group may appear on the command line.Provides information about anCommandLine.ArgGroupthat was matched on the command line.Base class of all exceptions thrown bypicocli.CommandLine.Describes the number of parameters required and accepted by an option or a positional parameter.A regular expression-based option name transformation for negatable options.Builder for creatingRegexTransformerobjects.Command line execution strategy that prints help if requested, and otherwise executes the top-level command and all subcommands asRunnable,CallableorMethod.Command line execution strategy that prints help if requested, and otherwise executes the top-levelRunnableorCallablecommand.Command line execution strategy that prints help if requested, and otherwise executes the most specificRunnableorCallablesubcommand.Specifies the scope of the element.Identifies what kind ofCommandSpecshould be injected.Enumerates over the trace level values for filtering which internal debug statements should be printed.Utility class for printing internal debug statements. -
Classes in picocli used by picocli.codegen.annotation.processingClassDescriptionThe
CommandSpecclass models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command.Customizable getter for obtaining the current value of an option or positional parameter.Customizable setter for modifying the value of an option or positional parameter. -
Classes in picocli used by picocli.codegen.aot.graalvmClassDescriptionThe
CommandSpecclass models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command. -
Classes in picocli used by picocli.codegen.docgen.manpageClassDescriptionAnnotate your class with
@Commandwhen you want more control over the format of the generated help message.TheCommandSpecclass models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command. -
Classes in picocli used by picocli.codegen.utilClassDescriptionThe
CommandSpecclass models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command. -
Classes in picocli used by picocli.shell.jline2ClassDescriptionThe
CommandSpecclass models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command.
CommandLine.execute(String...)