Every main method deserves picocli!
The user manual for the latest release is at https://picocli.info. For the busy and impatient: there is also a Quick Guide.
1. Introduction
Picocli aims to be the easiest way to create rich command line applications that can run on and off the JVM. Considering picocli? Check what happy users say about picocli.
1.1. Overview
Picocli is a one-file framework for creating Java command line applications with almost zero code. It supports a variety of command line syntax styles including POSIX, GNU, MS-DOS and more. It generates highly customizable usage help messages that use ANSI colors and styles to contrast important elements and reduce the cognitive load on the user.
Picocli-based applications can have command line TAB completion showing available options, option parameters and subcommands, for any level of nested subcommands.
Picocli-based applications can be ahead-of-time compiled to a 
native image, with extremely fast startup time and lower memory requirements, which can be distributed as a single executable file.
Picocli generates beautiful documentation for your application (HTML, PDF and Unix man pages).
Another distinguishing feature of picocli is how it aims to let users run picocli-based applications without requiring picocli as an external dependency: all the source code lives in a single file, to encourage application authors to include it in source form.
Picocli makes it easy to follow Command Line Interface Guidelines.
How it works: annotate your class and picocli initializes it from the command line arguments, converting the input to strongly typed values in the fields of your class.
| Picocli also provides a programmatic API, separately from the annotations API. |
1.2. Example application
The example below shows a short but fully functional picocli-based checksum command line application.
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
import picocli.CommandLine.Parameters;
import java.io.File;
import java.math.BigInteger;
import java.nio.file.Files;
import java.security.MessageDigest;
import java.util.concurrent.Callable;
@Command(name = "checksum", mixinStandardHelpOptions = true, version = "checksum 4.0",
description = "Prints the checksum (SHA-256 by default) of a file to STDOUT.")
class CheckSum implements Callable<Integer> {
@Parameters(index = "0", description = "The file whose checksum to calculate.")
private File file;
@Option(names = {"-a", "--algorithm"}, description = "MD5, SHA-1, SHA-256, ...")
private String algorithm = "SHA-256";
@Override
public Integer call() throws Exception { // your business logic goes here...
byte[] fileContents = Files.readAllBytes(file.toPath());
byte[] digest = MessageDigest.getInstance(algorithm).digest(fileContents);
System.out.printf("%0" + (digest.length*2) + "x%n", new BigInteger(1, digest));
return 0;
}
// this example implements Callable, so parsing, error handling and handling user
// requests for usage help or version help can be done with one line of code.
public static void main(String... args) {
int exitCode = new CommandLine(new CheckSum()).execute(args);
System.exit(exitCode);
}
}@Grab('info.picocli:picocli-groovy:4.7.6')
import picocli.CommandLine
import static picocli.CommandLine.*
import java.security.MessageDigest
import java.util.concurrent.Callable
@Command(name = 'checksum', mixinStandardHelpOptions = true, version = 'checksum 4.0',
description = 'Prints the checksum (SHA-256 by default) of a file to STDOUT.')
class Checksum implements Callable<Integer> {
@Parameters(index = '0', description = 'The file whose checksum to calculate.')
File file
@Option(names = ['-a', '--algorithm'], description = 'MD5, SHA-1, SHA-256, ...')
String algorithm = 'SHA-256'
Integer call() throws Exception {
println MessageDigest.getInstance(algorithm).digest(file.bytes).encodeHex().toString()
0
}
static void main(String[] args) {
System.exit(new CommandLine(new Checksum()).execute(args))
}
}@Grab('info.picocli:picocli-groovy:4.7.6')
import static picocli.CommandLine.*
import groovy.transform.Field
import java.security.MessageDigest
@Command(name = 'checksum', mixinStandardHelpOptions = true, version = 'checksum 4.0',
description = 'Prints the checksum (SHA-256 by default) of a file to STDOUT.')
@picocli.groovy.PicocliScript
@Parameters(index = '0', description = 'The file whose checksum to calculate.')
@Field File file
@Option(names = ['-a', '--algorithm'], description = 'MD5, SHA-1, SHA-256, ...')
@Field String algorithm = 'SHA-256'
println MessageDigest.getInstance(algorithm).digest(file.bytes).encodeHex().toString()import picocli.CommandLine
import picocli.CommandLine.Command
import picocli.CommandLine.Option
import picocli.CommandLine.Parameters
import java.io.File
import java.math.BigInteger
import java.nio.file.Files
import java.security.MessageDigest
import java.util.concurrent.Callable
import kotlin.system.exitProcess
@Command(name = "checksum", mixinStandardHelpOptions = true, version = ["checksum 4.0"],
description = ["Prints the checksum (SHA-256 by default) of a file to STDOUT."])
class Checksum : Callable<Int> {
@Parameters(index = "0", description = ["The file whose checksum to calculate."])
lateinit var file: File
@Option(names = ["-a", "--algorithm"], description = ["MD5, SHA-1, SHA-256, ..."])
var algorithm = "SHA-256"
override fun call(): Int {
val fileContents = Files.readAllBytes(file.toPath())
val digest = MessageDigest.getInstance(algorithm).digest(fileContents)
println(("%0" + digest.size * 2 + "x").format(BigInteger(1, digest)))
return 0
}
}
fun main(args: Array<String>) : Unit = exitProcess(CommandLine(Checksum()).execute(*args))import picocli.CommandLine
import picocli.CommandLine.{Command, Option, Parameters}
import java.io.File
import java.math.BigInteger
import java.nio.file.Files
import java.security.MessageDigest
import java.util.concurrent.Callable
@Command(name = "checksum", mixinStandardHelpOptions = true, version = Array("checksum 4.0"),
description = Array("Prints the checksum (SHA-256 by default) of a file to STDOUT."))
class Checksum extends Callable[Int] {
@Parameters(index = "0", description = Array("The file whose checksum to calculate."))
private var file: File = null
@Option(names = Array("-a", "--algorithm"), description = Array("MD5, SHA-1, SHA-256, ..."))
private var algorithm = "SHA-256"
def call(): Int = {
val fileContents = Files.readAllBytes(file.toPath)
val digest = MessageDigest.getInstance(algorithm).digest(fileContents)
println(("%0" + digest.size * 2 + "x").format(new BigInteger(1, digest)))
0
}
}
object Checksum {
def main(args: Array[String]): Unit = {
System.exit(new CommandLine(new Checksum()).execute(args: _*))
}
}|
You can run this example online.
Try it without arguments, with an option like |
Implement Runnable or Callable and your command can be executed in one line of code.
The example main method calls CommandLine.execute to parse the command line, handle errors, handle requests for usage and version help, and invoke the business logic. Applications can call System.exit with the returned exit code to signal success or failure to their caller.
The mixinStandardHelpOptions attribute adds --help and --version options to your application.
|
The picocli Quick Guide shows other sample applications and explains them in more detail. |
|
The picocli-examples module in the picocli git repository has many more examples. |
2. Getting Started
You can add picocli as an external dependency to your project, or you can include it as source.
2.1. Add as External Dependency
Below are examples of configuring Gradle or Maven to use picocli as an external dependency in your project:
dependencies {
implementation 'info.picocli:picocli:4.7.6'
}<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli</artifactId>
<version>4.7.6</version>
</dependency>2.2. Add as Source
To include as source, get the source code from the GitHub file. Copy and paste it into a file called CommandLine.java, add it to your project, and enjoy!
2.3. Annotation Processor
The picocli-codegen module includes an annotation processor that can build a model from the picocli annotations at compile time rather than at runtime.
Enabling this annotation processor in your project is optional, but strongly recommended. Use this if you’re interested in:
-
Compile time error checking. The annotation processor shows errors for invalid annotations and attributes immediately when you compile, instead of during testing at runtime, resulting in shorter feedback cycles.
-
GraalVM native images. The annotation processor generates and updates GraalVM configuration files under
META-INF/native-image/picocli-generated/$projectduring compilation, to be included in the application jar. This includes configuration files for reflection, resources and dynamic proxies. By embedding these configuration files, your jar is instantly Graal-enabled. In most cases no further configuration is needed when generating a native image.
2.3.1. Processor option: project
The picocli annotation processor supports a number of options, most important of which is the project option to control the output subdirectory: the generated files are written to META-INF/native-image/picocli-generated/${project}. A good convention is to use the Maven ${project.groupId}/${project.artifactId} as the value; a unique subdirectory ensures your jar can be shaded with other jars that may also contain generated configuration files.
To configure this option, pass the -Aproject=<some value> to the javac compiler. The examples below show how to do this for Maven and Gradle.
2.3.2. Enabling the Annotation Processor
IDE
This page shows the steps to configure Eclipse and IntelliJ IDEA to enable annotation processing.
Using Build Tools
dependencies {
implementation 'info.picocli:picocli:4.7.6'
annotationProcessor 'info.picocli:picocli-codegen:4.7.6'
}
compileJava {
options.compilerArgs += ["-Aproject=${project.group}/${project.name}"]
}<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<!-- annotationProcessorPaths requires maven-compiler-plugin version 3.5 or higher -->
<version>${maven-compiler-plugin-version}</version>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>info.picocli</groupId>
<artifactId>picocli-codegen</artifactId>
<version>4.7.6</version>
</path>
</annotationProcessorPaths>
<compilerArgs>
<arg>-Aproject=${project.groupId}/${project.artifactId}</arg>
</compilerArgs>
</configuration>
</plugin>See the picocli-codegen README for more details.
Kotlin Projects Using Gradle
Kotlin projects should add the kotlin-kapt plugin to enable the Kotlin Annotation processing tool (kapt),
then replace annotationProcessor with kapt:
apply plugin: 'kotlin-kapt' // required
dependencies {
// ...
kapt 'info.picocli:picocli-codegen:4.7.6'
}And replace compileJava.options.compilerArgs with kapt.arguments:
kapt {
arguments {
arg("project", "${project.group}/${project.name}")
}
}See the picocli-codegen README for more details.
2.4. Running the Application
After we successfully compiled our example CheckSum application, let’s quickly look at how to run it.
There are many ways to run picocli-based applications, depending on whether we included picocli as source, created a jar for our application or not, and whether we created a shaded jar (also known as uber-jar) containing all dependencies.
Before we run our CheckSum application, let’s create an example file whose checksum we want to print. For example:
echo "hello" > hello.txtNow, assuming we created a jar named checksum.jar containing our compiled CheckSum.class, we can run the application with java -cp <classpath> <MainClass> [OPTIONS]. For example:
java -cp "picocli-4.7.6.jar:checksum.jar" CheckSum --algorithm SHA-1 hello.txtYou may want to package your application in such a way that end users can invoke it with a short command like this:
checksum --algorithm SHA-1 hello.txtSee the Packaging Your Application section for ideas on how to accomplish this.
3. Options and Parameters
Command line arguments can be separated into options and positional parameters. Options have a name, positional parameters are usually the values that follow the options, but they may be mixed.
Picocli has separate annotations for options and positional parameters.
3.1. Options
An option must have one or more names.
Picocli lets you use any option name you want.
Option names are case-sensitive by default, but this is customizable.
| You may be interested in this list of common option names. Following these conventions may make your application more intuitive to use for experienced users. |
The below example shows options with one or more names, options that take an option parameter, and a help option.
class Tar {
@Option(names = "-c", description = "create a new archive")
boolean create;
@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file")
File archive;
@Parameters(paramLabel = "FILE", description = "one or more files to archive")
File[] files;
@Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message")
private boolean helpRequested = false;
}class Tar : Runnable {
@Option(names = ["-c"], description = ["create a new archive"])
var create: Boolean = false;
@Option(names = ["-f", "--file"], paramLabel = "ARCHIVE", description = ["the archive file"])
lateinit var archive: File;
@Parameters(paramLabel = "FILE", description = ["one or more files to archive"])
lateinit var files: Array<File>;
@Option(names = ["-h", "--help"], usageHelp = true, description = ["display a help message"])
private var helpRequested: Boolean = false;
}Picocli matches the option names to set the field values.
String[] args = { "-c", "--file", "result.tar", "file1.txt", "file2.txt" };
Tar tar = new Tar();
new CommandLine(tar).parseArgs(args);
assert !tar.helpRequested;
assert tar.create;
assert tar.archive.equals(new File("result.tar"));
assert Arrays.equals(tar.files, new File[] {new File("file1.txt"), new File("file2.txt")});val args1 = arrayOf("-c", "--file", "result.tar", "file1.txt", "file2.txt")
var tar = Tar()
CommandLine(tar).parseArgs(*args1);
assert(!tar.helpRequested)
assert(tar.create)
assert(tar.archive.equals(File("result.tar")))
assert(Arrays.equals(tar.files, arrayOf<File>(File("file1.txt"), File("file2.txt"))))3.2. Interactive (Password) Options
Picocli 3.5 introduced password support: for options and positional parameters marked as interactive, the user is prompted to enter a value on the console.
When running on Java 6 or higher, picocli will use the Console.readPassword API so that user input is not echoed to the console.
From picocli 4.6, applications can choose to echo user input to the console by setting echo = true, and set the prompt text to control what is shown on the console when asking the user for input.
Interactive positional parameters have a limitation: they must be followed by a non-interactive positional parameter.
Commands where the last positional parameter is interactive are currently not supported.
|
3.2.1. Example
The example below demonstrates how an interactive option can be used to specify a password.
From picocli 3.9.6, interactive options can use type char[] instead of String, to allow applications to null out the array after use so that sensitive information is no longer resident in memory.
Example usage:
class Login implements Callable<Integer> {
@Option(names = {"-u", "--user"}, description = "User name")
String user;
@Option(names = {"-p", "--password"}, description = "Passphrase", interactive = true)
char[] password;
public Integer call() throws Exception {
byte[] bytes = new byte[password.length];
for (int i = 0; i < bytes.length; i++) { bytes[i] = (byte) password[i]; }
MessageDigest md = MessageDigest.getInstance("SHA-256");
md.update(bytes);
System.out.printf("Hi %s, your password is hashed to %s.%n", user, base64(md.digest()));
// null out the arrays when done
Arrays.fill(bytes, (byte) 0);
Arrays.fill(password, ' ');
return 0;
}
private String base64(byte[] arr) { /* ... */ }
}class Login : Callable<Int> {
@Option(names = ["-u", "--user"], description = ["User name"])
var user: String? = null
@Option(names = ["-p", "--password"], description = ["Passphrase"], interactive = true)
lateinit var password: CharArray
override fun call(): Int {
val bytes = ByteArray(password.size)
for (i in bytes.indices) { bytes[i] = password[i].toByte() }
val md = MessageDigest.getInstance("SHA-256")
md.update(bytes)
println(("Hi %s, your password is hashed to %s.").format(user, base64(md.digest())))
// null out the arrays when done
Arrays.fill(bytes, 0.toByte())
Arrays.fill(password, ' ')
return 0
}
private fun base64(arr: ByteArray): String { /* ... */ }
}When this command is invoked like this:
new CommandLine(new Login()).execute("-u", "user123", "-p");CommandLine(Login()).execute("-u", "user123", "-p")Then the user will be prompted to enter a value:
Enter value for --password (Passphrase):When running on Java 6 or higher, the user input is not echoed to the console.
After the user enters a password value and presses enter, the call() method is invoked, which prints something like the following:
Hi user123, your passphrase is hashed to 75K3eLr+dx6JJFuJ7LwIpEpOFmwGZZkRiB84PURz6U8=.3.2.2. Optionally Interactive
Interactive options by default cause the application to wait for input on stdin. For commands that need to be run interactively as well as in batch mode, it is useful if the option can optionally consume an argument from the command line.
The default arity for interactive options is zero, meaning that the option takes no parameters. From picocli 3.9.6, interactive options can also take a value from the command line if configured with arity = "0..1". (See Optional Values.)
For example, if an application has these options:
@Option(names = "--user")
String user;
@Option(names = "--password", arity = "0..1", interactive = true)
char[] password;@Option(names = ["--user"])
lateinit var user: String
@Option(names = ["--password"], arity = "0..1", interactive = true)
lateinit var password: CharArrayWith the following input, the password field will be initialized to "123" without prompting the user for input:
--password 123 --user Joe
However, if the password is not specified, the user will be prompted to enter a value. In the following example, the password option has no parameter, so the user will be prompted to type in a value on the console:
--password --user Joe
|
Providing Passwords to Batch Scripts Securely
Note that specifying a password in plain text on the command line or in scripts is not secure. There are alternatives that are more secure. One idea is to add a separate different option (that could be named A command that combines either of these with an interactive The |
|
Interactive options and shell applications with JLine 2
Interactive options do not work in conjunction with JLine 2’s |
3.2.3. Forcing Interactive Input
Be aware that picocli only prompts the user when the interactive option is specified without parameter:
$ myprogram # option not specified: no prompting You provided value 'null' $ myprogram --interactive-option=abc # option specified with parameter: no prompting You provided value 'abc' $ myprogram --interactive-option # option specified WITHOUT parameter: prompt for input Enter value for --interactive-option (...): # <--- type xxx and hit Enter You provided value 'xxx'
Applications that also need the user to be prompted when the option is not specified, need to do this in the business logic. For example:
@Command
public class Main implements Runnable {
@Option(names = "--interactive", interactive = true)
String value;
public void run() {
if (value == null && System.console() != null) {
// alternatively, use Console::readPassword
value = System.console().readLine("Enter value for --interactive: ");
}
System.out.println("You provided value '" + value + "'");
}
public static void main(String[] args) {
new CommandLine(new Main()).execute(args);
}
}@Command
class Main : Runnable {
@Option(names = ["--interactive"], description = ["unattended run"], interactive = true)
var value: String? = null
override fun run() {
if (value == null && System.console() != null) {
// alternatively, use console::readPassword
value = System.console().readLine("Enter value for --interactive: ")
}
println("You provided value '$value'")
}
}
fun main(args: Array<String>) : Unit = exitProcess(CommandLine(Main()).execute(*args))3.3. Short (POSIX) Options
Picocli supports POSIX clustered short options: one or more single-character options without option-arguments, followed by at most one option with an option-argument, can be grouped behind one '-' delimiter.
For example, given this annotated class:
class ClusteredShortOptions {
@Option(names = "-a") boolean aaa;
@Option(names = "-b") boolean bbb;
@Option(names = "-c") boolean ccc;
@Option(names = "-f") String file;
}class ClusteredShortOptions {
@Option(names = ["-a"]) var aaa = false
@Option(names = ["-b"]) var bbb = false
@Option(names = ["-c"]) var ccc = false
@Option(names = ["-f"]) lateinit var file: String
}The following command line arguments are all equivalent and parsing them will give the same result:
<command> -abcfInputFile.txt
<command> -abcf=InputFile.txt
<command> -abc -f=InputFile.txt
<command> -ab -cf=InputFile.txt
<command> -a -b -c -fInputFile.txt
<command> -a -b -c -f InputFile.txt
<command> -a -b -c -f=InputFile.txt
...|
POSIX short options and usability
Applications can give a subtle hint to end users that an option is common and encouraged by providing both a short and a long name for an option. Conversely, the absence of a short option can signal that the option is unusual or perhaps should be used with care. |
3.4. Boolean Options
Boolean options usually don’t need a parameter: it is enough to specify the option name on the command line.
class BooleanOptions {
@Option(names = "-x") boolean x;
}class BooleanOptions {
@Option(names = ["-x"]) var x = false
}The value of x is false by default, and is set to true (the opposite of the default) if the -x option is specified on the command line.
If the -x option is specified multiple times on the command line, the value of x remains true. (Prior to picocli 4.0, the value of x would "toggle" (flip to its opposite) for every -x option on the command line. This can still be configured if required.)
This is enough in most cases, but picocli offers alternatives for applications that need to get the value from something other than the default value. When the option is specified on the command line, the annotated field (or method) is assigned a value, as follows:
-
If the parser is configured to toggle boolean options, the opposite of the current value is assigned. (This was the default prior to picocli 4.0.)
-
If a fallback value is defined, the fallback value is assigned.
-
If the option is defined with a non-zero arity, and an option parameter was specified on the command line, this option parameter value is assigned.
-
Otherwise, the value assigned is the logical opposite of the default value.
3.5. Negatable Options
From picocli 4.0, boolean options can be negatable.
@Command(name = "negatable-options-demo")
class NegatableOptionsDemo {
@Option(names = "--verbose", negatable = true) boolean verbose;
@Option(names = "-XX:+PrintGCDetails", negatable = true) boolean printGCDetails;
@Option(names = "-XX:-UseG1GC", negatable = true) boolean useG1GC = true;
}@Command(name = "negatable-options-demo")
class NegatableOptionsDemo {
@Option(names = ["--verbose"], negatable = true) var verbose = false
@Option(names = ["-XX:+PrintGCDetails"], negatable = true) var printGCDetails = false
@Option(names = ["-XX:-UseG1GC"], negatable = true) var useG1GC = true
}When an option is negatable, picocli will recognize negative aliases of the option on the command line.
The usage help for the above example looks like this:
Usage: negatable-options-demo [--[no-]verbose] [-XX:(+|-)PrintGCDetails]
[-XX:(+|-)UseG1GC]
--[no-]verbose Show verbose output
-XX:(+|-)PrintGCDetails
Prints GC details
-XX:(+|-)UseG1GC Use G1 algorithm for GC
For *nix-style long options, aliases have the prefix no- to the given names, for example --no-verbose.
For Java JVM-style options like -XX:+PrintGCDetails, the :+ is turned into :- and vice versa.
Short option names are not given a negative alias by default. (This is customizable.)
If the negated form of the option is found, for example --no-verbose, the value is set to false. Otherwise, with a regular call, for example --verbose, the value is set to true.
|
Negatable options that are
true by defaultWhen a negatable option is Java
Kotlin
The table below shows the value assigned to the annotated option field for a number of possible user input strings: End user input Option value -------------- ------------ (no args) true --backup true --backup=true true --backup=false false --no-backup false --no-backup=true false --no-backup=false true |
3.6. Positional Parameters
Any command line arguments that are not subcommands or options (or option parameters) are interpreted as positional parameters. Positional parameters generally follow the options but from picocli 2.0, positional parameters can be mixed with options on the command line.
3.6.1. Explicit Index
Use the (zero-based) index attribute to specify exactly which parameters to capture.
Array or collection fields can capture multiple values.
The index attribute accepts range values, so an annotation like @Parameters(index="2..4") captures the arguments at index 2, 3 and 4. Range values can be open-ended. For example, @Parameters(index="3..*") captures all arguments from index 3 and up.
For example:
class PositionalParameters {
@Parameters(index = "0") InetAddress host;
@Parameters(index = "1") int port;
@Parameters(index = "2..*") File[] files;
@Parameters(hidden = true) // "hidden": don't show this parameter in usage help message
List<String> allParameters; // no "index" attribute: captures _all_ arguments
}class PositionalParameters {
@Parameters(index = "0") lateinit var host: InetAddress
@Parameters(index = "1") var port = 0
@Parameters(index = "2..*") lateinit var files: Array<File>
@Parameters(hidden = true) // "hidden": don't show this parameter in usage help message
lateinit var allParameters: List<String> // no "index" attribute: captures _all_ arguments
}Picocli initializes fields with the values at the specified index in the arguments array.
String[] args = { "localhost", "12345", "file1.txt", "file2.txt" };
PositionalParameters params = CommandLine.populateCommand(new PositionalParameters(), args);
assert params.host.getHostName().equals("localhost");
assert params.port == 12345;
assert Arrays.equals(params.files, new File[] {new File("file1.txt"), new File("file2.txt")});
assert params.allParameters.equals(Arrays.asList(args));val args = arrayOf("localhost", "12345", "file1.txt", "file2.txt")
val params: PositionalParameters = CommandLine.populateCommand(PositionalParameters(), *args)
assert(params.host.getHostName().equals("localhost"))
assert(params.port === 12345)
assert(Arrays.equals(params.files, arrayOf(File("file1.txt"), File("file2.txt"))))
assert(params.allParameters.equals(Arrays.asList(*args)))See Strongly Typed Everything for which types are supported out of the box and how to add custom types.
3.6.2. Omitting the Index
It is possible to omit the index attribute. This means different things for single-value and for multi-value positional parameters.
For multi-value positional parameters (arrays or collections), omitting the index attribute means the field captures all positional parameters (the equivalent of index = "0..*").
For single-value positional parameters, picocli’s behaviour has changed since version 4.3:
prior to picocli 4.3, the default index for single-value positional parameters was also index = "0..*", even though only one value (usually the first argument) can be captured.
From version 4.3, picocli assigns an index automatically, based on the other positional parameters defined in the same command.
|
Automatic indexes depend on the ability of Java reflection and Java annotation processors to iterate over fields in declaration order in the source code.
Officially this is not guaranteed by the Java spec.
In practice this has worked in Oracle JVMs and OpenJDK from Java 6, but there is some risk this may not work in the future or on other JVM’s.
In general, for single-value positional parameters, using explicit indexes is the safer option.
(Multi-value positional parameters can safely omit the |
Methods cannot be iterated over in predictable order.
For applications with @Parameters-annotated methods or combinations of @Parameters-annotated methods and @Parameters-annotated fields, we recommend using explicit indexes for single-value positional parameters.
|
See Automatic Parameter Indexes for details.
3.7. Mixing Options and Positional Parameters
From picocli 2.0, positional parameters can be specified anywhere on the command line, they no longer need to follow the options.
For example:
class Mixed {
@Parameters
List<String> positional;
@Option(names = "-o")
List<String> options;
}class Mixed {
@Parameters
lateinit var positional: List<String>
@Option(names = ["-o"])
lateinit var options: List<String>
}Any command line argument that is not an option or subcommand is interpreted as a positional parameter.
String[] args = { "param0", "-o", "AAA", "param1", "param2", "-o", "BBB", "param3" };
Mixed mixed = new Mixed();
new CommandLine(mixed).parseArgs(args);
assert mixed.positional.equals(Arrays.asList("param0", "param1", "param2", "param3");
assert mixed.options.equals (Arrays.asList("AAA", "BBB"));val args = arrayOf("param0", "-o", "AAA", "param1", "param2", "-o", "BBB", "param3")
val mixed = Mixed()
CommandLine(mixed).parseArgs(*args)
assert(mixed.positional == Arrays.asList("param0", "param1", "param2", "param3"))
assert(mixed.options == Arrays.asList("AAA", "BBB"))3.8. Double dash (--)
Picocli offers built-in support for the End-of-Options delimiter (--), as defined in Guideline 10 of the POSIX Utility Syntax Guidelines.
When one of the command line arguments is just two dashes without any characters attached (--),
picocli interprets all following arguments as positional parameters, even arguments that match an option name.
class DoubleDashDemo {
@Option(names = "-v") boolean verbose;
@Option(names = "-files") List<String> files;
@Parameters List<String> params;
}class DoubleDashDemo {
@Option(names = ["-v"]) var verbose = false
@Option(names = ["-files"]) var files: List<String>? = null
@Parameters lateinit var params: List<String>
}The -- end-of-options delimiter clarifies which of the arguments are positional parameters:
String[] args = { "-v", "--", "-files", "file1", "file2" };
DoubleDashDemo demo = new DoubleDashDemo();
new CommandLine(demo).parseArgs(args);
assert demo.verbose;
assert demo.files == null;
assert demo.params.equals(Arrays.asList("-files", "file1", "file2"));val args = arrayOf("-v", "--", "-files", "file1", "file2")
val demo = DoubleDashDemo()
CommandLine(demo).parseArgs(*args)
assert(demo.verbose)
assert(demo.files == null)
assert(demo.params == Arrays.asList("-files", "file1", "file2"))A custom delimiter can be configured with CommandLine.setEndOfOptionsDelimiter(String).
From picocli 4.3, an entry for -- can be shown in the options list of the usage help message of a command with the @Command(showEndOfOptionsDelimiterInUsageHelp = true) annotation.
See Show End of Options for details.
3.9. @-files
3.9.1. Argument Files for Long Command Lines
Users sometimes run into system limitations on the length of a command line when creating a command line with lots of options or with long arguments for options.
Starting from v2.1.0, picocli supports "argument files" or "@-files".
Argument files are files that themselves contain arguments to the command.
When picocli encounters an argument beginning with the character @,
it expands the contents of that file into the argument list.
An argument file can include options and positional parameters in any combination. The arguments within a file can be space-separated or newline-separated. If an argument contains embedded whitespace, put the whole argument in double or single quotes. Within quoted values, backslashes need to be escaped with another backslash.
For example, it is possible to have a path with a space,
such as c:\Program Files that can be specified as either "c:\\Program Files" or,
to avoid an escape, c:\Program" "Files.
Argument files do have a limitation: parameter or option values enclosed in quotes must not be preceded by an equal sign.
Something like myoption="foo bar" does not work inside an argument file.
To work around this, either omit the equal sign (myoption "foo bar") or enclose the whole expression in quotes ("myoption=\"foo bar\"").
|
Lines starting with # are comments and are ignored.
The comment character can be configured with CommandLine.setAtFileCommentChar(Character),
and comments can be switched off by setting the comment character to null.
The file may itself contain additional @-file arguments; any such arguments will be processed recursively.
If the file does not exist, or cannot be read, then the argument will be treated literally, and not removed. Multiple @-files may be specified on the command line. The specified path may be relative (to the current directory) or absolute.
For example, suppose a file with arguments exists at /home/foo/args, with these contents:
# This line is a comment and is ignored. ABC -option=123 'X Y Z'
A command may be invoked with the @file argument, like this:
java MyCommand @/home/foo/argsThe above will be expanded to the contents of the file:
java MyCommand ABC -option=123 "X Y Z"|
Handling of UTF-8 encoded argument files is tricky on Windows OS with Java up to version 17.
Either use |
In Java 18 the default encoding was changed from a system dependent value to
always be UTF-8. If you require the old behavior, you need to
set the file.encoding system property to the value COMPAT.
|
@-file expansion can be switched off by calling CommandLine::setExpandAtFiles with false.
If turned on, you can still pass a real parameter with an initial @ character by escaping it
with an additional @ symbol, e.g. @@somearg will become @somearg and not be subject to expansion.
This feature is similar to the 'Command Line Argument File' processing supported by gcc, javadoc and javac. The documentation for these tools has more details. See for example the documentation for java Command-Line Argument Files.
|
If you think your users may find this feature (@files) useful, you could consider adding an option to your application that generates an @file for the specified arguments.
The |
3.9.2. @-files Usage Help
From picocli 4.2, an entry for @<filename> can be shown in the options and parameters list of the usage help message of a command with the @Command(showAtFileInUsageHelp = true) annotation.
See Show At Files for details.
3.9.3. Simplified Format
From picocli 3.8.1, a simpler argument file format is also supported where every line (except empty lines and comment lines)
is interpreted as a single argument. Arguments containing whitespace do not need to be quoted,
but it is not possible to have arguments with embedded newlines or to have empty string arguments without quotes.
From picocli 3.9, this simpler argument format is fully compatible with JCommander's @-file argument file format.
You can tell picocli to use the simplified argument file format programmatically with CommandLine.setUseSimplifiedAtFiles(true),
or by setting system property picocli.useSimplifiedAtFiles without a value or with value "true"
(case-insensitive). The system property is useful to allow end users control over the format.
4. Strongly Typed Everything
When command line options and positional parameters are mapped to the annotated fields, the text value is converted to the type of the annotated field.
4.1. Built-in Types
Out of the box, picocli can convert command line argument strings to a number of common data types.
Most of the built-in types work with Java 5, but picocli also has some default converters for Java 7 types like Path and Java 8 types like Duration, etc. These converters are loaded using reflection and are only available when running on a Java version that supports them. See the below list for details.
-
any Java primitive type or their wrapper
-
any
enum -
String,StringBuilder,CharSequence -
java.math.BigDecimal,java.math.BigInteger -
java.nio.Charset -
java.io.File -
java.net.InetAddress -
java.util.regex.Pattern -
java.util.Date(for values in"yyyy-MM-dd"format) -
java.net.URL,java.net.URI -
java.util.UUID -
java.lang.Class(from picocli 2.2, for the fully qualified class name) -
java.nio.ByteOrder(from picocli 2.2, for the Strings"BIG_ENDIAN"or"LITTLE_ENDIAN") -
java.util.Currency(from picocli 2.2, for the ISO 4217 code of the currency) -
java.net.NetworkInterface(from picocli 2.2, for the InetAddress or name of the network interface) -
java.util.TimeZone(from picocli 2.2, for the ID for a TimeZone)
Converters loaded using reflection:
-
java.nio.file.Path(from picocli 2.2, requires Java 7 or higher) -
java.timevalue objects:Duration,Instant,LocalDate,LocalDateTime,LocalTime,MonthDay,OffsetDateTime,OffsetTime,Period,Year,YearMonth,ZonedDateTime,ZoneId,ZoneOffset(from picocli 2.2, requires Java 8 or higher, invokes theparsemethod of these classes) -
java.sql.Time(for values in any of the"HH:mm","HH:mm:ss","HH:mm:ss.SSS", or"HH:mm:ss,SSS"formats) -
java.sql.Timestamp(from picocli 2.2, for values in the"yyyy-MM-dd HH:mm:ss"or"yyyy-MM-dd HH:mm:ss.fffffffff"formats) -
java.sql.Connection(from picocli 2.2, for a database url of the formjdbc:subprotocol:subname) -
java.sql.Driver(from picocli 2.2, for a database URL of the formjdbc:subprotocol:subname)
Sometimes loading converters with reflection is not desirable.
Use system property picocli.converters.excludes to specify a comma-separated list of fully qualified class names for which the converter should not be loaded.
Regular expressions are supported.
For example, invoking the program with -Dpicocli.converters.excludes=java.sql.Ti.* will not load type converters for java.sql.Time and java.sql.Timestamp.
|
4.2. Custom Type Converters
Register a custom type converter to handle data types other than the above built-in ones.
4.2.1. Single Parameter Type Converters
Custom converters need to implement the picocli.CommandLine.ITypeConverter interface:
public interface ITypeConverter<K> {
/**
* Converts the specified command line argument value to some domain object.
* @param value the command line argument String value
* @return the resulting domain object
* @throws Exception an exception detailing what went wrong during the conversion
*/
K convert(String value) throws Exception;
}For example:
import javax.crypto.Cipher;
class CipherConverter implements ITypeConverter<Cipher> {
public Cipher convert(String value) throws Exception {
return Cipher.getInstance(value);
}
}Custom type converters can be specified for a specific option or positional parameter with the converter annotation attribute.
This is described in more detail in the Option-specific Type Converters section, but here is a quick example:
class App {
@Option(names = "-a", converter = CipherConverter.class)
javax.crypto.Cipher cipher;
}class App {
@Option(names = ["-a"], converter = [CipherConverter::class])
lateinit var cipher: javax.crypto.Cipher
}class App {
@Option(names = "-a", converter = CipherConverter.class)
def cipher
}class App {
@Option(names = "-a", converter = [ // requires Groovy 3.0.7
{ { str -> Cipher.getInstance(str) } as ITypeConverter }
])
def cipher
}
Groovy programs can use closures in the converter attribute of the annotation.
|
Alternatively, custom type converters can be registered per type in each command with the CommandLine.registerConverter(Class<K> cls, ITypeConverter<K> converter) method.
All options and positional parameters with the specified type will be converted by the specified converter.
After registering custom converters, call the execute(String…) or parseArgs(String…) method on the CommandLine instance where the converters are registered. (The static populateCommand method cannot be used.) For example:
class App {
@Parameters java.util.Locale locale;
@Option(names = "-a") javax.crypto.Cipher cipher;
}import java.util.Locale
import javax.crypto.Cipher
// ...
class App {
@Parameters
lateinit var locale: Locale
@Option(names = ["-a"])
lateinit var cipher: Cipher
}| Java 8 lambdas make it easy to register custom converters: |
App app = new App();
CommandLine commandLine = new CommandLine(app)
.registerConverter(Locale.class, s -> new Locale.Builder().setLanguageTag(s).build())
.registerConverter(Cipher.class, s -> Cipher.getInstance(s));
commandLine.parseArgs("-a", "AES/CBC/NoPadding", "en-GB");
assert app.locale.toLanguageTag().equals("en-GB");
assert app.cipher.getAlgorithm().equals("AES/CBC/NoPadding");val app = App()
val commandLine = CommandLine(app)
.registerConverter(Locale::class.java) {
s: String? -> Locale.Builder().setLanguageTag(s).build()
}
.registerConverter(Cipher::class.java) {
Cipher.getInstance(it)
}
commandLine.parseArgs("-a", "AES/CBC/NoPadding", "en-GB")
assert(app.locale.toLanguageTag() == "en-GB")
assert(app.cipher.algorithm == "AES/CBC/NoPadding")
Note on subcommands: the specified converter will be registered with the CommandLine object
and all subcommands (and nested sub-subcommands) that were added before the converter was registered.
Subcommands added later will not have the converter added automatically.
To ensure a custom type converter is available to all subcommands, register the type converter last, after adding subcommands.
|
4.2.2. Multi Parameter Type Converters
Some types take more than one parameter.
The IParameterConsumer interface can be used to implement a multi-parameter type converter.
@Command(name = "set-position")
class SetPositionCommand {
@Parameters(parameterConsumer = PointConverter.class)
private Point position;
static class PointConverter implements IParameterConsumer {
public void consumeParameters(Stack<String> args,
ArgSpec argSpec,
CommandSpec commandSpec) {
if (args.size() < 2) {
throw new ParameterException(commandSpec.commandLine(),
"Missing coordinates for Point. Please specify 2 coordinates."));
}
int x = Integer.parseInt(args.pop());
int y = Integer.parseInt(args.pop());
argSpec.setValue(new Point(x, y));
}
}
}@Command(name = "set-position")
class SetPositionCommand {
@Parameters(parameterConsumer = PointConverter::class)
private lateinit var position: Point
class PointConverter : IParameterConsumer {
override fun consumeParameters(args: Stack<String>,
argSpec: ArgSpec,
commandSpec: CommandSpec) {
if (args.size < 2) {
throw ParameterException(commandSpec.commandLine(),
"Missing coordinates for Point. Please specify 2 coordinates.")
}
val x = args.pop().toInt()
val y = args.pop().toInt()
argSpec.setValue(Point(x, y))
}
}
}See the sections on Custom Parameter Processing for more details.
Make sure any nested classes are static, or picocli will not be able to instantiate them.
|
4.3. Handling Invalid Input
If the user specifies invalid input, custom type converters should throw an exception. Any exception is fine, and will result in a message like the below being displayed to the user:
Invalid value for option '--socket-address': cannot convert 'xxxinvalidinput' to InetSocketAddress (java.lang.IllegalArgumentException: Invalid format: must be 'host:port' but was 'xxxinvalidinput')
The above error message is generic and is reasonable for many exceptions, but sometimes you want more control over the error message displayed to the user.
To achieve this, throw a picocli.CommandLine.TypeConversionException instead.
When a TypeConversionException is thrown, picocli will show an error message that indicates the problematic option, followed by the exception message text. The resulting output looks something like this:
Invalid value for option '--socket-address': Invalid format: must be 'host:port' but was 'xxxinvalidinput'
Below is an example custom converter that throws a TypeConversionException:
import java.net.InetSocketAddress;
class InetSocketAddressConverter implements ITypeConverter<InetSocketAddress> {
@Override
public InetSocketAddress convert(String value) {
int pos = value.lastIndexOf(':');
if (pos < 0) {
throw new TypeConversionException(
"Invalid format: must be 'host:port' but was '" + value + "'");
}
String adr = value.substring(0, pos);
int port = Integer.parseInt(value.substring(pos + 1));
return new InetSocketAddress(adr, port);
}
}import java.net.InetSocketAddress
// ...
class InetSocketAddressConverter : ITypeConverter<InetSocketAddress> {
override fun convert(value: String): InetSocketAddress {
val pos = value.lastIndexOf(':')
if (pos < 0) {
throw CommandLine.TypeConversionException(
"Invalid format: must be 'host:port' but was '$value'")
}
val adr = value.substring(0, pos)
val port = value.substring(pos + 1).toInt()
return InetSocketAddress(adr, port)
}
}The picocli-examples module on GitHub has a minimal working example which you can run in our online-editor.
|
Note that when an option has variable arity, the picocli parser cannot tell whether each next argument belongs to that option or to a positional parameter. It will try to assign to the option first, but it will take the type conversion exception to mean that it has reached the end of the parameters for that option, and this argument must be assigned to a positional parameter instead. If it then cannot find a positional parameter, an unmatched argument error is shown to the end user instead. |
4.4. Option-specific Type Converters
Picocli 2.2 added a converter attribute to the @Option and @Parameter annotations. This allows a specific option or positional parameter to use a different converter than would be used by default based on the type of the field.
For example, for a specific field you may want to use a converter that maps the constant names defined in java.sql.Types to the int value of these constants, but any other int fields should not be affected by this and should continue to use the standard int converter that parses numeric values.
Example usage:
class App {
@Option(names = "--sqlType", converter = SqlTypeConverter.class)
int sqlType;
}class App {
@Option(names = ["--sqlType"], converter = [SqlTypeConverter::class])
var sqlType = 0
}Example implementation:
class SqlTypeConverter implements ITypeConverter<Integer> {
public Integer convert(String value) throws Exception {
switch (value) {
case "ARRAY" : return Types.ARRAY;
case "BIGINT" : return Types.BIGINT;
case "BINARY" : return Types.BINARY;
case "BIT" : return Types.BIT;
case "BLOB" : return Types.BLOB;
// ...
}
}
}class SqlTypeConverter : ITypeConverter<Int> {
@Throws(Exception::class)
override fun convert(value: String): Int {
when (value) {
"ARRAY" -> return Types.ARRAY
"BIGINT" -> return Types.BIGINT
"BINARY" -> return Types.BINARY
"BIT" -> return Types.BIT
"BLOB" -> return Types.BLOB
// ...
}
}
}This may also be useful for applications that need a custom type converter but want to use the static convenience methods (populateCommand, run, call, invoke). The converter annotation does not require a CommandLine instance so it can be used with the static convenience methods.
Type converters declared with the converter attribute need to have a public no-argument constructor to be instantiated, unless a Custom Factory is installed to instantiate classes.
If your type converter is declared as nested class, make sure you mark this class as static, or picocli will not be able to instantiate your nested converter class.
|
4.5. Arrays, Collections, Maps
Starting from picocli 2.0, the type attribute is no longer necessary for Collection and Map fields:
picocli will infer the collection element type from the generic type.
(The type attribute still works as before, it is just optional in most cases.)
|
4.5.1. Arrays and Collections
Multiple parameters can be captured together in a single array or Collection field.
The array or collection elements can be any type for which a converter is registered.
For example:
import java.util.regex.Pattern;
import java.io.File;
class Convert {
@Option(names = "-patterns", description = "the regex patterns to use")
Pattern[] patterns;
@Parameters(/* type = File.class, */ description = "the files to convert")
List<File> files; // picocli infers type from the generic type
}import java.io.File
import java.util.regex.Pattern
// ...
class Convert {
@Option(names = ["-patterns"], description = ["the regex patterns to use"])
lateinit var patterns: Array<Pattern>
@Parameters( /* type = [File::class], */ description = ["the files to convert"])
lateinit var files: List<File> // picocli infers type from the generic type
}String[] args = { "-patterns", "a*b", "-patterns", "[a-e][i-u]", "file1.txt", "file2.txt" };
Convert convert = CommandLine.populateCommand(new Convert(), args);
// convert.patterns now has two Pattern objects
// convert.files now has two File objectsval args = arrayOf("-patterns", "a*b", "-patterns", "[a-e][i-u]", "file1.txt", "file2.txt")
val convert = CommandLine.populateCommand(Convert(), *args)
// convert.patterns now has two Pattern objects
// convert.files now has two File objects| If a collection is returned from a type converter, the contents of the collection are added to the field or method parameter, not the collection itself. |
If the field or method parameter is null, picocli will instantiate it when the option or positional parameter is successfully matched.
If the Collection type is not a concrete class, picocli will make a best effort to instantiate it based on the field type:
List → ArrayList, SortedSet → TreeSet, Set → LinkedHashSet, Queue → LinkedList, otherwise, ArrayList.
Multi-value options and positional parameters can be defined with a split regular expression to allow end users to specify multiple values in a single parameter.
See the Split Regex section for details.
4.5.2. Maps
Picocli 1.0 introduced support for Map fields similar to Java’s system properties -Dkey=value or Gradle properties -P myprop=myvalue.
Map fields may have any type for their key and value
as long as a converter is registered for both the key and the value type.
Key and value types are inferred from the map’s generic type parameters.
For example:
import java.net.InetAddress;
import java.net.Proxy.Type;
import java.util.concurrent.TimeUnit;
class MapDemo {
@Option(names = {"-p", "--proxyHost"})
Map<Proxy.Type, InetAddress> proxies;
@Option(names = {"-u", "--timeUnit"})
Map<TimeUnit, Long> timeout;
}import java.net.InetAddress
import java.net.Proxy
import java.util.concurrent.TimeUnit
// ...
class MapDemo {
@Option(names = ["-p", "--proxyHost"])
lateinit var proxies: Map<Proxy.Type, InetAddress>
@Option(names = ["-u", "--timeUnit"])
lateinit var timeout: Map<TimeUnit, Long>
}Map options may be specified multiple times with different key-value pairs. (See Multiple Values.)
<command> -p HTTP=123.123.123.123 --proxyHost SOCKS=212.212.212.212
<command> -uDAYS=3 -u HOURS=23 -u=MINUTES=59 --timeUnit=SECONDS=13If the annotated field is null, picocli will instantiate it when the option or positional parameter is matched.
If the Map type is not a concrete class, picocli will instantiate a LinkedHashMap to preserve the input ordering.
On the command line, the key and the value must be separated by an = character.
|
Map options and positional parameters can be defined with a split regular expression to allow end users to specify multiple values in a single parameter.
See the Split Regex section for details.
4.5.3. Key-only map parameters
By default, picocli expects Map options and positional parameters to look like key=value,
that is, the option parameter or positional parameter is expected to have a key part and a value part, separated by an = character.
If this is not the case, picocli shows a user-facing error message: Value for … should be in KEY=VALUE format but was ….
From picocli 4.6, applications can specify a mapFallbackValue to allow end users to specify only the key part.
The specified mapFallbackValue is put into the map when end users do specify only a key.
The value type can be wrapped in a java.util.Optional.
For example:
@Option(names = {"-P", "--properties"}, mapFallbackValue = Option.NULL_VALUE)
Map<String, Optional<Integer>> properties;
@Parameters(mapFallbackValue = "INFO", description = "... ${MAP-FALLBACK-VALUE} ...")
Map<Class<?>, LogLevel> logLevels;@Option(names = ["-P", "--properties"], mapFallbackValue = Option.NULL_VALUE)
lateinit var properties: Map<String, Optional<Int>>
@Parameters(mapFallbackValue = "INFO", description = "... ${MAP-FALLBACK-VALUE} ...")
lateinit var logLevels: Map<Class<?>, LogLevel>This allows input like the following:
<cmd> --properties=key1 -Pkey2 -Pkey3=3 org.myorg.MyClass org.myorg.OtherClass=DEBUG
The above input would give the following results:
properties = [key1: Optional.empty, key2: Optional.empty, key3: Optional[3]] logLevels = [org.myorg.MyClass: INFO, org.myorg.OtherClass: DEBUG]
Note that the option description may contain the ${MAP-FALLBACK-VALUE} variable which will be replaced with the actual map fallback value when the usage help is shown.
4.5.4. System Properties
A common requirement for command line applications is to support the -Dkey=value syntax to allow end users to set system properties.
The example below uses the Map type to define an @Option-annotated method that delegates all key-value pairs to System::setProperty.
Note the use of mapFallbackValue = "" to allow key-only option parameters.
class SystemPropertiesDemo {
@Option(names = "-D", mapFallbackValue = "") // allow -Dkey
void setProperty(Map<String, String> props) {
props.forEach((k, v) -> System.setProperty(k, v));
}
}class SystemPropertiesDemo {
@Option(names = ["-D"], mapFallbackValue = "") // allow -Dkey
fun setProperty(props: Map<String, String>) {
props.forEach { (k: String, v: String) -> System.setProperty(k, v) }
}
}4.6. Optional<T>
From version 4.6, picocli supports single-value types wrapped in a java.util.Optional container object when running on Java 8 or higher.
If the option or positional parameter was not specified on the command line, picocli assigns the value Optional.empty() instead of null.
For example:
@Option(names = "-x")
Optional<Integer> x;
@Option(names = "-D", mapFallbackValue = Option.NULL_VALUE)
Map<String, Optional<Integer>> map;@Option(names = ["-x"])
lateinit var x: Optional<Int>
@Option(names = ["-D"], mapFallbackValue = Option.NULL_VALUE)
lateinit var map: Map<String, Optional<Int>>
Picocli has only limited support for java.util.Optional types:
only single-value types, and the values in a Map (but not the keys!) can be wrapped in an Optional container.
java.util.Optional cannot be combined with arrays or other Collection classes.
|
4.7. Abstract Field Types
The field’s type can be an interface or an abstract class.
The type attribute can be used to control for each field what concrete class the string value should be converted to.
For example:
class App {
@Option(names = "--big", type = BigDecimal.class) // concrete Number subclass
Number[] big; // array type with abstract component class
@Option(names = "--small", type = Short.class) // other Number subclass
Number[] small;
@Parameters(type = StringBuilder.class) // StringBuilder implements CharSequence
CharSequence address; // interface type
}class App {
@Option(names = ["--big"], type = [BigDecimal::class]) // concrete Number subclass
lateinit var big: Array<Number> // array type with abstract component class
@Option(names = ["--small"], type = [Short::class]) // other Number subclass
lateinit var small: Array<Number>
@Parameters(type = [StringBuilder::class]) // StringBuilder implements CharSequence
lateinit var address: CharSequence // interface type
}4.7.1. Maps and Collections with Abstract Elements
For raw maps and collections, or when using generics with unbounded wildcards like Map<?, ?>, or when the type parameters are themselves abstract classes like List<CharSequence> or Map<? extends Number, ? super Number>, there is not enough information to convert to a stronger type. By default, the raw String values are added as is to such collections.
The type attribute can be specified to convert to a stronger type than String. For example:
class TypeDemo {
@Option(names = "-x") // not enough information to convert
Map<?, ?> weaklyTyped; // String keys and values are added as is
@Option(names = "-y", type = {Short.class, BigDecimal.class})
Map<? extends Number, ? super Number> stronglyTyped;
@Option(names = "-s", type = CharBuffer.class)
List<CharSequence> text;
}class TypeDemo {
@Option(names = ["-x"]) // not enough information to convert
lateinit var weaklyTyped: Map<*, *> // String keys and values are added as is
@Option(names = ["-y"], type = [Short::class, BigDecimal::class])
lateinit var stronglyTyped: Map<out Number, Number>
@Option(names = ["-s"], type = [CharBuffer::class])
lateinit var text: List<CharSequence>
}4.8. Enum Types
It is encouraged to use enum types for options or positional parameters with a limited set of valid values.
Not only will picocli validate the input, it allows you to show all values in the usage help message with @Option(description = "Valid values: ${COMPLETION-CANDIDATES}"). It also allows command line completion to suggest completion candidates for the values of this option.
Enum value matching is case-sensitive by default, but as of picocli 3.4 this can be controlled with CommandLine::setCaseInsensitiveEnumValuesAllowed and CommandSpec::caseInsensitiveEnumValuesAllowed.
5. Default Values
It is possible to define a default value for an option or positional parameter, that is assigned when the user did not specify this option or positional parameter on the command line.
Configuring a default value guarantees that the @Option or @Parameters-annotated field will get set, annotated method will get called, and, when using the programmatic API, that the ArgSpec.setValue method will get invoked, even when the option or positional parameter was not specified on the command line.
5.1. defaultValue Annotation
The recommended way to give an option or positional parameter a default value is to use the defaultValue annotation attribute. This works correctly with argument groups, @Option and @Parameters-annotated methods, and allows annotation processors to detect and use default values.
For @Option and @Parameters-annotated methods and @Command-annotated methods, there is no alternative but to use the defaultValue annotation attribute. For example, for an annotated interface:
interface Spec {
@Option(names = "-c", defaultValue = "123", description = "... ${DEFAULT-VALUE} ...")
int count();
}interface Spec {
@Option(names = ["-c"], defaultValue = "123", description = ["... \${DEFAULT-VALUE} ..."])
fun count(): Int
}Example of using the defaultValue attribute in the option of a command method:
class CommandMethod {
@Command(description = "Do something.")
void doit(@Option(names = "-c", defaultValue = "123") int count) {
// ...
}
}class CommandMethod {
@Command(description = ["Do something."])
fun doit(@Option(names = ["-c"], defaultValue = "123") count: Int) {
// ...
}
}5.2. Field Values
For annotated fields, it is possible to declare the field with a value:
@Option(names = "-c", description = "The count (default: ${DEFAULT-VALUE})")
int count = 123; // default value is 123@Option(names = ["-c"], description = ["The count (default: \${DEFAULT-VALUE})"])
var count = 123 // default value is 123|
Defining a default value by assigning a value at the field declaration has limitations:
|
5.3. Variables in Default Values
The default value itself may also contain variables. For example:
@Option(names = "-c", defaultValue = "${COUNT:-123}")
int count;@Option(names = ["-c"], defaultValue = "\${COUNT:-123}")
lateinit count: intPicocli will look up the value of the COUNT variable in the system properties, environment variables, and resource bundle, and finally use value 123 if no value is found for any of these lookups.
5.4. Default Provider
Finally, you can specify a default provider in the @Command annotation:
@Command(defaultValueProvider = MyDefaultProvider.class)
class MyCommand // ...@Command(defaultValueProvider = MyDefaultProvider::class)
class MyCommand // ...The default provider allows you to get default values from a configuration file or some other central place.
Default providers need to implement the picocli.CommandLine.IDefaultValueProvider interface:
public interface IDefaultValueProvider {
/**
* Returns the default value for an option or positional parameter or {@code null}.
* The returned value is converted to the type of the option/positional parameter
* via the same type converter used when populating this option/positional
* parameter from a command line argument.
*
* @param argSpec the option or positional parameter, never {@code null}
* @return the default value for the option or positional parameter, or {@code null} if
* this provider has no default value for the specified option or positional parameter
* @throws Exception when there was a problem obtaining the default value
*/
String defaultValue(ArgSpec argSpec) throws Exception;
}See the default provider examples for example implementations.
| If the command has a default provider configured, and the option or positional parameter has a default value configured, then picocli will first try to find the value in the default provider. If the default provider has no value for that option or positional parameter, then the default value configured on the option or positional parameter is used. |
5.5. PropertiesDefaultProvider
From picocli 4.1, applications can use the built-in PropertiesDefaultProvider
implementation that loads default values from a properties file.
By default, this implementation tries to find a properties file named .${COMMAND-NAME}.properties in the user home directory or in the classpath, where ${COMMAND-NAME} is the name of the command. If a command has aliases in addition to its name, these aliases are also used to try to find the properties file. For example:
import picocli.CommandLine.PropertiesDefaultProvider;
// ...
@Command(name = "git", defaultValueProvider = PropertiesDefaultProvider.class)
class Git { }import picocli.CommandLine.PropertiesDefaultProvider;
// ...
@Command(name = "git", defaultValueProvider = PropertiesDefaultProvider::class)
class Git { }The above will try to load default values from new File(System.getProperty("user.home"), ".git.properties").
The location of the properties file can also be controlled with system property "picocli.defaults.${COMMAND-NAME}.path" ("picocli.defaults.git.path" in this example), in which case the value of the property must be the path to the file containing the default values.
Finally, picocli will try to load the .git.properties file from the classpath.
The location of the properties file may also be specified programmatically. For example:
CommandLine cmd = new CommandLine(new MyCommand());
File defaultsFile = new File("path/to/config/mycommand.properties");
cmd.setDefaultValueProvider(new PropertiesDefaultProvider(defaultsFile));
cmd.execute(args);val cmd = CommandLine(MyCommand())
val defaultsFile = File("path/to/config/mycommand.properties")
cmd.defaultValueProvider = PropertiesDefaultProvider(defaultsFile)
cmd.execute(*args)5.5.1. PropertiesDefaultProvider Format
The PropertiesDefaultProvider expects the properties file to be in the standard java .properties format.
For options, the key is either the descriptionKey,
or the option’s longest name, without the prefix. So, for an option --verbose, the key would be verbose, and for an option /F, the key would be F.
For positional parameters, the key is either the descriptionKey, or the positional parameter’s param label.
End users may not know what the descriptionKey of your options and positional parameters are, so be sure to document that with your application.
5.5.2. Subcommands Default Values
The default values for options and positional parameters of subcommands can be included in the
properties file for the top-level command, so that end users need to maintain only a single file.
This can be achieved by prefixing the keys for the options and positional parameters
with their command’s qualified name.
For example, to give the git commit command’s --cleanup option a
default value of strip, define a key of git.commit.cleanup and assign
it a default value:
# /home/remko/.git.properties
git.commit.cleanup = strip5.6. fallbackValue Annotation
If an option is defined with arity = "0..1", it may or may not have a parameter value.
If such an option is specified without a value on the command line, it is assigned the fallback value.
The fallbackValue annotation attribute was introduced in picocli 4.0; prior to this, (from picocli 2.3) an empty String was assigned.
This is different from the defaultValue, which is assigned if the option is not specified at all on the command line.
For example:
class FallbackValueDemo implements Runnable {
@Option(names = "-x", arity = "0..1",
defaultValue = "-1", fallbackValue = "-2",
description = "Option with optional parameter. Default: ${DEFAULT-VALUE}, " +
"if specified without parameter: ${FALLBACK-VALUE}")
int x;
public void run() { System.out.printf("x = %s%n", x); }
public static void main(String... args) {
new CommandLine(new FallbackValueDemo()).execute(args);
}
}class FallbackValueDemo : Runnable {
@Option(names = ["-x"], arity = "0..1",
defaultValue = "-1", fallbackValue = "-2",
description = ["Option with optional parameter. Default: \${DEFAULT-VALUE}, " +
"if specified without parameter: \${FALLBACK-VALUE}"])
var x = 0
override fun run() { println("x = $x") }
}
fun main(args: Array<String>) {
CommandLine(FallbackValueDemo()).execute(*args)
}Gives the following results:
java FallbackValueDemo -x 100
x = 100
java FallbackValueDemo -x
x = -2
java FallbackValueDemo
x = -1Any String value is converted to the type of the option before it is assigned to the option. Options and positional parameters may define a custom type converter if necessary.
Note that the option description may contain the ${FALLBACK-VALUE} variable which will be replaced with the actual fallback value when the usage help is shown.
Boolean options can also define a fallbackValue to specify the value that should be set when the option is matched on the command line, regardless of the default value. This can be useful when the default is configurable by the end user, for example.
5.7. Was a Value Defaulted?
Sometimes an application is interested in knowing whether an option value was specified on the command line, or whether the default value was assigned.
You can use ParseResult::hasMatchedOption to detect whether an option was actually matched on the command line,
and ParseResult::matchedOptionValue to get the (type-converted) value that was specified on the command line.
OptionSpec::getValue will return the value assigned (which may be a command line argument or may be the default value).
For example:
@Command(name = "defaults", mixinStandardHelpOptions = true, version = "defaults 0.1")
public class DefaultValueDemo implements Runnable {
@Option(names = "-x")
int x = 10;
@Option(names = "-y", defaultValue = "20")
int y;
@Spec CommandSpec spec;
@Override
public void run() {
ParseResult pr = spec.commandLine().getParseResult();
for (OptionSpec option : spec.options()) {
String name = option.longestName();
System.out.printf("%s was specified: %s%n", name, pr.hasMatchedOption(option));
System.out.printf("%s=%s (-1 means this option was not matched on command line)%n",
name, pr.matchedOptionValue(name, -1));
System.out.printf("%s=%s (arg value or default)%n", name, option.getValue());
System.out.println();
}
}
public static void main(String[] args) {
new CommandLine(new DefaultValueDemo()).execute(args);
}
}@Command(name = "defaults", mixinStandardHelpOptions = true, version = ["defaults 0.1"])
class DefaultValueDemo<T> : Runnable {
@Option(names = ["-x"])
var x = 10
@Option(names = ["-y"], defaultValue = "20")
var y = 0
@Spec lateinit var spec: CommandSpec
override fun run() {
val pr: ParseResult = spec.commandLine().parseResult
for (option in spec.options()) {
val name = option.longestName()
println("$name was specified: ${pr.hasMatchedOption(option)}")
println("$name=${pr.matchedOptionValue(name, -1)} " +
"(-1 means this option was not matched on command line)")
println("$name=${option.getValue<T>()} (arg value or default)")
println()
}
}
}
fun main(args: Array<String>) {
CommandLine(DefaultValueDemo<Any>()).execute(*args)
}5.8. Null Default Values
To assign null as default value, applications can use the value Option.NULL_VALUE in the annotations for defaultValue and fallbackValue.
If the type of the option or positional parameter is Optional<T>, then picocli assigns the default value Optional.empty() instead of null.
For example:
@Option(names = "-x", defaultValue = Option.NULL_VALUE)
Integer x; // default value is null
@Option(names = "-y", defaultValue = Option.NULL_VALUE)
Optional<Integer> y; // default value is Optional.empty()
@Option(names = "-D", mapFallbackValue = Option.NULL_VALUE)
Map<String, Optional<Integer>> map; // "-Dkey" results in ["key" : Optional.empty()]@Option(names = ["-x"], defaultValue = Option.NULL_VALUE)
lateinit var x: Int // default value is null
@Option(names = ["-y"], defaultValue = Option.NULL_VALUE)
lateinit var y: Optional<Int> // default value is Optional.empty()
@Option(names = ["-D"], mapFallbackValue = Option.NULL_VALUE)
lateinit var map: Map<String, Optional<Int>> // "-Dkey" results in ["key" : Optional.empty()]6. Multiple Values
Multi-valued options and positional parameters are annotated fields that can capture multiple values from the command line.
6.1. Multiple Occurrences
6.1.1. Repeated Options
The simplest way to create a multi-valued option is to declare an annotated field whose type is an array, collection or a map.
@Option(names = "-option")
int[] values;@Option(names = ["-option"])
lateinit var values: IntArrayUsers may specify the same option multiple times. For example:
<command> -option 111 -option 222 -option 333
Each value is appended to the array or collection.
6.1.2. Multiple Positional Parameters
Similarly for multi-valued positional parameters:
@Parameters
List<TimeUnit> units;@Parameters
lateinit var units: List<TimeUnit>Users may specify multiple positional parameters. For example:
<command> SECONDS HOURS DAYS
Again, each value is appended to the array or collection.
6.1.3. Repeated Boolean Options
Boolean options with multiple values are supported as of picocli 2.1.0.
@Option(names = "-v", description = { "Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`"})
boolean[] verbosity;@Option(names = ["-v"], description = ["Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`"])
lateinit var verbosity: BooleanArrayUsers may specify multiple boolean flag options without parameters. For example:
<command> -v -v -v -vvv
The above example results in six true values being added to the verbosity array.
6.2. Split Regex
Options and parameters may also specify a split regular expression used to split each option parameter into smaller substrings.
Each of these substrings is converted to the type of the collection or array. See Arrays and Collections.
@Option(names = "-option", split = ",")
int[] values;@Option(names = ["-option"], split = ",")
lateinit var values: IntArrayA single command line argument like the following will be split up and three int values are added to the array:
-option 111,222,333
Similarly for Maps:
@Option(names = "-fix", split = "\\|", splitSynopsisLabel = "|")
Map<Integer, String> message;@Option(names = ["-fix"], split = "\\|", splitSynopsisLabel = "|")
lateinit var message: Map<Int, String>With the above option, command line arguments like the following are interpreted as a set of key-value pairs instead of a single string:
| characters from being interpreted by the shell as "pipe" directives to connect processes.-fix "8=FIX.4.4|9=69|35=A|49=MBT|56=TargetCompID|34=9|52=20130625-04:05:32.682|98=0|108=30|10=052"
The above input results in the message field being assigned a LinkedHashMap with the following key-value pairs:
{8=FIX.4.4, 9=69, 35=A, 49=MBT, 56=TargetCompID, 34=9, 52=20130625-04:05:32.682, 98=0, 108=30, 10=052}
See Quoted Values for details on handling more complex cases.
Picocli 4.3 introduced the splitSynopsisLabel attribute to control what is shown in the synopsis of the usage help message.
See Split Synopsis Label for details.
6.3. Arity
Sometimes you want to define an option that requires more than one option parameter for each option occurrence on the command line.
The arity attribute lets you control exactly how many parameters to consume for each option occurrence.
The arity attribute can specify an exact number of required parameters, or a range with a minimum and a maximum number of parameters.
The maximum can be an exact upper bound, or it can be "*" to denote any number of parameters. For example:
class ArityDemo {
@Parameters(arity = "1..3", description = "one to three Files")
File[] files;
@Option(names = "-f", arity = "2", description = "exactly two floating point numbers")
double[] doubles;
@Option(names = "-s", arity = "1..*", description = "at least one string")
String[] strings;
}class ArityDemo {
@Parameters(arity = "1..3", description = ["one to three Files"])
lateinit var files: Array<File>
@Option(names = ["-f"], arity = "2", description = ["exactly two floating point numbers"])
lateinit var doubles: DoubleArray
@Option(names = ["-s"], arity = "1..*", description = ["at least one string"])
lateinit var strings: Array<String>
}A MissingParameterException is thrown when fewer than the minimum number of parameters is specified on the command line.
Once the minimum number of parameters is consumed, picocli will check each subsequent command line argument to see whether it is an additional parameter, or a new option. For example:
ArityDemo -s A B C -f 1.0 2.0 /file1 /file2
Option -s has arity "1..*" but instead of consuming all parameters,
the -f argument is recognized as a separate option.
6.4. Variable Arity Limitations
6.4.1. Variable Arity Options and Unknown Options
As mentioned in the previous section, while processing parameters for an option with variable arity, when a known option, a subcommand, or the end-of-options delimiter is encountered, picocli will stop adding parameters to the variable arity option.
However, by default the picocli parser does not give special treatment to unknown options (values that "look like" an option) when processing parameters for an option with variable arity. Such values are simply consumed by the option with variable arity. From picocli 4.4 this is configurable.
6.4.2. Variable Arity Options and Positional Parameters
Be careful when defining commands that have both an option with variable arity (like arity = "0..*") and a positional parameter.
|
The picocli parser is "greedy" when it handles option parameters for options with variable arity: it looks at the value following the option name, and if that value can be taken as a parameter (not another option or subcommand, and max arity is not reached yet) then it will process the value as a parameter for that option. This may not always be what you want. |
For example:
class Ambiguous {
@Parameters(description = "The file (required).")
File file;
@Option(names = "-y", arity = "0..*",
description = "Option with optional parameters")
List<String> values;
}class Ambiguous {
@Parameters(description = ["The file (required)."])
lateinit var file: File
@Option(names = ["-y"], arity = "0..*",
description = ["Option with optional parameters"])
lateinit var values: List<String>
}When -y a b c path/to/file is specified on the command line, this results in an error: Missing required parameter: <file>.
Users can use the end-of-options delimiter and disambiguate the input with
-y a b c ‐‐ VALUE, but this may not be obvious to many users.
One idea is to show the end-of-options delimiter in the usage help.
A better alternative may be to redesign your command to avoid the ambiguity altogether.
One idea is to use the default arity (arity = "1" in our example) and use the split attribute to allow users to specify multiple values in a single argument like a,b,c.
If -y takes only a single parameter, then user input like -y a,b,c path/to/file is no longer ambiguous.
6.5. Default Arity
If no arity is specified, the number of parameters depends on the field’s type.
6.5.1. Option Arity
| @Option Field Type | Default Arity | Notes |
|---|---|---|
boolean |
0..1 |
Boolean options by default don’t require an option parameter. The field is set to the opposite of its default value when the option name is recognized. (This can be configured.) |
Single-valued type (e.g., |
1 |
The option name must be followed by a value. |
Multi-valued type (arrays, collections or maps) |
1 |
The option name must be followed by a value. |
Prior to picocli 2.0, multi-valued options used to greedily consume as many arguments as possible until
encountering another option or subcommand.
If your application relies on the previous behaviour, you need to explicitly specify an option arity of 0..* when migrating to picocli 2.0.
|
6.5.2. Positional Parameter Arity
| @Parameters Field Type | Default Arity | Notes |
|---|---|---|
boolean |
1 |
Positional parameters of type |
Single-valued type (e.g., |
1 |
One parameter required for each position. |
Multi-valued type (arrays, collections or maps) |
0..1 |
For multi-valued positional parameters (arrays, collections or maps), values are optional, not required. |
@Parameters fields are applied to a command line argument if their index matches the argument’s position.
The default index is *, meaning all positions.
A @Parameters field with index = "*" is applied multiple times: once for each positional parameter on the command line.
When a @Parameters field is applied (because its index matches the index of the positional parameter), the field may consume zero, one or more arguments, depending on its arity.
6.6. Optional Values
6.6.1. Optional Option Parameters
When an option is defined with arity = "0..1", it may or not have a parameter value.
The fallback value determines what value is assigned when the option is specified without a value, while the default value determines what value is assigned when the option is not specified at all.
6.6.2. Optional Parameter Use Cases
This feature is commonly used when an application wants to combine two options into one: the presence or absence of the option can be used like a boolean flag to trigger some behaviour, and the option value can be used to modify this behaviour.
An example use case is an option that switches on logging when present, with an optional value to set the log level. For example:
@Option(names = "--syslog", defaultValue = "OFF", fallbackValue = "INFO",
description = {
"When specified without arguments, start sending syslog messages at INFO level.",
"If absent, no messages are sent to syslog.",
"Optionally specify a severity value. Valid values: ${COMPLETION-CANDIDATES}."})
MyLogLevel syslogLevel;@Option(names = ["--syslog"], defaultValue = "OFF", fallbackValue = "INFO",
description = [
"When specified without arguments, start sending syslog messages at INFO level.",
"If absent, no messages are sent to syslog.",
"Optionally specify a severity value. Valid values: \${COMPLETION-CANDIDATES}."])
lateinit var syslogLevel: MyLogLevelAnother example use case is password options.
6.6.3. Optional Parameter Limitations
Be careful when defining commands that have both an option with an optional parameter and a positional parameter.
|
The picocli parser is "greedy" when it handles optional parameters: it looks at the value following the option name, and if that value is likely to be a parameter (not another option or subcommand) then it will process the value as a parameter for that option. This may not always be what you want. |
For example:
class Ambiguous {
@Parameters(description = "The file (required).")
File file;
@Option(names = "-x", arity = "0..1",
description = "Option with optional parameter")
String value;
}class Ambiguous {
@Parameters(description = ["The file (required)."])
lateinit var file: File
@Option(names = ["-x"], arity = "0..1",
description = ["Option with optional parameter"])
lateinit var value: String
}When -x VALUE is specified on the command line, this results in an error: Missing required parameter: <file>.
Users can use the end-of-options delimiter and disambiguate the input with
-x ‐‐ VALUE, but this may not be obvious to many users.
One idea is to show the end-of-options delimiter in the usage help.
Another idea is to make use of the IParameterPreprocessor Parser Plugin introduced with picocli 4.6.
An alternative is to avoid the use of optional parameters and use the default arity in this scenario to eliminate the ambiguity altogether.
7. Required Arguments
7.1. Required Options
Options can be marked required to make it mandatory for the user to specify them on the command line. When a required option is not specified, a MissingParameterException is thrown from the parse method. For example:
class MandatoryOption {
@Option(names = "-n", required = true, description = "mandatory number")
int number;
@Parameters
File[] files;
}class MandatoryOption {
@Option(names = ["-n"], required = true, description = ["mandatory number"])
var number = 0
@Parameters
lateinit var files: Array<File>
}The following command line arguments would result in an exception complaining that number is missing:
// invalid: missing option -n <command> file1 file2 file3
The following command line arguments would be accepted:
// valid: required option -n has a value <command> -n 123 file1 file2 file3
7.2. Required Parameters
Single-value @Parameters are always mandatory, because single-value positional parameters have arity = "1" by default.
The arity attribute can be used to make multi-value @Parameters mandatory:
class BothOptionAndParametersMandatory {
@Parameters(arity = "1..*", description = "at least one File")
File[] files;
@Option(names = "-n", required = true, description = "mandatory number")
int number;
}class BothOptionAndParametersMandatory {
@Parameters(arity = "1..*", description = ["at least one File"])
lateinit var files: Array<File>
@Option(names = ["-n"], required = true, description = ["mandatory number"])
var number = 0
}The following command line arguments would result in an exception complaining that files are missing:
// invalid: missing file parameters <command> -n 123
The following command line arguments would be accepted:
// valid: both required fields have a value <command> -n 123 file1
7.3. Options with an Optional Parameter
See Optional Values.
8. Argument Groups
Picocli 4.0 introduces a new @ArgGroup annotation and its ArgGroupSpec programmatic equivalent.
Argument Groups can be used to define:
-
mutually exclusive options
-
options that must co-occur (dependent options)
-
option sections in the usage help message
-
repeating composite arguments
To create a group using the annotations API, annotate a field or method with @ArgGroup.
The field’s type refers to the class containing the options and positional parameters in the group.
(For annotated interface methods this would be the return type, for annotated setter methods in a concrete class this would be the setter’s parameter type.)
Picocli will instantiate this class when needed to capture command line argument values in the @Option and @Parameters-annotated fields and methods of this class.
|
Inherited Options currently cannot be used in Argument Groups. Applications that want to reuse Argument Groups across subcommands need to use Mixins. See this example for sharing an Argument Group defining global options between subcommands. |
8.1. Mutually Exclusive Options
Annotate a field or method with @ArgGroup(exclusive = true) to create a group of mutually exclusive options and positional parameters. For example:
@Command(name = "exclusivedemo")
public class MutuallyExclusiveOptionsDemo {
@ArgGroup(exclusive = true, multiplicity = "1")
Exclusive exclusive;
static class Exclusive {
@Option(names = "-a", required = true) int a;
@Option(names = "-b", required = true) int b;
@Option(names = "-c", required = true) int c;
}
}@Command(name = "exclusivedemo")
class MutuallyExclusiveOptionsDemo {
@ArgGroup(exclusive = true, multiplicity = "1")
lateinit var exclusive: Exclusive
class Exclusive {
@Option(names = ["-a"], required = true) var a = 0
@Option(names = ["-b"], required = true) var b = 0
@Option(names = ["-c"], required = true) var c = 0
}
}The above example defines a command with mutually exclusive options -a, -b and -c.
The group itself has a multiplicity attribute that defines how many times the group may be specified within the command.
The default is multiplicity = "0..1", meaning that by default a group may be omitted or specified once.
In this example the group has multiplicity = "1", so the group must occur once: one of the exclusive options must occur on the command line.
The synopsis of this command is:
Usage: exclusivedemo (-a=<a> | -b=<b> | -c=<c>)
When one of the options in the group is matched, picocli creates an instance of the Exclusive class and assigns it to the @ArgGroup-annotated exclusive field.
Note that the options are defined as required = true; this means required within the group, not required within the command.
As of picocli 4.1.2, all options in an exclusive group are automatically considered required, even if they are not marked as required = true in the annotations. Applications using older versions of picocli should mark all options in exclusive groups as required.
|
Picocli will validate the arguments and throw a MutuallyExclusiveArgsException if multiple mutually exclusive arguments were specified. For example:
MutuallyExclusiveOptionsDemo example = new MutuallyExclusiveOptionsDemo();
CommandLine cmd = new CommandLine(example);
try {
cmd.parseArgs("-a=1", "-b=2");
} catch (MutuallyExclusiveArgsException ex) {
assert "Error: -a=<a>, -b=<b> are mutually exclusive (specify only one)"
.equals(ex.getMessage());
}val example = MutuallyExclusiveOptionsDemo()
val cmd = CommandLine(example)
try {
cmd.parseArgs("-a=1", "-b=2")
} catch (ex: MutuallyExclusiveArgsException) {
assert("Error: -a=<a>, -b=<b> are mutually exclusive (specify only one)" == ex.message)
}For the above group, only one of the options can be specified. Any other combination of options, or the absence of options, is invalid.
Picocli will not initialize the @ArgGroup-annotated field
if none of the group options is specified on the command line.
For optional groups (groups with multiplicity = "0..1" - the default) this means that the @ArgGroup-annotated field may remain null.
|
8.2. Mutually Dependent Options
8.2.1. Overview
Annotate a field or method with @ArgGroup(exclusive = false) to create a group of dependent options and positional parameters that must co-occur. For example:
@Command(name = "co-occur")
public class DependentOptionsDemo {
@ArgGroup(exclusive = false)
Dependent dependent;
static class Dependent {
@Option(names = "-a", required = true) int a;
@Option(names = "-b", required = true) int b;
@Option(names = "-c", required = true) int c;
}
}@Command(name = "co-occur")
class DependentOptionsDemo {
@ArgGroup(exclusive = false)
lateinit var dependent: Dependent
class Dependent {
@Option(names = ["-a"], required = true) var a = 0
@Option(names = ["-b"], required = true) var b = 0
@Option(names = ["-c"], required = true) var c = 0
}
}The above example defines a command with dependent options -a, -b and -c that must co-occur.
The group itself has a multiplicity attribute that defines how many times the group may be specified within the command.
In this example the group uses the default multiplicity, multiplicity = "0..1", meaning that the group may be omitted or specified once.
The synopsis of this command is:
Usage: co-occur [-a=<a> -b=<b> -c=<c>]
When the first option in the group is matched, picocli creates an instance of the Dependent class and assigns it to the @ArgGroup-annotated dependent field.
Note that the options are defined as required = true; this means required within the group, not required within the command.
Picocli will validate the arguments and throw a MissingParameterException if not all dependent arguments were specified. For example:
DependentOptionsDemo example = new DependentOptionsDemo();
CommandLine cmd = new CommandLine(example);
try {
cmd.parseArgs("-a=1", "-b=2");
} catch (MissingParameterException ex) {
assert "Error: Missing required argument(s): -c=<c>".equals(ex.getMessage());
}val example = DependentOptionsDemo()
val cmd = CommandLine(example)
try {
cmd.parseArgs("-a=1", "-b=2")
} catch (ex: MissingParameterException) {
assert("Error: Missing required argument(s): -c=<c>" == ex.message)
}
Picocli will not initialize the @ArgGroup-annotated field
if none of the group options is specified on the command line.
For optional groups (groups with multiplicity = "0..1" - the default) this means that the @ArgGroup-annotated field may remain null.
|
8.2.2. Non-Required Options in Mutually Dependent Groups
In mutually dependent groups it is possible to have one or more options that are not required. This is different from exclusive groups, where all options are always required.
It is useful to be able to define a co-occurring group as (-a -b [-c]) so that both -a -b -c and -a -b are valid on the command line, but not -a -c for example.
This can be implemented by marking the optional option with required = false, as in the below example:
@Command(name = "co-occur-with-optional-options")
public class DependentWithOptionalOptionsDemo {
@ArgGroup(exclusive = false, multiplicity = "1")
DependentWithOptionalOptions group;
static class DependentWithOptionalOptions {
@Option(names = "-a", required = true) int a;
@Option(names = "-b", required = true) int b;
@Option(names = "-c", required = false) int c;
}
}@Command(name = "co-occur-with-optional-options")
class DependentWithOptionalOptionsDemo {
@ArgGroup(exclusive = false, multiplicity = "1")
lateinit var group: DependentWithOptionalOptions
class DependentWithOptionalOptions {
@Option(names = ["-a"], required = true) var a = 0
@Option(names = ["-b"], required = true) var b = 0
@Option(names = ["-c"], required = false) var c = 0
}
}More than one option can be optional in mutually dependent groups, but it is recommended to have at least one required option in the group (or there is not much point in using a mutually dependent group).
8.3. Option Sections in Usage Help
8.3.1. Use Heading to Enable Option Sections
The example below uses groups to define options sections in the usage help.
When a group has a non-null heading (or headingKey), the options in the group are given the specified heading in the usage help message.
The headingKey attribute can be used to get the heading text from the command’s resource bundle.
This works for mutually exclusive or co-occurring groups, but it is also possible to define a group that does no validation but only creates an option section in the usage help.
Annotate a field or method with @ArgGroup(validate = false) to create a group for display purposes only. For example:
@Command(name = "sectiondemo", description = "Section demo")
public class OptionSectionDemo {
@ArgGroup(validate = false, heading = "This is the first section%n")
Section1 section1;
static class Section1 {
@Option(names = "-a", description = "Option A") int a;
@Option(names = "-b", description = "Option B") int b;
@Option(names = "-c", description = "Option C") int c;
}
@ArgGroup(validate = false, heading = "This is the second section%n")
Section2 section2;
static class Section2 {
@Option(names = "-x", description = "Option X") int x;
@Option(names = "-y", description = "Option Y") int y;
@Option(names = "-z", description = "Option Z") int z;
}
public static void main(String[] args) {
new CommandLine(new OptionSectionDemo()).usage(System.out);
}
}@Command(name = "sectiondemo", description = ["Section demo"])
class OptionSectionDemo {
@ArgGroup(validate = false, heading = "This is the first section%n")
lateinit var section1: Section1
class Section1 {
@Option(names = ["-a"], description = ["Option A"]) var a = 0
@Option(names = ["-b"], description = ["Option B"]) var b = 0
@Option(names = ["-c"], description = ["Option C"]) var c = 0
}
@ArgGroup(validate = false, heading = "This is the second section%n")
lateinit var section2: Section2
class Section2 {
@Option(names = ["-x"], description = ["Option X"]) var x = 0
@Option(names = ["-y"], description = ["Option Y"]) var y = 0
@Option(names = ["-z"], description = ["Option Z"]) var z = 0
}
}
fun main(args: Array<String>) {
CommandLine(OptionSectionDemo()).usage(System.out)
}This prints the following usage help message:
Usage: sectiondemo [-a=<a>] [-b=<b>] [-c=<c>] [-x=<x>] [-y=<y>] [-z=<z>] Section demo This is the first section -a=<a> Option A -b=<b> Option B -c=<c> Option C This is the second section -x=<x> Option X -y=<y> Option Y -z=<z> Option Z
Note that the heading text must end with %n to insert a newline between the heading text and the first option.
This is for consistency with other headings in the usage help, like @Command(headerHeading = "Usage:%n", optionListHeading = "%nOptions:%n").
Picocli will not initialize the @ArgGroup-annotated field
if none of the group options is specified on the command line.
For optional groups (groups with multiplicity = "0..1" - the default) this means that the @ArgGroup-annotated field may remain null.
|
8.3.2. Option Section Order
Options that are not in any argument group are always displayed before any group option sections.
The ordering of group option sections can be controlled with the order attribute. For example:
@ArgGroup(heading = "First%n", order = 1) Section1 section1;
@ArgGroup(heading = "Next%n", order = 2) Section2 section2;
@ArgGroup(heading = "Last%n", order = 3) Section3 section3;@ArgGroup(heading = "First%n", order = 1) lateinit var section1: Section1
@ArgGroup(heading = "Next%n", order = 2) lateinit var section2: Section2
@ArgGroup(heading = "Last%n", order = 3) lateinit var section3: Section38.3.3. Validation Trade-offs
Note that setting validate = false means that picocli won’t validate user input for the group.
For example, even for groups with multiplicity = 1, when the end user specifies the group multiple times, no error is shown.
If the group is a single-value field, only the last occurrence is stored and previous occurrences are silently dropped.
If validation is needed, the recommendation is to make the field holding the group a collection, and doing Custom Validation. For example to ensure that this collection holds only a single element:
@ArgGroup(validate = false, heading = "This is the first section%n", multiplicity = "0..1")
private List<Section1> section1List = new ArrayList<>();
@Spec CommandSpec spec;
// validate in the business logic
public void run() {
if (section1List.size() > 1) {
throw new ParameterException(spec.commandLine(),
"Group [-a=<a>] [-b=<b>] [-c=<c>] can be specified at most once.");
}
// remaining business logic...
}8.4. Repeating Composite Argument Groups
The below example shows how groups can be composed of other groups, and how arrays and collections can be used to capture repeating groups (with a multiplicity greater than one):
@Command(name = "repeating-composite-demo")
public class CompositeGroupDemo {
@ArgGroup(exclusive = false, multiplicity = "1..*")
List<Composite> composites;
static class Composite {
@ArgGroup(exclusive = false, multiplicity = "0..1")
Dependent dependent;
@ArgGroup(exclusive = true, multiplicity = "1")
Exclusive exclusive;
}
static class Dependent {
@Option(names = "-a", required = true) int a;
@Option(names = "-b", required = true) int b;
@Option(names = "-c", required = true) int c;
}
static class Exclusive {
@Option(names = "-x", required = true) boolean x;
@Option(names = "-y", required = true) boolean y;
@Option(names = "-z", required = true) boolean z;
}
}@Command(name = "repeating-composite-demo")
class CompositeGroupDemo {
@ArgGroup(exclusive = false, multiplicity = "1..*") lateinit var composites: List<Composite>
class Composite {
@ArgGroup(exclusive = false, multiplicity = "0..1")
lateinit var dependent: Dependent
@ArgGroup(exclusive = true, multiplicity = "1")
lateinit var exclusive: Exclusive
}
class Dependent {
@Option(names = ["-a"], required = true) var a = 0
@Option(names = ["-b"], required = true) var b = 0
@Option(names = ["-c"], required = true) var c = 0
}
class Exclusive {
@Option(names = ["-x"], required = true) var x = false
@Option(names = ["-y"], required = true) var y = false
@Option(names = ["-z"], required = true) var z = false
}
}In the above example, the annotated composites field defines a composite group that must be specified at least once, and may be specified many times (multiplicity = "1..*"), on the command line. Notice that for multi-value groups the type of the @ArgGroup-annotated field must be a collection or an array to capture the multiple Composite instances that hold the values that were matched on the command line.
The synopsis of this command is:
Usage: repeating-composite-demo ([-a=<a> -b=<b> -c=<c>] (-x | -y | -z))...
Each time the group is matched, picocli creates an instance of the Composite class and adds it to the composites list.
The Composite class itself contains two groups: an optional (multiplicity = "0..1") group of dependent options that must co-occur, and another group of mutually exclusive options, which is mandatory (multiplicity = "1").
The below example illustrates:
CompositeGroupDemo example = new CompositeGroupDemo();
CommandLine cmd = new CommandLine(example);
cmd.parseArgs("-x", "-a=1", "-b=1", "-c=1", "-a=2", "-b=2", "-c=2", "-y");
assert example.composites.size() == 2;
Composite c1 = example.composites.get(0);
assert c1.exclusive.x;
assert c1.dependent.a == 1;
assert c1.dependent.b == 1;
assert c1.dependent.c == 1;
Composite c2 = example.composites.get(1);
assert c2.exclusive.y;
assert c2.dependent.a == 2;
assert c2.dependent.b == 2;
assert c2.dependent.c == 2;val example = CompositeGroupDemo()
val cmd = CommandLine(example)
cmd.parseArgs("-x", "-a=1", "-b=1", "-c=1", "-a=2", "-b=2", "-c=2", "-y")
assert(example.composites.size == 2)
val c1 = example.composites[0]
assert(c1.exclusive.x)
assert(c1.dependent.a === 1)
assert(c1.dependent.b === 1)
assert(c1.dependent.c === 1)
val c2 = example.composites[1]
assert(c2.exclusive.y)
assert(c2.dependent.a === 2)
assert(c2.dependent.b === 2)
assert(c2.dependent.c === 2)|
Picocli will not initialize the |
8.5. Default Values in Argument Groups
The default values of options in an argument group are applied when at least one option in the group is matched on the command line and picocli instantiates the user object of the group.
Picocli will not initialize the @ArgGroup-annotated field (and so no default values are applied) if none of the group options is specified on the command line.
8.5.1. Showing Default Values in Group Usage Help
Options used in argument groups should define default values via the @Option(defaultValue = "…") annotation.
When default values are defined in the annotation, the ${DEFAULT-VALUE} variable can be used to show the default value in the description of options in an argument group. For example:
class GoodGroup {
@Option(names = "-x", defaultValue = "123", description = "Default: ${DEFAULT-VALUE}")
int x;
}
@Command(name = "good", description = "usage help shows the default value")
class GoodExample {
@ArgGroup GoodGroup goodGroup;
public static void main(String[] args) {
new CommandLine(new GoodExample()).usage(System.out);
}
}class GoodGroup {
@Option(names = ["-x"], defaultValue = "123", description = ["Default: \${DEFAULT-VALUE}"])
var x = 0
}
@Command(name = "good", description = ["usage help shows the default value"])
class GoodExample {
@ArgGroup
lateinit var goodGroup: GoodGroup
}
fun main(args: Array<String>) {
CommandLine(GoodExample()).usage(System.out)
}When the default value is defined in the annotation, the usage help shows the correct default value:
Usage: good [[-x=<x>]] usage help shows the default value -x=<x> Default: 123
|
Picocli will not be able to retrieve the default values that are defined by assigning a value in the declaration of an Java
Kotlin
When the default value is defined in the field declaration and not in the annotation, usage help for the options in the group incorrectly shows Usage: bad [[-x=<x>]] usage help shows the wrong default value -x=<x> Default: null |
8.5.2. Assigning Default Values in Argument Groups
Applications need to do extra work for argument group options with default values. Picocli does not instantiate the group if none of the options in the group is specified on the command line, so applications need to do this manually.
Below are some recommendations for using default values in argument group options and positional parameters:
-
specify default values in both the
@Optionannotation, and in the initial value of the@Option-annotated field. Yes, that means some duplication. This recommendation also holds for positional@Parameters. -
the application needs to manually instantiate the
@ArgGroup-annotated field. More details follow below.
The default value in the @Option or @Parameters annotation means that picocli can show the default value in the usage help, and the initial value means that any new instance of the group that contains the option will already have the default value assigned to that option field.
The example below shows an option that defines the default value in the annotation as well as in the initial value of the field:
class MyGroup {
// (group options):
// specify default values both in the annotation and in the initial value
@Option(names = "-x", defaultValue = "XX")
String x = "XX"; // yes, some duplication :-(
}class MyGroup {
// (group options):
// specify default values both in the annotation and in the initial value
@Option(names = "-x", defaultValue = "XX")
var x = "XX"; // yes, some duplication :-(
}Next, the application needs to manually instantiate the @ArgGroup-annotated field.
There is a trade-off:
-
instantiating the
@ArgGroup-annotated field in the declaration is simple and short but applications cannot easily detect whether a group option was specified on the command line or not -
leaving the
@ArgGroup-annotated fieldnullin the declaration allows applications to easily detect whether a group option was specified on the command line, but is a bit more code
The example below shows the first idea: instantiating the group object in the declaration.
This way, the group object is never null and (if you followed the previous recommendation) all option fields in this group object will have the default value as their initial value.
// instantiating the group in the declaration:
// all options in this group now also have their initial (default) value
@ArgGroup MyGroup myGroup = new MyGroup();// instantiating the group in the declaration:
// all options in this group now also have their initial (default) value
@ArgGroup var myGroup = MyGroup();Alternatively, applications can initialize the group objects in the business logic: in the run or call method.
This allows the application to determine whether the user specified a value for any of the options in the group.
The example below demonstrates initializing the group objects in the business logic:
@Command(name = "group-default-demo")
class MyApp implements Runnable {
@ArgGroup Outer outer; // no initial value
static class Outer {
@Option(names = "-x", defaultValue = "XX") String x = "XX";
@ArgGroup(exclusive = true)
Inner inner; // no initial value
}
static class Inner {
@Option(names = "-a", defaultValue = "AA") String a = "AA";
@Option(names = "-b", defaultValue = "BB") String b = "BB";
}
public void run() {
if (outer == null) { // -x option was not specified on command line
// perform any logic that needs to happen if -x is missing
outer = new Outer(); // assign default values
}
if (outer.inner == null) { // neither -a nor -b was specified
// perform any logic that needs to happen if -a or -b is missing
outer.inner = new Inner(); // assign defaults for inner group
}
// remaining business logic...
}
}@Command(name = "group-default-demo")
class MyApp : Runnable {
@ArgGroup lateinit var outer: Outer // no initial value
class Outer {
@Option(names = "-x", defaultValue = "XX") var x = "XX";
@ArgGroup(exclusive = true)
lateinit var inner: Inner // no initial value
}
class Inner {
@Option(names = "-a", defaultValue = "AA") var a = "AA";
@Option(names = "-b", defaultValue = "BB") var b = "BB";
}
override fun run() {
if (outer == null) { // -x option was not specified on command line
// perform any logic that needs to happen if -x is missing
outer = Outer(); // assign default values
}
if (outer.inner == null) { // neither -a nor -b was specified
// perform any logic that needs to happen if -a or -b is missing
outer.inner = Inner(); // assign defaults for inner group
}
// remaining business logic...
}
}8.6. Positional Parameters
When a @Parameters positional parameter is part of a group, its index is the index within the group, not within the command.
Below is an example of an application that uses a repeating group of positional parameters:
@Command(name = "grades", mixinStandardHelpOptions = true, version = "grades 1.0")
public class Grades implements Runnable {
static class StudentGrade {
@Parameters(index = "0") String name;
@Parameters(index = "1") BigDecimal grade;
}
@ArgGroup(exclusive = false, multiplicity = "1..*")
List<StudentGrade> gradeList;
@Override
public void run() {
gradeList.forEach(e -> System.out.println(e.name + ": " + e.grade));
}
public static void main(String[] args) {
System.exit(new CommandLine(new Grades()).execute(args));
}
}@Command(name = "grades", mixinStandardHelpOptions = true, version = ["grades 1.0"])
class Grades : Runnable {
class StudentGrade {
@Parameters(index = "0") lateinit var name: String
@Parameters(index = "1") lateinit var grade: BigDecimal
}
@ArgGroup(exclusive = false, multiplicity = "1..*")
lateinit var gradeList: List<StudentGrade>
override fun run() {
gradeList.forEach { e -> println("${e.name}: ${e.grade}") }
}
}
fun main(args: Array<String>) {
System.exit(CommandLine(Grades()).execute(*args))
}Running the above program with this input:
Alice 3.1 Betty 4.0 "X Æ A-12" 3.5 Zaphod 3.4
Produces the following output:
Alice: 3.1 Betty: 4.0 X Æ A-12: 3.5 Zaphod: 3.4
8.7. Argument Group Limitations
-
Options with the same name cannot be defined in multiple groups. Similarly, it is not possible to define an option outside of a group with the same name as a different option that is part of a group.
-
Positional parameters in a single group work fine, but take care (or avoid) defining positional parameters in multiple groups or positional parameters in a group as well as outside a group. Positional parameters are matched by index, and while the index of a group is reset when a new group multiple is encountered, the index of positional parameters outside a group only increases and is never reset.
-
Some relationships between options cannot be expressed with picocli argument groups. In general, picocli argument groups can only express relationship for which you can write a command line synopsis with every option occurring only once. For example, it is not possible to use argument groups to create a relationship with exclusive options
[-a | -b], where-arequires another option-c:[[-a] -c], while at the same time-bis independent of-c:[-b] [-c]. The application may need to do some programmatic validation in such cases.
9. Executing Commands
Parsing the command line arguments is the first step. A robust real-world application needs to handle a number of scenarios:
-
User input was invalid
-
User requested usage help (potentially for a subcommand)
-
User requested version help (potentially for a subcommand)
-
None of the above: we can run the business logic (potentially for a subcommand)
-
The business logic may throw an exception
Picocli 4.0 introduces an execute method for handling all of the above scenarios in a single line of code. For example:
new CommandLine(new MyApp()).execute(args);CommandLine(MyApp()).execute(*args)With the execute method, application code can be extremely compact:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Command(name = "myapp", mixinStandardHelpOptions = true, version = "1.0")
class MyApp implements Callable<Integer> {
@Option(names = "-x") int x;
@Override
public Integer call() { // business logic
System.out.printf("x=%s%n", x);
return 123; // exit code
}
public static void main(String... args) { // bootstrap the application
System.exit(new CommandLine(new MyApp()).execute(args));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Command(name = "myapp", mixinStandardHelpOptions = true, version = ["1.0"])
class MyApp : Callable<Int> {
@Option(names = ["-x"])
var x = 0
override fun call(): Int { // business logic
println("x=$x")
return 123 // exit code
}
}
fun main(args: Array<String>) { // bootstrap the application
exitProcess(CommandLine(MyApp()).execute(*args))
}
Despite being only 15 lines long, this is a full-fledged application, with --help and --version options in addition to the -x option.
The execute method will show the usage help or version information if requested by the user, and invalid user input will result
in a helpful error message. If the user input was valid, the business logic is invoked.
Finally, the execute method returns an exit status code that can be used to call System.exit if desired.
A command is executable if its user object implements Runnable or Callable, or is a @Command-annotated Method. Examples follow below.
|
The execute method replaces the older run, call, invoke and parseWithHandlers methods.
|
The DIY Command Execution section shows an example of the boilerplate code that can be omitted with the execute method.
9.1. Exit Code
Many command line applications return an exit code to signify success or failure. Zero often means success, a non-zero exit code is often used for errors, but other than that, meanings differ per application.
The CommandLine.execute method introduced in picocli 4.0 returns an int, and applications can use this return value to call System.exit if desired. For example:
public static void main(String... args) {
int exitCode = new CommandLine(new MyApp()).execute(args);
System.exit(exitCode);
}fun main(args: Array<String>) {
val exitCode = CommandLine(MyApp()).execute(*args)
exitProcess(exitCode)
}
Older versions of picocli had some limited exit code support where picocli would call System.exit, but this is now deprecated.
|
9.2. Generating an Exit Code
@Command-annotated classes that implement Callable and @Command-annotated methods can simply return an int or Integer, and this value will be returned from CommandLine.execute. For example:
@Command(name = "greet")
class Greet implements Callable<Integer> {
public Integer call() {
System.out.println("hi");
return 1;
}
// define a "shout" subcommand with a @Command-annotated method
@Command
int shout() {
System.out.println("HI!");
return 2;
}
}
assert 1 == new CommandLine(new Greet()).execute();
assert 2 == new CommandLine(new Greet()).execute("shout");@Command(name = "greet")
class Greet : Callable<Int> {
override fun call(): Int {
println("hi")
return 1
}
// define a "shout" subcommand with a @Command-annotated method
@Command
fun shout(): Int {
println("HI!")
return 2
}
}
assert(1 == CommandLine(Greet()).execute())
assert(2 == CommandLine(Greet()).execute("shout"))Commands with a user object that implements Runnable can implement the IExitCodeGenerator interface to generate an exit code. For example:
@Command(name = "wave")
class Gesture implements Runnable, IExitCodeGenerator {
@Override public void run() {
System.out.println("wave");
}
@Override public int getExitCode() {
return 3;
}
}
assert 3 == new CommandLine(new Gesture()).execute();@Command(name = "wave")
class Gesture : Runnable, IExitCodeGenerator {
override fun run() {
println("wave")
}
override fun getExitCode(): Int {
return 3
}
}
assert(3 == CommandLine(Gesture()).execute())9.3. Exception Exit Codes
By default, the execute method returns CommandLine.ExitCode.OK (0) on success, CommandLine.ExitCode.SOFTWARE (1) when an exception occurred in the Runnable, Callable or command method, and CommandLine.ExitCode.USAGE (2) for invalid input. (These are common values according to this StackOverflow answer). This can be customized with the @Command annotation. For example:
@Command(exitCodeOnInvalidInput = 123,
exitCodeOnExecutionException = 456)Additionally, applications can configure a IExitCodeExceptionMapper to map a specific exception to an exit code:
class MyMapper implements IExitCodeExceptionMapper {
@Override
public int getExitCode(Throwable t) {
if (t instanceof FileNotFoundException) {
return 74;
}
return 1;
}
}class MyMapper : IExitCodeExceptionMapper {
override fun getExitCode(t: Throwable): Int {
return if (t is FileNotFoundException) {
74
} else 1
}
}When the end user specified invalid input, the execute method prints an error message followed by the usage help message of the command, and returns an exit code. This can be customized by configuring an IParameterExceptionHandler.
If the business logic of the command throws an exception, the execute method prints the stack trace of the exception and returns an exit code. This can be customized by configuring an IExecutionExceptionHandler.
9.4. Usage Help Exit Code Section
By default, the usage help message does not include exit code information.
Applications that call System.exit need to configure the usage help message to show exit code details,
either with the exitCodeListHeading and exitCodeList annotation attributes,
or programmatically by calling UsageMessageSpec.exitCodeListHeading and UsageMessageSpec.exitCodeList.
See Exit Code List for details.
9.5. Execution Configuration
The following methods can be used to configure the behaviour of the execute method:
-
get/setOut
-
get/setErr
-
get/setColorScheme - see Color Scheme example
-
get/setExecutionStrategy - see Initialization Before Execution example
-
get/setParameterExceptionHandler - see Invalid User Input example
-
get/setExecutionExceptionHandler - see Business Logic Exceptions example
-
get/setExitCodeExceptionMapper
The above methods are not applicable with (and ignored by) other entry points like parse, parseArgs, populateCommand, run, call, invoke, parseWithHandler and parseWithHandlers.
|
9.6. Migration
Older versions of picocli supported run, call, invoke and parseWithHandlers convenience methods that were similar to execute but had limited support for parser configuration and limited support for exit codes.
These methods are deprecated from picocli 4.0.
The sections below show some common usages and how the same can be achieved with the execute API.
9.6.1. Customizing Output Streams and ANSI settings
Before:
PrintStream out = // output stream for user-requested help
PrintStream err = // output stream for error messages
Ansi ansi = // to use ANSI colors and styles or not
CommandLine.run(new MyRunnable(), out, err, ansi, args);val out: PrintStream = // output stream for user-requested help
val err: PrintStream = // output stream for error messages
val ansi: Ansi = // to use ANSI colors and styles or not
CommandLine.run(MyRunnable(), out, err, ansi, *args)After:
PrintWriter out = // output stream for user-requested help
PrintWriter err = // output stream for error messages
Ansi ansi = // to use ANSI colors and styles or not
CommandLine cmd = new CommandLine(new MyRunnable())
.setOut(out);
.setErr(err);
.setColorScheme(Help.defaultColorScheme(ansi));
int exitCode = cmd.execute(args);var out: PrintWriter = // output stream for user-requested help
var err: PrintWriter = // output stream for error messages
val ansi: Ansi = // to use ANSI colors and styles or not
val cmd = CommandLine(MyRunnable())
.setOut(out)
.setErr(err)
.setColorScheme(Help.defaultColorScheme(ansi));
val exitCode = cmd.execute(*args)9.6.2. Return Value from Callable or Method
Before:
class MyCallable implements Callable<MyResult> {
public MyResult call() { /* ... */ }
}
MyResult result = CommandLine.call(new MyCallable(), args);class MyCallable : Callable<MyResult> {
override fun call(): MyResult { /* ... */ }
}
val result: MyResult = CommandLine.call(MyCallable(), *args)After:
CommandLine cmd = new CommandLine(new MyCallable());
int exitCode = cmd.execute(args);
MyResult result = cmd.getExecutionResult();val cmd = CommandLine(MyCallable())
val exitCode = cmd.execute(*args)
val result: MyResult = cmd.getExecutionResult()9.6.3. Invoking Command Methods
Before:
class MyCommand {
@Command
public MyResult doit(@Option(names = "-x") int x) { ... }
}
MyResult result = CommandLine.invoke("doit", MyCommand.class, args);class MyCommand {
@Command
fun doit(@Option(names = ["-x"]) x: Int) : MyResult{ /* ... */ }
}
val result = CommandLine.invoke("doit", MyCommand::class.java, *args) as MyResultAfter:
Method doit = CommandLine.getCommandMethods(MyCommand.class, "doit").get(0);
CommandLine cmd = new CommandLine(doit);
int exitCode = cmd.execute(args);
MyResult result = cmd.getExecutionResult();val doit: Method = CommandLine.getCommandMethods(MyCommand::class.java, "doit")[0]
val cmd = CommandLine(doit)
val exitCode = cmd.execute(*args)
val result: MyResult = cmd.getExecutionResult()9.6.4. Executing Commands with Subcommands
The IParseResultHandler2 interface has been deprecated in picocli 4.0 in favor of IExecutionStrategy. The existing built-in handlers RunLast, RunAll and RunFirst implement the IExecutionStrategy interface and can still be used:
-
the
RunLasthandler prints help if requested, and otherwise gets the last specified command or subcommand and tries to execute it as aRunnable,CallableorMethod. This is the default execution strategy. -
the
RunFirsthandler prints help if requested, and otherwise executes the top-level command as aRunnable,CallableorMethod -
the
RunAllhandler prints help if requested, and otherwise executes all commands and subcommands that the user specified on the command line asRunnable,CallableorMethodtasks
Before
CommandLine cmd = new CommandLine(MyTopLevelCommand())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("add", new GitAdd());
List<Object> result = cmd.parseWithHandler(new RunAll(), args);val cmd = CommandLine(MyTopLevelCommand())
.addSubcommand("status", GitStatus())
.addSubcommand("commit", GitCommit())
.addSubcommand("add", GitAdd())
val result = cmd.parseWithHandler<List<Any>>(CommandLine.RunAll(), args)}After
CommandLine cmd = new CommandLine(MyTopLevelCommand())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("add", new GitAdd());
// the default is RunLast, this can be customized:
cmd.setExecutionStrategy(new RunAll());
int exitCode = cmd.execute(args);val cmd = CommandLine(MyTopLevelCommand())
.addSubcommand("status", GitStatus())
.addSubcommand("commit", GitCommit())
.addSubcommand("add", GitAdd())
// the default is RunLast, this can be customized:
cmd.executionStrategy = RunAll()
val exitCode = cmd.execute(*args)The ParseResult can be used to get the return value from a Callable or Method subcommand:
// getting return value from Callable or Method command
Object topResult = cmd.getExecutionResult();
// getting return value from Callable or Method subcommand
ParseResult parseResult = cmd.getParseResult();
if (parseResult.subcommand() != null) {
CommandLine sub = parseResult.subcommand().commandSpec().commandLine();
Object subResult = sub.getExecutionResult();
}// getting return value from Callable or Method command
val topResult: Int = cmd.getExecutionResult()
// getting return value from Callable or Method subcommand
val parseResult = cmd.parseResult
if (parseResult.subcommand() != null) {
val sub: CommandLine = parseResult.subcommand().commandSpec().commandLine()
val subResult = sub.getExecutionResult<Int>()
}9.7. DIY Command Execution
Alternatively, applications may want to use the parseArgs method directly and write their own "Do It Yourself" command execution logic.
The example below covers the following common scenarios:
-
Handle invalid user input, and report any problems to the user (potentially suggesting alternative options and subcommands for simple typos if we want to get fancy).
-
Check if the user requested usage help, and print this help and abort processing if this was the case.
-
Check if the user requested version information, and print this information and abort processing if this was the case.
-
If none of the above, run the business logic of the application.
-
Handle any errors that occurred in the business logic.
Callable<Object> callable = new MyCallable();
CommandLine cmd = new CommandLine(callable);
try {
ParseResult parseResult = cmd.parseArgs(args);
// Did user request usage help (--help)?
if (cmd.isUsageHelpRequested()) {
cmd.usage(cmd.getOut());
return cmd.getCommandSpec().exitCodeOnUsageHelp();
// Did user request version help (--version)?
} else if (cmd.isVersionHelpRequested()) {
cmd.printVersionHelp(cmd.getOut());
return cmd.getCommandSpec().exitCodeOnVersionHelp();
}
// invoke the business logic
Object result = callable.call();
cmd.setExecutionResult(result);
return cmd.getCommandSpec().exitCodeOnSuccess();
// invalid user input: print error message and usage help
} catch (ParameterException ex) {
cmd.getErr().println(ex.getMessage());
if (!UnmatchedArgumentException.printSuggestions(ex, cmd.getErr())) {
ex.getCommandLine().usage(cmd.getErr());
}
return cmd.getCommandSpec().exitCodeOnInvalidInput();
// exception occurred in business logic
} catch (Exception ex) {
ex.printStackTrace(cmd.getErr());
return cmd.getCommandSpec().exitCodeOnExecutionException();
}val callable: Callable<Int> = MyCallable()
val cmd = CommandLine(callable)
return try {
val parseResult = cmd.parseArgs(*args)
// Did user request usage help (--help)?
if (cmd.isUsageHelpRequested) {
cmd.usage(cmd.out)
cmd.commandSpec.exitCodeOnUsageHelp()
// Did user request version help (--version)?
} else if (cmd.isVersionHelpRequested) {
cmd.printVersionHelp(cmd.out)
return cmd.commandSpec.exitCodeOnVersionHelp()
}
// invoke the business logic
val result = callable.call()
cmd.setExecutionResult(result)
cmd.commandSpec.exitCodeOnSuccess()
// invalid user input: print error message and usage help
} catch (ex: ParameterException) {
cmd.err.println(ex.message)
if (!UnmatchedArgumentException.printSuggestions(ex, cmd.err)) {
ex.commandLine.usage(cmd.err)
}
cmd.commandSpec.exitCodeOnInvalidInput()
// exception occurred in business logic
} catch (ex: Exception) {
ex.printStackTrace(cmd.err)
cmd.commandSpec.exitCodeOnExecutionException()
}The CommandLine.execute method is equivalent to the above, and additionally handles subcommands correctly.
9.8. Handling Errors
Internally, the execute method parses the specified user input and populates the options and positional parameters defined by the annotations.
When the user specified invalid input, this is handled by the IParameterExceptionHandler.
After parsing the user input, the business logic of the command is invoked: the run, call or @Command-annotated method.
When an exception is thrown by the business logic, this is handled by the IExecutionExceptionHandler.
In most cases, the default handlers are sufficient, but the sections below show how they can be customized.
9.8.1. Invalid User Input
When the user specified invalid input, the parser throws a ParameterException.
In the execute method, such exceptions are caught and passed to the IParameterExceptionHandler.
The default parameter exception handler prints an error message describing the problem, followed by either suggested alternatives for mistyped options, or the full usage help message of the problematic command. Finally, the handler returns an exit code. This is sufficient for most applications.
Sometimes you want to display a shorter message. For example, the grep utility does not show the full usage help when it gets an invalid argument:
$ grep -d recurese "ERROR" logs/* Error: invalid argument ‘recurese’ for ‘--directories’ Valid arguments are: - ‘read’ - ‘recurse’ - ‘skip’ Usage: grep [OPTION]... PATTERN [FILE]... Try 'grep --help' for more information.
You can customize how your application handles invalid user input by setting a custom IParameterExceptionHandler:
new CommandLine(new MyApp())
.setParameterExceptionHandler(new ShortErrorMessageHandler())
.execute(args);CommandLine(MyApp())
.setParameterExceptionHandler(ShortErrorMessageHandler())
.execute(*args)Where the IParameterExceptionHandler implementation could be something like this:
class ShortErrorMessageHandler implements IParameterExceptionHandler {
public int handleParseException(ParameterException ex, String[] args) {
CommandLine cmd = ex.getCommandLine();
PrintWriter err = cmd.getErr();
// if tracing at DEBUG level, show the location of the issue
if ("DEBUG".equalsIgnoreCase(System.getProperty("picocli.trace"))) {
err.println(cmd.getColorScheme().stackTraceText(ex));
}
err.println(cmd.getColorScheme().errorText(ex.getMessage())); // bold red
UnmatchedArgumentException.printSuggestions(ex, err);
err.print(cmd.getHelp().fullSynopsis());
CommandSpec spec = cmd.getCommandSpec();
err.printf("Try '%s --help' for more information.%n", spec.qualifiedName());
return cmd.getExitCodeExceptionMapper() != null
? cmd.getExitCodeExceptionMapper().getExitCode(ex)
: spec.exitCodeOnInvalidInput();
}
}class ShortErrorMessageHandler : IParameterExceptionHandler {
override fun handleParseException(ex: ParameterException, args: Array<String>): Int {
val cmd = ex.commandLine
val err = cmd.err
// if tracing at DEBUG level, show the location of the issue
if ("DEBUG".equals(System.getProperty("picocli.trace"), ignoreCase = true)) {
err.println(cmd.colorScheme.stackTraceText(ex))
}
err.println(cmd.colorScheme.errorText(ex.message)) // bold red
UnmatchedArgumentException.printSuggestions(ex, err)
err.print(cmd.help.fullSynopsis())
val spec = cmd.commandSpec
err.print("Try '${spec.qualifiedName()} --help' for more information.%n")
return if (cmd.exitCodeExceptionMapper != null)
cmd.exitCodeExceptionMapper.getExitCode(ex)
else spec.exitCodeOnInvalidInput()
}
}9.8.2. Business Logic Exceptions
When the business logic throws an exception, this exception is caught and passed to the IExecutionExceptionHandler.
The default execution exception handling results in the stack trace of the exception being printed and an exit code being returned. This is sufficient for most applications.
If you have designed your business logic to throw exceptions with user-facing error messages, you want to print this error message instead of the stack trace.
This can be accomplished by installing a custom IExecutionExceptionHandler, like this:
new CommandLine(new MyApp())
.setExecutionExceptionHandler(new PrintExceptionMessageHandler())
.execute(args);CommandLine(MyApp())
.setExecutionExceptionHandler(PrintExceptionMessageHandler())
.execute(*args)Where the IExecutionExceptionHandler implementation could look something like this:
class PrintExceptionMessageHandler implements IExecutionExceptionHandler {
public int handleExecutionException(Exception ex,
CommandLine cmd,
ParseResult parseResult) {
// bold red error message
cmd.getErr().println(cmd.getColorScheme().errorText(ex.getMessage()));
return cmd.getExitCodeExceptionMapper() != null
? cmd.getExitCodeExceptionMapper().getExitCode(ex)
: cmd.getCommandSpec().exitCodeOnExecutionException();
}
}class PrintExceptionMessageHandler : IExecutionExceptionHandler {
override fun handleExecutionException(ex: Exception,
cmd: CommandLine,
parseResult: ParseResult): Int {
// bold red error message
cmd.err.println(cmd.colorScheme.errorText(ex.message))
return if (cmd.exitCodeExceptionMapper != null)
cmd.exitCodeExceptionMapper.getExitCode(ex)
else cmd.commandSpec.exitCodeOnExecutionException()
}
}9.9. Rare Use Cases
The CommandLine::execute method is the recommended way to execute your command line application, as it provides configurable exception handling, handles user requests for usage help or version information, results in short and simple application code, and never throws an exception.
However, there may be use cases for which the execute method is not a good match.
The alternative is to use CommandLine::parseArgs and handle the resulting ParseResult object in your application.
The DIY Command Execution section shows what is involved in doing so.
The parseArgs method may be useful when writing parser test code, or when your application’s main method is called by another application. The following sections go into some detail.
9.9.1. Parser Test Code Example
The parseArgs method is useful in test code that only exercises the parsing logic, without involving the business logic.
For example:
MyApp app = new MyApp();
new CommandLine(app).parseArgs("--some --options and parameters".split(" "));
assertTrue(app.some);MyApp app = new MyApp()
new CommandLine(app).parseArgs('--some --options and parameters'.split(' '))
assert app.some9.9.2. Percolating Exceptions Up
The execute method never throws an exception, and for some applications this is undesirable.
The parseArgs method can also be useful when the main method of your application is called by another application, and this other application is responsible for error handling.
An common use case is when your application is called as part of the build.
For example, Maven provides the exec-maven-plugin with exec:java goal, and Gradle similarly provides the Exec and JavaExec tasks.
The Maven exec:java goal invokes the target class in the same Maven process.
In this case, we don’t want to call System.exit, because it would stop the entire Maven process, and additionally, we want the exceptions thrown by the command line application to be handled by Maven.
One idea is to provide a separate main method that uses parseArgs instead of execute.
For example:
public class MyApp implements Callable {
/** Calls System.exit when called from the command line. */
public static void main(String... args) throws Exception {
System.exit(new CommandLine(new MyApp()).execute(args));
}
/**
* Nested helper class that can be used safely from the build tool:
* it does not call System.exit and it percolates exceptions up
* for handling by the caller.
*/
public static class NoSystemExit {
public static void main(String... args) throws Exception {
MyApp app = new MyApp();
ParseResult pr = new CommandLine(app).parseArgs(args);
if (CommandLine.executeHelpRequest(pr) != null) { return; } // help was requested
app.call(); // execute business logic, which may also throw an exception
}
}
//...Then, in the build configuration, invoke nested class MyApp.NoSystemExit instead of MyApp to let the build tool handle any exceptions and avoid calling System.exit.
9.9.3. System.exit or not?
An alternative to the above solution is to decide at runtime whether to call System.exit or not.
The example implementation below demonstrates how to use system properties to determine whether to call System.exit or not:
public static void main(String... args) {
int exitCode = new CommandLine(new App()).execute(args);
if ((exitCode == CommandLine.ExitCode.OK && exitOnSuccess())
|| (exitCode != CommandLine.ExitCode.OK && exitOnError())) {
System.exit(exitCode);
}
}
private static boolean exitOnSuccess() {
return syspropDefinedAndNotFalse("systemExitOnSuccess");
}
private static boolean exitOnError() {
return syspropDefinedAndNotFalse("systemExitOnError");
}
private static boolean syspropDefinedAndNotFalse(String key) {
String value = System.getProperty(key);
return value != null && !"false".equalsIgnoreCase(value);
}Picocli’s own Bash and ZSH completion script generator tool uses this method:
when this tool is called with a specific system property (picocli.autocomplete.systemExitOnError) it will call System.exit when an error occurs.
10. Validation
10.1. Built-in Validation
Picocli provides some limited form of validation:
-
options with one or more required parameters
-
allow/disallow single-value options being specified multiple times
-
mutually dependent options
-
mutually exclusive options
-
repeating groups of exclusive or dependent options
10.2. Custom Validation
Most applications will need to do additional validations to verify some business rules.
Applications that use the execute API may find it useful to throw a ParameterException when validation fails:
any ParameterExceptions will be caught and handled by picocli’s built-in error handler, which shows the error message in bold red, and is followed by the usage help message.
To construct a ParameterException, you need the CommandLine instance where the error occurred.
This can be obtained from the CommandSpec, which in turn can be obtained from a @Spec-annotated field.
The sections below show some examples.
10.2.1. Single Value Validation
Methods annotated with @Option and @Parameters can do simple input validation by throwing a ParameterException when invalid values are specified on the command line.
The following example validates that the value specified for the --prime option is a prime number:
class SingleOptionValidationExample {
private int prime;
@Spec CommandSpec spec; // injected by picocli
@Option(names = {"-p", "--prime"}, paramLabel = "NUMBER")
public void setPrimeNumber(int value) {
boolean invalid = false;
for (int i = 2; i <= value / 2; i++) {
if (value % i == 0) {
invalid = true;
break;
}
}
if (invalid) {
throw new ParameterException(spec.commandLine(),
String.format("Invalid value '%s' for option '--prime': " +
"value is not a prime number.", value));
}
prime = value;
}
// ...
}class SingleOptionValidationExample {
private var prime = 0
@Spec lateinit var spec : CommandSpec // injected by picocli
@Option(names = ["-p", "--prime"], paramLabel = "NUMBER")
fun setPrimeNumber(value: Int) {
var invalid = false
for (i in 2..value / 2) {
if (value % i == 0) {
invalid = true
break
}
}
if (invalid) {
throw ParameterException(spec.commandLine(),
String.format("Invalid value '%s' for option '--prime': " +
"value is not a prime number.", value))
}
prime = value
}
// ...
}10.2.2. Validating Option Combinations
Another common scenario is that the combination of multiple options and positional parameters is valid. One way to accomplish this is to perform such validation at the beginning of the business logic.
The following example validates that at least one of the --xml, --csv, or --json options is specified:
@Command(name = "myapp", mixinStandardHelpOptions = true, version = "myapp 0.1")
class MultiOptionValidationExample implements Runnable {
@Option(names="--xml") List<File> xmlFiles;
@Option(names="--csv") List<File> csvFiles;
@Option(names="--json") List<File> jsonFiles;
@Spec CommandSpec spec; // injected by picocli
public static void main(String... args) {
System.exit(new CommandLine(new MultiOptionValidationExample()).execute(args));
}
public void run() {
validate();
// remaining business logic here
}
private void validate() {
if (missing(xmlFiles) && missing(csvFiles) && missing(jsonFiles)) {
throw new ParameterException(spec.commandLine(),
"Missing option: at least one of the " +
"'--xml', '--csv', or '--json' options must be specified.");
}
}
private boolean missing(List<?> list) {
return list == null || list.isEmpty();
}
}@Command(name = "myapp", mixinStandardHelpOptions = true, version = ["myapp 0.1"])
class MultiOptionValidationExample : Runnable {
@Option(names = ["--xml"]) var xmlFiles: List<File>? = null
@Option(names = ["--csv"]) var csvFiles: List<File>? = null
@Option(names = ["--json"]) var jsonFiles: List<File>? = null
@Spec lateinit var spec : CommandSpec // injected by picocli
override fun run() {
validate()
// remaining business logic here
}
private fun validate() {
if (missing(xmlFiles) && missing(csvFiles) && missing(jsonFiles)) {
throw ParameterException(spec.commandLine(),
"Missing option: at least one of the " +
"'--xml', '--csv', or '--json' options must be specified.")
}
}
private fun missing(list: List<*>?): Boolean {
return list == null || list.isEmpty()
}
}
fun main(args: Array<String>) {
exitProcess(CommandLine(MultiOptionValidationExample()).execute(*args))
}10.2.3. JSR-380 BeanValidation
If you want to keep your validation declarative and annotation-based, take a look at JSR 380.
JSR-380 is a specification of the Java API for bean validation, part of JavaEE and JavaSE, which ensures that the properties of a bean meet specific criteria, using annotations such as @NotNull, @Min, and @Max.
The picocli wiki has a full example, below is a snippet:
import picocli.CommandLine;
import picocli.CommandLine.Model.CommandSpec;
import picocli.CommandLine.*;
import jakarta.validation.ConstraintViolation;
import jakarta.validation.Validation;
import jakarta.validation.Validator;
import jakarta.validation.constraints.*;
import java.util.Set;
// Example inspired by https://www.baeldung.com/javax-validation
public class User implements Runnable {
@NotNull(message = "Name cannot be null")
@Option(names = {"-n", "--name"}, description = "mandatory")
private String name;
@Min(value = 18, message = "Age should not be less than 18")
@Max(value = 150, message = "Age should not be greater than 150")
@Option(names = {"-a", "--age"}, description = "between 18-150")
private int age;
@Email(message = "Email should be valid")
@Option(names = {"-e", "--email"}, description = "valid email")
private String email;
@Spec CommandSpec spec;
public User() { }
@Override
public String toString() {
return String.format("User{name='%s', age=%s, email='%s'}", name, age, email);
}
public static void main(String... args) {
new CommandLine(new User()).execute(args);
}
@Override
public void run() {
validate();
// remaining business logic here
}
private void validate() {
Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
Set<ConstraintViolation<User>> violations = validator.validate(this);
if (!violations.isEmpty()) {
String errorMsg = "";
for (ConstraintViolation<User> violation : violations) {
errorMsg += "ERROR: " + violation.getMessage() + "\n";
}
throw new ParameterException(spec.commandLine(), errorMsg);
}
}
}import picocli.CommandLine
import picocli.CommandLine.Model.CommandSpec
import picocli.CommandLine.*
import jakarta.validation.ConstraintViolation
import jakarta.validation.Validation
import jakarta.validation.Validator
import jakarta.validation.constraints.*
// Example inspired by https://www.baeldung.com/javax-validation
class User : Runnable {
@NotNull(message = "Name cannot be null")
@CommandLine.Option(names = ["-n", "--name"], description = ["mandatory"])
private lateinit var name: String
@Min(value = 18, message = "Age should not be less than 18")
@Max(value = 150, message = "Age should not be greater than 150")
@Option(names = ["-a", "--age"], description = ["between 18-150"])
private var age = 0
@Email(message = "Email should be valid")
@Option(names = ["-e", "--email"], description = ["valid email"])
private lateinit var email: String
@Spec
lateinit var spec: CommandSpec
override fun toString(): String {
return "User{name=$name, age=$age, email=$email}"
}
override fun run() {
validate()
// remaining business logic here
}
private fun validate() {
val validator: Validator = Validation.buildDefaultValidatorFactory().validator
val violations: Set<ConstraintViolation<User>> = validator.validate(this)
if (violations.isNotEmpty()) {
var errorMsg = ""
for (violation in violations) {
errorMsg += "ERROR: ${violation.message}\n"
}
throw CommandLine.ParameterException(spec.commandLine(), errorMsg)
}
}
}
fun main(args: Array<String>) {
CommandLine(User()).execute(*args)
}10.2.4. Using a Custom Execution Strategy for Validation
The above JSR-380 BeanValidation can also be accomplished with a custom IExecutionStrategy that does the validation before executing the command.
This moves the validation logic into a separate class.
Picocli invokes this logic, removing the need to call a validate method from the business logic.
Such a custom execution strategy could look like this:
class ValidatingExecutionStrategy implements IExecutionStrategy {
public int execute(ParseResult parseResult) {
validate(parseResult.commandSpec());
return new CommandLine.RunLast().execute(parseResult); // default execution strategy
}
void validate(CommandSpec spec) {
Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
Set<ConstraintViolation<Object>> violations = validator.validate(spec.userObject());
if (!violations.isEmpty()) {
String errorMsg = "";
for (ConstraintViolation<?> violation : violations) {
errorMsg += "ERROR: " + violation.getMessage() + "\n";
}
throw new ParameterException(spec.commandLine(), errorMsg);
}
}
}class ValidatingExecutionStrategy : IExecutionStrategy {
override fun execute(parseResult : ParseResult) : Int {
validate(parseResult.commandSpec())
return CommandLine.RunLast().execute(parseResult) // default execution strategy
}
private fun validate(spec : CommandSpec) {
val validator: Validator = Validation.buildDefaultValidatorFactory().validator
val violations: Set<ConstraintViolation<Any>> = validator.validate(spec.userObject())
if (violations.isNotEmpty()) {
var errorMsg = ""
for (violation in violations) {
errorMsg += "ERROR: ${violation.message}\n"
}
throw CommandLine.ParameterException(spec.commandLine(), errorMsg)
}
}
}The application can wire in this custom execution strategy as follows:
public static void main(String... args) {
new CommandLine(new MyApp())
.setExecutionStrategy(new ValidatingExecutionStrategy())
.execute(args);
} public static void main(String... args) {
CommandLine(MyApp())
.setExecutionStrategy(ValidatingExecutionStrategy())
.execute(*args)
}11. Parser Configuration
11.1. Case Sensitivity
By default, all options and subcommands are case sensitive. From picocli 4.3, case sensitivity is configurable. Case sensitivity can be switched off globally, as well as on a per-command basis.
To toggle case sensitivity for all commands, use the CommandLine::setSubcommandsCaseInsensitive and CommandLine::setOptionsCaseInsensitive methods.
Use the CommandSpec::subcommandsCaseInsensitive and CommandSpec::optionsCaseInsensitive methods to give some commands a different case sensitivity than others.
Where possible, picocli will try to prevent ambiguity: when multiple options with the same name are registered in a command, a DuplicateOptionAnnotationsException is thrown.
When multiple subcommands with the same name are registered in a command, a DuplicateNameException is thrown.
With case sensitivity switched off, the same principle applies: multiple options whose names differ only in case cannot be registered in a command. Similarly, multiple subcommands cannot be registered when their names differ only in case.
|
When a combination of POSIX options resembles a long option, picocli will prioritize the long option.
This is the case regardless of case sensitivity, but be aware that with case sensitivity switched off, the chance of such collisions increases.
For example, if a command has POSIX options |
See the casesensitivity package in picocli-examples for some examples.
11.2. Abbreviated Options and Subcommands
Since picocli 4.4, the parser can recognize abbreviated options and subcommands.
This needs to be enabled explicitly with CommandLine::setAbbreviatedOptionsAllowed and CommandLine::setAbbreviatedSubcommandsAllowed.
11.2.1. Recognized Abbreviations
When abbreviations are enabled, users can specify the initial letter(s) of the first component and optionally of one or more subsequent components of an option or subcommand name.
"Components" are separated by - dash characters or by case, so for example, both --CamelCase and --kebab-case have two components.
|
When case sensitivity is disabled only the |
| Option or Subcommand | Sample Recognized Abbreviations |
|---|---|
|
|
|
|
|
|
11.2.2. Ambiguous Abbreviations
When the user specifies input that can match multiple options or subcommands, the parser throws a ParameterException.
When applications use the execute method, an error message and the usage help is displayed to the user.
For example, given a command with subcommands help and hello, then ambiguous user input like hel will show this error message:
Error: 'hel' is not unique: it matches 'hello', 'help'
11.2.3. Abbreviated Long Options and POSIX Clustered Short Options
When an argument can match both an abbreviated long option and a set of clustered short options, picocli matches the long option. This is the case regardless of abbreviations, but be aware that with abbreviated options enabled, the chance of such collisions increases.
For example:
class AbbreviationsAndPosix {
@Option(names = "-A") boolean a;
@Option(names = "-B") boolean b;
@Option(names = "-AaaBbb") boolean aaaBbb;
}
AbbreviationsAndPosix app = new AbbreviationsAndPosix();
new CommandLine(app).setAbbreviatedOptionsAllowed(true).parseArgs("-AB");
assert app.aaaBbb == true; // the long option is matched from abbreviated input -AB
assert app.a == false;
assert app.b == false;class AbbreviationsAndPosix {
@Option(names = ["-A"]) var a = false
@Option(names = ["-B"]) var b = false
@Option(names = ["-AaaBbb"]) var aaaBbb = false
}
val app = AbbreviationsAndPosix()
CommandLine(app).setAbbreviatedOptionsAllowed(true).parseArgs("-AB")
assertTrue(app.aaaBbb) // the long option is matched from abbreviated input -AB
assertFalse(app.a)
assertFalse(app.b)When abbreviated options are enabled, user input -AB will match the long -AaaBbb option, but not the -A and -B options.
11.3. Overwriting Single Options
When a single-value option is specified multiple times on the command line, the default parser behaviour is to throw an OverwrittenOptionException.
For example:
@Option(names = "-p") int port;@Option(names = ["-p"]) var port = 0The following input results in an OverwrittenOptionException:
<command> -p 80 -p 8080
Applications can change this by calling CommandLine::setOverwrittenOptionsAllowed with true before parsing the input.
When overwritten options are allowed, the last specified value takes effect (the above input will set the port field to 8080)
and a WARN level message is printed to the console. (See Tracing for how to switch off the warnings.)
11.4. Stop At Positional
By default, positional parameters can be mixed with options on the command line, but this is not always desirable.
From picocli 2.3, applications can call CommandLine::setStopAtPositional with true
to force the parser to treat all values following the first positional parameter as positional parameters.
When this flag is set, the first positional parameter effectively serves as an "end of options" marker.
11.5. Stop At Unmatched
From picocli 2.3, applications can call CommandLine::setStopAtUnmatched with true to force the parser to stop interpreting
options and positional parameters as soon as it encounters an unmatched argument.
When this flag is set, the first unmatched argument and all subsequent command line arguments are added to the
unmatched arguments list returned by CommandLine::getUnmatchedArguments.
11.6. Unmatched Input
By default, an UnmatchedArgumentException is thrown when a command line argument cannot be assigned to an option or positional parameter.
For example:
class OnlyThree {
@Parameters(arity = "3") String[] values;
}class OnlyThree {
@Parameters(arity = "3") lateinit var values: Array<String>
}The command has only one annotated field, values, and it expects exactly three arguments,
so the following input results in an UnmatchedArgumentException:
java OnlyThree 1 2 3 4 5
Applications can change this by calling CommandLine::setUnmatchedArgumentsAllowed with true before parsing the input.
When unmatched arguments are allowed, the above input will be accepted and a WARN level message is printed to the console.
(See Tracing for how to switch off the warnings.)
The unmatched argument values can be obtained with the CommandLine::getUnmatchedArguments method.
11.7. @Unmatched annotation
As of picocli 3.0, fields annotated with @Unmatched will be populated with the unmatched arguments.
The field must be of type String[] or List<String>.
If picocli finds a field annotated with @Unmatched, it automatically sets unmatchedArgumentsAllowed to true
so no UnmatchedArgumentException is thrown when a command line argument cannot be assigned to an option or positional parameter.
If no unmatched arguments are found, the value of the field annotated with @Unmatched is unchanged.
11.8. Unknown Options
11.8.1. Unknown Options Definition
A special case of unmatched input are arguments that resemble options but don’t match any of the defined options. Picocli determines if a value "resembles an option" by comparing its leading characters to the prefix characters of the known options.
Negative numbers are not considered to be unknown options, so values like -123, -NaN, -Infinity, -#ABC and -0xCAFEBABE will not be treated specially for resembling an option name.
|
For example, the value -z is considered an unknown option when we have a command that only defines options -x and -y:
@Option(names = "-x") String x;
@Option(names = "-y") String y;
@Parameters String[] remainder;@Option(names = ["-x"]) lateinit var x: String
@Option(names = ["-y"]) lateinit var y: String
@Parameters lateinit var remainder: Array<String>The above defines options -x and -y, but no option -z. So what should the parser do when the user gives input like this?
<command> -z -x XXX
11.8.2. Positional Parameters Resembling Options
One possibility is to silently accept such values as positional parameters, but this is often not desirable.
By default, when the value resembles an option, picocli throws an UnmatchedArgumentException rather than treating it as a positional parameter.
Picocli 3.0 introduced the CommandLine::setUnmatchedOptionsArePositionalParams method that can be used to force the parser to treat arguments resembling an option as positional parameters.
For example:
<command> -z -x XXX
When unmatchedOptionsArePositionalParams is set to true, the unknown option -z is treated as a positional parameter.
The next argument -x is recognized and processed as a known option like you would expect.
An alternative is to call CommandLine::setUnmatchedArgumentsAllowed with true, this will accept and store such values separately as described in Unmatched Input.
|
11.8.3. Option Parameters Resembling Options
By default, options accept parameter values that "resemble" (but don’t exactly match) an option.
Picocli 4.4 introduced a CommandLine::setUnmatchedOptionsAllowedAsOptionParameters method that makes it possible to configure the parser to reject values that resemble options as option parameters.
Setting this to false will result in values resembling option names being rejected as option values.
For example:
class MyApp {
@Option(names = "-x") String x;
}class MyApp {
@Option(names = ["-x"]) lateinit var x: String
}By default, a value like -z, which resembles an option, is accepted as the parameter for -x:
MyApp app = new MyApp();
new CommandLine(app).parseArgs("-x", "-z");
assert "-z".equals(app.x);val app = MyApp()
CommandLine(app).parseArgs("-x", "-z")
assertEquals("-z", app.x)After setting the unmatchedOptionsAllowedAsOptionParameters parser option to false, values resembling an option are rejected as parameter for -x:
new CommandLine(new MyApp())
.setUnmatchedOptionsAllowedAsOptionParameters(false)
.parseArgs("-x", "-z");CommandLine(MyApp())
.setUnmatchedOptionsAllowedAsOptionParameters(false)
.parseArgs("-x", "-z")This will throw an UnmatchedArgumentException with message:
"Unknown option: '-z'; Expected parameter for option '-x' but found '-z'"
11.9. Option Names or Subcommands as Option Values
11.9.1. By Default Options Do Not Consume Option Names or Subcommands
Since picocli 4.4, the parser will no longer assign values that match a subcommand name or an option name to options that take a parameter, unless the value is in quotes. For example:
class App {
@Option(names = "-x") String x;
@Option(names = "-y") String y;
public static void main(String... args) {
App app = new App();
new CommandLine(app).setTrimQuotes(true).parseArgs(args);
System.out.printf("x='%s', y='%s'%n", app.x, app.y);
}
}class App {
@Option(names = ["-x"]) var x: String? = null
@Option(names = ["-y"]) var y: String? = null
}
fun main(args: Array<String>) {
val app = App()
CommandLine(app).setTrimQuotes(true).parseArgs(*args)
println("x='${app.x}', y='${app.y}'")
}In previous versions of picocli, the above command would accept input -x -y, and the value -y would be assigned to the x String field.
As of picocli 4.4, the above input will be rejected with an error message indicating that the -x option requires a parameter.
If it is necessary to accept values that match option names, such values need to be quoted. For example:
java App -x=\"-y\"This will print the following output:
x='-y', y='null'11.9.2. Enable Consuming Option Names or Subcommands
Picocli 4.7.0 introduces two parser configuration options to change this behaviour:
-
CommandLine::setAllowOptionsAsOptionParametersallows options to consume option names -
CommandLine::setAllowSubcommandsAsOptionParametersallows options to consume subcommand names
When set to true, all options in the command (options that take a parameter) can consume values that match option names or subcommand names.
This means that any option will consume the maximum number of arguments possible for its arity.
|
USE WITH CAUTION! If an option is defined as |
11.9.3. Custom Parsing for Option-Specific Behaviour
The parser configuration options in the previous section apply to all options in the command.
Some applications may want to enable options consuming option names or subcommands for some options, but not for all options in the command. Such applications can replace or augment picocli’s parser by doing custom parameter processing for such options. For example:
class App implements Runnable {
@Option(names = "-x", parameterConsumer = App.CustomConsumer.class)
String x;
@Option(names = "-y")
String y;
@Command
public void mySubcommand() {}
static class CustomConsumer implements IParameterConsumer {
@Override
public void consumeParameters(Stack<String> args, ArgSpec argSpec, CommandSpec cmdSpec) {
if (args.isEmpty()) {
throw new ParameterException(cmdSpec.commandLine(),
"Error: option '-x' requires a parameter");
}
String arg = args.pop();
argSpec.setValue(arg);
}
}
public void run() {
System.out.printf("x='%s', y='%s'%n", x, y);
}
public static void main(String... args) {
new CommandLine(new App()).execute(args);
}
}class App : Runnable {
@Option(names = ["-x"], parameterConsumer = CustomConsumer::class)
var x: String? = null
@Option(names = ["-y"])
var y: String? = null
@Command
fun mySubcommand() {}
internal class CustomConsumer : IParameterConsumer {
override fun consumeParameters(args: Stack<String>, argSpec: ArgSpec, cmdSpec: CommandSpec) {
if (args.isEmpty()) {
throw ParameterException(cmdSpec.commandLine(),
"Error: option '-x' requires a parameter"
)
}
val arg = args.pop()
argSpec.setValue(arg)
}
}
override fun run() {
System.out.printf("x='%s', y='%s'%n", x, y)
}
companion object {
@JvmStatic
fun main(args: Array<String>) {
CommandLine(App()).execute(*args)
}
}
}The above code assigns whatever command line argument that follows the -x option to that option,
and allows input like the following:
java App -x=mySubcommand
java App -x mySubcommand
java App -x=-y
java App -x -y -y=12311.10. Toggle Boolean Flags
When a flag option is specified on the command line picocli will set its value to the opposite of its default value.
Prior to 4.0, the default was to "toggle" boolean flags to the opposite of their current value:
if the previous value was true it is set to false, and when the value was false it is set to true.
Applications can call CommandLine::setToggleBooleanFlags with true to enable toggling.
Note that when toggling is enabled, specifying a flag option twice on the command line will have no effect because they cancel each other out.
11.11. POSIX Clustered Short Options
By default, the picocli parser allows POSIX clustered short options, so short options like -x -v -f SomeFile can be clustered together like -xvfSomeFile.
From picocli 3.0, applications can call CommandLine::setPosixClusteredShortOptionsAllowed with false to enforce that options must be separated with whitespace on the command line.
(This also means that option parameters must be separated from the option name by whitespace or the = separator character, so -D key=value and -D=key=value will be recognized but -Dkey=value will not.)
11.12. Lenient Mode
From picocli 3.2, the parser can be configured to continue parsing invalid input to the end.
When collectErrors is set to true, and a problem occurs during parsing, an Exception is added to the list returned by ParseResult::errors and parsing continues. The default behaviour (when collectErrors is false) is to abort parsing by throwing the Exception.
This is useful when generating completion candidates on partial input, and is also useful when using picocli in languages like Clojure where idiomatic error handling does not involve throwing and catching exceptions.
When using this feature, applications are responsible for actively verifying that no errors occurred before executing the business logic. Use with care!
11.13. Quoted Values
11.13.1. Trimming Quotes
From picocli 3.7, quotes around command line parameters are preserved by default (previously they were removed). This can be configured with CommandLine::setTrimQuotes, or the parser configuration trimQuotes. From picocli 4.0, quoted arguments can contain nested quoted substrings, to give end users fine-grained control over how values are split.
If CommandLine::setTrimQuotes, or the parser configuration trimQuotes is set to true, picocli will remove quotes from the command line arguments, as follows:
-
As each command line argument is processed, the below smart unquote procedure is used to trim the outermost quotes.
-
Next, if the option or positional parameter has a
splitregex defined, the parameter value is split while respecting quotes: thesplitregex is not matched if it occurs in a quoted substring of the parameter value. Each of the parts found by the splitting process will have its quotes removed using the below "smart unquote" procedure.
See the Splitting Quoted Parameters section below for examples.
Smart Unquote
-
If the command line argument contains just the leading and trailing quote, these quotes are removed.
-
If the command line argument contains unescaped quotes, other than the leading and trailing quote, the argument is unchanged (the leading and trailing quotes remain).
-
If a quoted command line argument contains backslash-escaped quotes, the leading and trailing quotes are removed, backslash-escaped quotes are converted to unescaped quotes, and backslash-escaped backslashes are converted to unescaped backslashes.
For example:
| Command Line Argument | After Trimming Quotes | Note |
|---|---|---|
|
|
quotes removed |
|
|
left unchanged |
|
|
Splitting will find 4 values: |
|
|
Splitting will find 1 value: |
11.13.2. Splitting Quoted Parameters
By default, if the option or positional parameter has a split regex defined, parameter values are split into parts while respecting quotes: the split regular expression is not matched inside a quoted region.
Example:
@Option(names = "-x", split = ",")
String[] parts;@Option(names = ["-x"], split = ",")
lateinit var parts: Array<String>Given input like below:
<command> -x "-Dvalues=a,b,c","-Dother=1,2"This results in the parts array having the following values, assuming the parser configuration trimQuotes is false (the default):
"-Dvalues=a,b,c"
"-Dother=1,2"If the parser configuration trimQuotes is true, the above example would be split into the following values (with quotes trimmed from the resulting parts):
-Dvalues=a,b,c
-Dother=1,2Given input like below:
<command> -x a,b,"c,d,e",f,"xxx,yyy"This results in the parts array having the following values:
a
b
"c,d,e"
f
"xxx,yyy"Or, if the parser configuration trimQuotes is true:
a
b
c,d,e
f
xxx,yyyTo preserve quotes when trimQuotes is true, specify additional nested quotes on the command line. For example:
<command> "-x=\"a,b,\\"c,d,e\\",f\"" "x,y,z" "\"1,2,3\"" "\\"1,2,3\\""With parser configuration trimQuotes set to true, the above input gives the following values:
a,b,"c,d,e",f
x
y
z
1,2,3
"1,2,3"This "smart splitting" (respecting quotes) can be switched off with CommandLine::setSplitQuotedStrings:
setting the splitQuotedStrings parser attribute to true switches off smart splitting,
and the split regex is applied to the parameter value regardless of quotes.
|
|
11.14. Customizing Negatable Options
Negatable options can be customized via the INegatableOptionTransformer interface:
interface INegatableOptionTransformer {
/**
* Returns the negative form of the specified option name for the parser to recognize
* when parsing command line arguments.
* @param optionName the option name to create a negative form for,
* for example {@code --force}
* @param cmd the command that the option is part of
* @return the negative form of the specified option name, for example {@code --no-force}
*/
String makeNegative(String optionName, CommandSpec cmd);
/**
* Returns the documentation string to show in the synopsis and usage help message for
* the specified option. The returned value should be concise and clearly suggest that
* both the positive and the negative form are valid option names.
* @param optionName the option name to create a documentation string for,
* for example {@code --force}, or {@code -XX:+<option>}
* @param cmd the command that the option is part of
* @return the documentation string for the negatable option,
* for example {@code --[no-]force}, or {@code -XX:(+|-)<option>}
*/
String makeSynopsis(String optionName, CommandSpec cmd);
}This allows you to control:
-
which option names should have a negative form
-
the negative form recognized by the parser while parsing the command line
-
the documentation string showing both the positive and the negative form in the usage help message
By default, a set of regular expressions is used to control the above.
Use CommandLine::setNegatableOptionTransformer to replace the INegatableOptionTransformer with a custom version.
See the JavaDoc for details.
11.15. Custom Parameter Processing
As of version 4.6, picocli offers two different parser plugins for custom parameter processing: while the IParameterPreprocessor is a powerful and flexible tool, the IParameterConsumer serves as a simpler alternative.
11.15.1. IParameterConsumer Parser Plugin
Options or positional parameters can be assigned an IParameterConsumer that implements
custom logic to process the parameters for this option or this position.
When an option or positional parameter with a custom IParameterConsumer
is matched on the command line, picocli’s internal parser is temporarily suspended,
and the custom parameter consumer becomes responsible for consuming and processing as many
command line arguments as needed.
This can be useful when passing options through to another command.
For example, the unix find command
has a -exec
option to execute some action for each file found.
Any arguments following the -exec option until a ; or + argument are not
options for the find command itself, but are interpreted as a separate command and its options.
The example below demonstrates how to implement find -exec using this API:
@Command(name = "find")
class Find {
@Option(names = "-exec", parameterConsumer = ExecParameterConsumer.class)
List<String> list = new ArrayList<String>();
}
class ExecParameterConsumer implements IParameterConsumer {
public void consumeParameters(Stack<String> args, ArgSpec argSpec, CommandSpec commandSpec) {
List<String> list = argSpec.getValue();
while (!args.isEmpty()) {
String arg = args.pop();
list.add(arg);
// `find -exec` semantics: stop processing after a ';' or '+' argument
if (";".equals(arg) || "+".equals(arg)) {
break;
}
}
}
}@Command(name = "find")
class Find {
@Option(names = ["-exec"], parameterConsumer = ExecParameterConsumer::class)
var list: List<String> = ArrayList()
}
class ExecParameterConsumer : IParameterConsumer {
override fun consumeParameters(args: Stack<String>, argSpec: ArgSpec, commandSpec: CommandSpec) {
val list = argSpec.getValue<MutableList<String>>()
while (!args.isEmpty()) {
val arg = args.pop()
list.add(arg)
// `find -exec` semantics: stop processing after a ';' or '+' argument
if (";".equals(arg) || "+".equals(arg)) {
break
}
}
}
}
Make sure any nested classes are static, or picocli will not be able to instantiate them.
|
11.15.2. IParameterPreprocessor Parser Plugin
Introduced in picocli 4.6, the IParameterPreprocessor is also a parser plugin, similar to IParameterConsumer, but more flexible.
Options, positional parameters and commands can be assigned an IParameterPreprocessor that implements custom logic to preprocess the parameters for this option, position or command.
When an option, positional parameter or command with a custom IParameterPreprocessor is matched on the command line, picocli’s internal parser is temporarily suspended, and this custom logic is invoked.
This custom logic may completely replace picocli’s internal parsing for this option, positional parameter or command, or augment it by doing some preprocessing before picocli’s internal parsing is resumed for this option, positional parameter or command.
The "preprocessing" actions can include modifying the stack of command line parameters, or modifying the model.
Example use case
This may be useful when disambiguating input for commands that have both a positional parameter and an option with an optional parameter. For example, suppose we have a command with the following synopsis:
edit [--open[=<editor>]] <file>
One of the limitations of options with an optional parameter is that they are difficult to combine with positional parameters.
With a custom parser plugin, we can customize the parser, such that VALUE in --option=VALUE is interpreted as the option parameter, and in --option VALUE (without the = separator), VALUE is interpreted as the positional parameter.
The code below demonstrates this:
@Command(name = "edit")
class Edit {
@Parameters(index = "0", arity="0..1", description = "The file to edit.")
File file;
enum Editor { defaultEditor, eclipse, idea, netbeans }
@Option(names = "--open", arity = "0..1", preprocessor = Edit.MyPreprocessor.class,
description = {
"Optionally specify the editor to use (${COMPLETION-CANDIDATES}). " +
"If omitted the default editor is used. ",
"Example: edit --open=idea FILE opens IntelliJ IDEA (notice the '=' separator)",
" edit --open FILE opens the specified file in the default editor"
})
Editor editor = Editor.defaultEditor;
static class MyPreprocessor implements IParameterPreprocessor {
public boolean preprocess(Stack<String> args,
CommandSpec commandSpec,
ArgSpec argSpec,
Map<String, Object> info) {
// we need to decide whether the next arg is the file to edit
// or the name of the editor to use...
if (" ".equals(info.get("separator"))) { // parameter was not attached to option
// act as if the user specified --open=defaultEditor
args.push(Editor.defaultEditor.name());
}
return false; // picocli's internal parsing is resumed for this option
}
}
}class Edit : Runnable {
@Parameters(index = "0", arity = "0..1", description = ["The file to edit."])
var file: File? = null
enum class Editor { defaultEditor, eclipse, idea, netbeans }
@Option(names = ["--open"], arity = "0..1", preprocessor = MyPreprocessor::class,
description = ["Optionally specify the editor to use (\${COMPLETION-CANDIDATES}). " +
"If omitted the default editor is used. ",
"Example: edit --open=idea FILE ",
" opens file in IntelliJ IDEA (notice the '=' separator)",
" edit --open FILE",
" opens the specified file in the default editor"])
var editor = Editor.defaultEditor
class MyPreprocessor : IParameterPreprocessor {
override fun preprocess(args: Stack<String>,
commandSpec: CommandSpec,
argSpec: ArgSpec,
info: Map<String, Any>): Boolean {
// we need to decide whether the next arg is the file to edit
// or the name of the editor to use ...
if (" " == info["separator"]) { // parameter was not attached to option
// act as if the user specified --open=defaultEditor
args.push(Editor.defaultEditor.name)
}
return false // picocli's internal parsing is resumed for this option
}
}
}
Make sure any nested classes are static, or picocli will not be able to instantiate them.
|
With this preprocessor in place the user can now specify his editor of choice (e.g. --open=idea). If no editor is given, the default editor is used:
# User input # Command State # -------------------------- --open A B # editor: defaultEditor, file: A, unmatched: [B] --open A # editor: defaultEditor, file: A, unmatched: [] --open=A B # editor: A, file: B, unmatched: [] --open=A # editor: A, file: null, unmatched: []
11.15.3. Parser Plugin Comparison
IParameterPreprocessor |
IParameterConsumer |
|
|---|---|---|
Summary |
Either augment (return |
Replaces picocli parsing logic for the matched element. |
Scope |
Commands as well as options and positional parameters. |
Options and positional parameters only. |
Read parser state |
Yes, information may be received via the |
No |
Modify parser state |
Yes, via modifying the |
No |
12. Help
12.1. Help Options
Applications can define help options by setting attribute versionHelp = true, usageHelp = true or help = true.
If one of the arguments specified on the command line is a "help" option, picocli will not throw a MissingParameterException when required options are missing.
For example:
@Option(names = {"-V", "--version"}, versionHelp = true, description = "display version info")
boolean versionInfoRequested;
@Option(names = {"-h", "--help"}, usageHelp = true, description = "display this help message")
boolean usageHelpRequested;@Option(names = ["-V", "--version"], versionHelp = true, description = ["display version info"])
var versionInfoRequested = false
@Option(names = ["-h", "--help"], usageHelp = true, description = ["display this help message"])
var usageHelpRequested = falseUse these attributes for options that request the usage help message or version information to be shown on the console.
App app = CommandLine.populateCommand(new App(), args);
if (app.usageHelpRequested) {
CommandLine.usage(new App(), System.out);
return;
}val app: App = CommandLine.populateCommand(App(), *args)
if (app.usageHelpRequested) {
CommandLine.usage(App(), System.out)
return
}The CommandLine class offers two methods that allow external components to detect whether
usage help or version information was requested (without inspecting the annotated domain object):
-
CommandLine::isUsageHelpRequestedreturnstrueif the parser matched an option annotated withusageHelp=true -
CommandLine::isVersionHelpRequestedreturnstrueif the parser matched an option annotated withversionHelp=true
CommandLine commandLine = new CommandLine(new App());
commandLine.parseArgs(args);
if (commandLine.isUsageHelpRequested()) {
commandLine.usage(System.out);
return;
} else if (commandLine.isVersionHelpRequested()) {
commandLine.printVersionHelp(System.out);
return;
}
// ... run App's business logicval commandLine = CommandLine(App())
commandLine.parseArgs(*args)
if (commandLine.isUsageHelpRequested) {
commandLine.usage(System.out)
return
} else if (commandLine.isVersionHelpRequested) {
commandLine.printVersionHelp(System.out)
return
}
// ... run App's business logicSee also Printing Help Automatically.
12.2. Mixin Standard Help Options
Picocli 3.0 introduced the mixinStandardHelpOptions command attribute. When this attribute is set to true, picocli adds a mixin to the
command that adds usageHelp and versionHelp options to the command. For example:
@Command(mixinStandardHelpOptions = true, version = "auto help demo - picocli 3.0")
class AutoHelpDemo implements Runnable {
@Option(names = "--option", description = "Some option.")
String option;
@Override public void run() { /* ... */ }
}@Command(mixinStandardHelpOptions = true, version = ["auto help demo - picocli 3.0"])
class AutoHelpDemo : Runnable {
@Option(names = ["--option"], description = ["Some option."])
lateinit var option: String
override fun run() { /* ... */ }
}Commands with mixinStandardHelpOptions do not need to explicitly declare fields annotated with @Option(usageHelp = true) and @Option(versionHelp = true) any more.
The usage help message for the above example looks like this:
Usage: <main class> [-hV] [--option=<option>]
--option=<option> Some option.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
12.3. Built-in Help Subcommand
As of version 3.0, picocli provides a help subcommand (picocli.CommandLine.HelpCommand) that can be installed as a subcommand
on any application command. It prints usage help for the parent command or sibling subcommands. For example:
import picocli.CommandLine.HelpCommand;
@Command(name = "myapp", subcommands = {HelpCommand.class, Subcommand.class})
class MyCommand implements Runnable {
// ...
}import picocli.CommandLine.HelpCommand
// ...
@Command(name = "myapp", subcommands = [HelpCommand::class, Subcommand::class])
class MyCommand : Runnable {
// ...
}For example, the following command prints usage help for a subcommand:
myapp help subcommandTo print usage help for the main command:
myapp help12.4. Custom Help Subcommands
Custom help subcommands should mark themselves as a help command to tell picocli not to throw a MissingParameterException when required options are missing.
@Command(helpCommand = true)Picocli 4.0 introduced a new interface picocli.CommandLine.IHelpCommandInitializable2 that provides custom help
commands with access to the parent command and sibling commands, whether to use Ansi colors or not, and the streams to print the usage help message to.
The IHelpCommandInitializable2 interface replaces the IHelpCommandInitializable interface which was introduced in picocli 3.0.
public interface IHelpCommandInitializable2 {
/**
* Initializes this object with the information needed to implement a help command that
* provides usage help for other commands.
*
* @param helpCommandLine the {@code CommandLine} object associated with this help command.
* Implementors can use this to walk the command hierarchy and
* get access to the help command's parent and sibling commands.
* @param colorScheme the color scheme to use when printing help, including whether
* to use Ansi colors or not
* @param outWriter the output writer to print the usage help message to
* @param errWriter the error writer to print any diagnostic messages to,
* in addition to the output from the exception handler
*/
void init(CommandLine helpCommandLine,
Help.ColorScheme colorScheme,
PrintWriter outWriter,
PrintWriter errWriter);
}12.5. Printing Help Automatically
As of picocli 2.0, the convenience methods will automatically print usage help and version information
when a help option was specified on the command line (options annotated with the versionHelp or usageHelp attribute - but not the help attribute).
The same holds for the mixinStandardHelpOptions attribute, the built-in HelpCommand and any custom help subcommands marked as a help command.
The following convenience methods automatically print help:
-
CommandLine::execute -
CommandLine::call -
CommandLine::run -
CommandLine::invoke -
CommandLine::parseWithHandler(with the built-inRun…handlers) -
CommandLine::parseWithHandlers(with the built-inRun…handlers)
The following methods do not automatically print help:
-
CommandLine::parse -
CommandLine::parseArgs -
CommandLine::populateCommand
When using the last three methods, applications need to query the parse result to detect whether usage help or version help
was requested, and invoke CommandLine::usage or CommandLine::printVersionHelp to actually print the requested help message.
13. Version Help
13.1. Static Version Information
13.1.1. Command version Attribute
As of picocli 0.9.8, applications can specify version information in the version attribute of the @Command annotation.
@Command(version = "1.0")
class VersionedCommand {
@Option(names = { "-V", "--version" }, versionHelp = true,
description = "print version information and exit")
boolean versionRequested;
/* ... */ }@Command(version = ["1.0"])
class VersionedCommand {
@Option(names = ["-V", "--version"], versionHelp = true,
description = ["print version information and exit"])
var versionRequested = false
/* ... */ }The CommandLine.printVersionHelp(PrintStream) method extracts the version information from this
annotation and prints it to the specified PrintStream.
CommandLine commandLine = new CommandLine(new VersionedCommand());
commandLine.parseArgs(args);
if (commandLine.isVersionHelpRequested()) {
commandLine.printVersionHelp(System.out);
return;
}val commandLine = CommandLine(VersionedCommand())
commandLine.parseArgs(*args)
if (commandLine.isVersionHelpRequested) {
commandLine.printVersionHelp(System.out)
return
}13.1.2. Multi-line Version Info
The version may specify multiple Strings. Each will be printed on a separate line.
@Command(version = { "Versioned Command 1.0", "Build 12345", "(c) 2017" })
class VersionedCommand { /* ... */ }@Command(version = ["Versioned Command 1.0", "Build 12345", "(c) 2017"])
class VersionedCommand { /* */ }The CommandLine.printVersionHelp(PrintStream) method will print the above as:
Versioned Command 1.0 Build 12345 (c) 2017
13.1.3. Version Info With Variables
As of picocli 4.0, the version strings may contain system properties and environment variables. For example:
@Command(version = {
"Versioned Command 1.0",
"Picocli " + picocli.CommandLine.VERSION,
"JVM: ${java.version} (${java.vendor} ${java.vm.name} ${java.vm.version})",
"OS: ${os.name} ${os.version} ${os.arch}"})
class VersionedCommand { /* ... */ }@Command(version = [
"Versioned Command 1.0",
"Picocli " + picocli.CommandLine.VERSION,
"JVM: \${java.version} (\${java.vendor} \${java.vm.name} \${java.vm.version})",
"OS: \${os.name} \${os.version} \${os.arch}"])
class VersionedCommand { /* */ }Depending on your environment, that may print something like:
Versioned Command 1.0 Picocli 4.0.0 JVM: 1.8.0_202 (Oracle Corporation Substrate VM GraalVM 1.0.0-rc15 CE) OS: Linux 4.4.0-17134-Microsoft amd64
13.1.4. Version Info With Colors
The version strings may contain markup to show ANSI styles and colors. For example:
@Command(version = {
"@|yellow Versioned Command 1.0|@",
"@|blue Build 12345|@",
"@|red,bg(white) (c) 2017|@" })
class VersionedCommand { /* ... */ }@Command(version = [
"@|yellow Versioned Command 1.0|@",
"@|blue Build 12345|@",
"@|red,bg(white) (c) 2017|@"])
class VersionedCommand { /* */ }The markup will be rendered as ANSI escape codes on supported systems.
13.1.5. Version Info With Format Specifiers
As of picocli 1.0, the version may contain format specifiers:
@Command(version = {
"Versioned Command 1.0",
"Build %1$s",
"(c) 2017, licensed to %2$s" })
class VersionedCommand { /* ... */ }@Command(version = [
"Versioned Command 1.0",
"Build %1\$s",
"(c) 2017, licensed to %2\$s"])
class VersionedCommand { /* ... */ }Format argument values can be passed to the printVersionHelp method:
String[] args = {"1234", System.getProperty("user.name")};
new CommandLine(new VersionedCommand())
.printVersionHelp(System.out, Help.Ansi.AUTO, args);val args = arrayOf("1234", System.getProperty("user.name"))
CommandLine(VersionedCommand()).printVersionHelp(System.out, Help.Ansi.AUTO, *args)13.2. Dynamic Version Information
13.2.1. Command versionProvider Attribute
As of picocli 2.2, the @Command annotation supports a versionProvider attribute.
Applications may specify a IVersionProvider implementation in this attribute, and picocli will instantiate this class
and invoke it to collect version information.
@Command(versionProvider = com.my.custom.ManifestVersionProvider.class)
class App { /* ... */ }@Command(versionProvider = com.my.custom.ManifestVersionProvider::class)
class App { /* ... */ }This is useful when the version of an application should be detected dynamically at runtime. For example, an implementation may return version information obtained from the JAR manifest, a properties file or some other source.
13.2.2. IVersionProvider Interface
Custom version providers need to implement the picocli.CommandLine.IVersionProvider interface:
public interface IVersionProvider {
/**
* Returns version information for a command.
* @return version information (each string in the array is displayed on a separate line)
* @throws Exception an exception detailing what went wrong when obtaining version information
*/
String[] getVersion() throws Exception;
}Version providers declared with the versionProvider attribute need to have a public no-argument constructor to be instantiated, unless a Custom Factory is installed to instantiate classes.
13.2.3. Dynamic Version Info with Variables
The version strings returned from the IVersionProvider may contain system properties and environment variables.
For example:
class VersionProviderWithVariables implements IVersionProvider {
public String[] getVersion() {
return new String[] { "${COMMAND-FULL-NAME} version 1.0" };
}
}class VersionProviderWithVariables : IVersionProvider {
override fun getVersion(): Array<String> {
return arrayOf("\${COMMAND-FULL-NAME} version 1.0")
}
}The above example version provider will show the fully qualified command name (that is, preceded by its parent fully qualified command name) of any command that uses this version provider.
This is one way to create a version provider that can be reused across multiple commands.
13.2.4. Injecting CommandSpec Into an IVersionProvider
As of picocli 4.2.0, IVersionProvider implementations can have @Spec-annotated fields. If such a field
exists, picocli will inject the CommandSpec of the command that uses this version provider.
This gives the version provider access to the full command hierarchy,
and may make it easier to implement version providers that can be reused among multiple commands.
For example:
class MyVersionProvider implements IVersionProvider {
@Spec CommandSpec spec;
public String[] getVersion() {
return new String[] { "Version info for " + spec.qualifiedName() };
}
}class MyVersionProvider : IVersionProvider {
@Spec
lateinit var spec: CommandSpec
override fun getVersion(): Array<String> {
return arrayOf("Version info for " + spec.qualifiedName())
}
}14. Usage Help
14.1. Compact Example
A default picocli usage help message looks like this:
Usage: cat [-AbeEnstTuv] [--help] [--version] [FILE...]
Concatenate FILE(s), or standard input, to standard output.
FILE Files whose contents to display
-A, --show-all equivalent to -vET
-b, --number-nonblank number nonempty output lines, overrides -n
-e equivalent to -vE
-E, --show-ends display $ at end of each line
-n, --number number all output lines
-s, --squeeze-blank suppress repeated empty output lines
-t equivalent to -vT
-T, --show-tabs display TAB characters as ^I
-u (ignored)
-v, --show-nonprinting use ^ and M- notation, except for LFD and TAB
--help display this help and exit
--version output version information and exit
Copyright(c) 2017
The usage help message is generated from annotation attributes, like below:
@Command(name = "cat", footer = "Copyright(c) 2017",
description = "Concatenate FILE(s), or standard input, to standard output.")
class Cat {
@Parameters(paramLabel = "FILE", description = "Files whose contents to display")
List<File> files;
@Option(names = "--help", usageHelp = true, description = "display this help and exit")
boolean help;
@Option(names = "-t", description = "equivalent to -vT") boolean t;
@Option(names = "-e", description = "equivalent to -vE") boolean e;
@Option(names = {"-A", "--show-all"}, description = "equivalent to -vET") boolean all;
// ...
}@Command(name = "cat", footer = ["Copyright(c) 2017"],
description = ["Concatenate FILE(s), or standard input, to standard output."])
class Cat {
@Parameters(paramLabel = "FILE", description = ["Files whose contents to display"])
lateinit var files: List<File>
@Option(names = ["--help"], usageHelp = true, description = ["display this help and exit"])
var help = false
@Option(names = ["-t"], description = ["equivalent to -vT"]) var t = false
@Option(names = ["-e"], description = ["equivalent to -vE"]) var e = false
@Option(names = ["-A", "--show-all"], description = ["equivalent to -vET"]) var all = false
// ...
}14.2. Command Name
In the above example, the program name is taken from the name attribute of the Command annotation:
@Command(name = "cat")Without a name attribute, picocli will show a generic <main class> in the synopsis:
Usage: <main class> [-AbeEnstTuv] [--help] [--version] [FILE...]
14.3. Parameter Labels
Non-boolean options require a value. The usage help should explain this, and picocli shows the option parameter
in the synopsis and in the option list. By default, the field name is shown in < and > fish brackets.
Use the paramLabel attribute to display a different name. For example:
Usage: <main class> [-f=FILE] [-n=<number>] NUM <host>
NUM number param
host the host parameter
-f= FILE a file
-n= <number> a number option
Some annotated fields in the below example class have a paramLabel attribute and others don’t:
@Command()
class ParamLabels {
@Option(names = "-f", description = "a file", paramLabel = "FILE") File f;
@Option(names = "-n", description = "a number option") int number;
@Parameters(index = "0", description = "number param", paramLabel = "NUM") int n;
@Parameters(index = "1", description = "the host parameter") InetAddress host;
}@Command
class ParamLabels {
@Option(names = ["-f"], description = ["a file"], paramLabel = "FILE")
lateinit var f: File
@Option(names = ["-n"], description = ["a number option"])
var number = 0
@Parameters(index = "0", description = ["number param"], paramLabel = "NUM")
var n = 0
@Parameters(index = "1", description = ["the host parameter"])
lateinit var host: InetAddress
}
For demonstration purposes the above example mixes the all-uppercase (e.g., NUM) style label and the fish bracket (e.g., <number>) style labels. For real applications, mixing these label styles should be avoided. An application should consistently use only one style.
|
14.4. Option List
14.4.1. Sorted Option List
By default, the options list in the usage help message displays options in alphabetical order.
Use the sortOptions = false attribute to display options in the order they are declared in your class.
@Command(sortOptions = false)| Sorting on declaration order is done on a best effort basis, see the Reordering Options section below. |
14.4.2. Reordering Options
Note that picocli cannot reliably detect declaration order in commands that have both @Option-annotated methods and @Option-annotated fields.
The @Option(order = <int>) attribute can be used to explicitly control the position in the usage help message at which the option should be shown.
Options with a lower number are shown before options with a higher number.
14.4.3. Sorted Synopsis
By default, the synopsis of the usage help message displays options in alphabetical order.
Picocli 4.7.0 introduced a sortSynopsis = false attribute to let the synopsis display options in the order they are declared in your class, or sorted by their order attribute.
@Command(sortSynopsis = false)| Regardless of the sorting strategy, boolean short options are shown first as a single clustered group in the synopsis, followed by options that take parameters, unless the parser is configured to disallow clustered boolean short options. |
14.4.4. Required-Option Marker
Required options can be marked in the option list by the character specified with the requiredOptionMarker attribute. By default options are not marked because the synopsis shows users which options are required and which are optional. This feature may be useful in combination with the abbreviateSynopsis attribute. For example:
@Command(requiredOptionMarker = '*', abbreviateSynopsis = true)
class Example {
@Option(names = {"-a", "--alpha"}, description = "optional alpha") String alpha;
@Option(names = {"-b", "--beta"}, required = true, description = "mandatory beta") String beta;
}@Command(requiredOptionMarker = '*', abbreviateSynopsis = true)
class Example {
@Option(names = ["-a", "--alpha"], description = ["optional alpha"])
lateinit var alpha: String
@Option(names = ["-b", "--beta"], required = true, description = ["mandatory beta"])
lateinit var beta: String
}Produces the following usage help message:
Usage: <main class> [OPTIONS] -a, --alpha=<alpha> optional alpha * -b, --beta=<beta> mandatory beta
14.4.5. Short and Long Option Columns
The default layout shows short options and long options in separate columns, followed by the description column.
Only POSIX short options are shown in the first column, that is, options that start with a single - dash and are one character long.
| Options with two characters are not considered short options and are shown in the long option column. |
This is a common layout for Unix utilities, and can enhance usability: applications can give a subtle hint to end users that an option is common and encouraged by providing both a short and a long name for the option. Conversely, the absence of a short option can signal that the option is unusual or perhaps should be used with care.
It is possible to left-align all options by using a custom layout.
See LeftAlignOptions.java in the picocli-examples module for an example.
|
14.4.6. Long Option Column Width
The default layout shows short options and long options in separate columns, followed by the description column. The width of the long options column shrinks automatically if all long options are very short, but by default this column does not grow larger than 20 characters.
If the long option with its option parameter is longer than 20 characters
(for example: --output=<outputFolder>), the long option overflows into the description column, and the option description is shown on the next line.
This (the default) looks like this:
Usage: myapp [-hV] [-o=<outputFolder>]
-h, --help Show this help message and exit.
-o, --output=<outputFolder>
Output location full path.
-V, --version Print version information and exit.
As of picocli 4.2, there is programmatic API to change this via the CommandLine::setUsageHelpLongOptionsMaxWidth and UsageMessageSpec::longOptionsMaxWidth methods.
In the above example, if we call commandLine.setUsageHelpLongOptionsMaxWidth(23) before printing the usage help, we get this result:
Usage: myapp [-hV] [-o=<outputFolder>] -h, --help Show this help message and exit. -o, --output=<outputFolder> Output location full path. -V, --version Print version information and exit.
The minimum value that can be specified for longOptionsMaxWidth is 20, the maximum value is the usage width minus 20.
14.5. Usage Width
The default width of the usage help message is 80 characters.
Commands defined with @Command(usageHelpWidth = NUMBER) in the annotations will use the specified width.
Picocli 3.0 also introduced programmatic API for this via the CommandLine::setUsageHelpWidth and UsageMessageSpec::width methods.
End users can use the system property picocli.usage.width to specify a custom width that overrides the programmatically set value.
The minimum width that can be configured is 55 characters.
14.6. Auto (Terminal) Width
As of picocli 4.0, commands defined with @Command(usageHelpAutoWidth = true) will try to adjust the usage message help layout to the terminal width.
There is also programmatic API to control this via the CommandLine::setUsageHelpAutoWidth and UsageMessageSpec::autoWidth methods.
End users may enable this by setting the system property picocli.usage.width to AUTO, and may disable this by setting this system property to a numeric value.
This feature requires Java 7.
14.7. Split Synopsis Label
Options and parameters may have a split attribute to split each parameter into smaller substrings.
Regular expressions may contain literal text, but may also contain special characters.
The regular expression in the split attribute may be quite different from what end users need to type.
The example below uses the plus (+) character as a separator.
The regular expression in the split attribute uses backslash (\) characters to make sure that the plus character is treated as a literal.
@Parameters(split = "\\+", splitSynopsisLabel = "+", paramLabel = "VALUE")
List<String> values;@Parameters(split = "\\+", splitSynopsisLabel = "+", paramLabel = "VALUE")
lateinit var values: List<String>However, end users can type simply A+B+C (using the plus character separator), not A\+B\+C.
We want the usage help message to show this.
The splitSynopsisLabel attribute, introduced in picocli 4.3, controls what is shown in the synopsis of the usage help message.
With the example above, the synopsis of the usage help looks like this:
Usage: cmd [VALUE[+VALUE...]...]
14.8. Abbreviated Synopsis
If a command is very complex and has many options, it is sometimes desirable to suppress details from the synopsis with the abbreviateSynopsis attribute. For example:
Usage: <main class> [OPTIONS] [<files>...]
Note that the positional parameters are not abbreviated.
@Command(abbreviateSynopsis = true)
class App {
@Parameters File[] files;
@Option(names = {"--count", "-c"}) int count;
// ...
}@Command(abbreviateSynopsis = true)
class App {
@Parameters lateinit var files: Array<File>
@Option(names = ["--count", "-c"]) var count = 0
// ...
}14.9. Custom Synopsis
For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:
Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form) or: ln [OPTION]... TARGET (2nd form) or: ln [OPTION]... TARGET... DIRECTORY (3rd form) or: ln [OPTION]... -t DIRECTORY TARGET... (4th form)
To produce a synopsis like the above, specify the literal text in the customSynopsis attribute:
@Command(synopsisHeading = "", customSynopsis = {
"Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form)",
" or: ln [OPTION]... TARGET (2nd form)",
" or: ln [OPTION]... TARGET... DIRECTORY (3rd form)",
" or: ln [OPTION]... -t DIRECTORY TARGET... (4th form)",
})
class Ln { /* ... */ }@Command(synopsisHeading = "", mixinStandardHelpOptions = true, customSynopsis = ["""
Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form)
or: ln [OPTION]... TARGET (2nd form)
or: ln [OPTION]... TARGET... DIRECTORY (3rd form)
or: ln [OPTION]... -t DIRECTORY TARGET... (4th form)"""])
class Ln { /* ... */ }14.10. Synopsis Subcommand Label
For commands with subcommands, the string [COMMAND] is appended to the end of the synopsis (whether the synopsis is abbreviated or not). This looks something like this:
Usage: <cmd> [OPTIONS] FILES [COMMAND]
As of picocli 4.0, this can be customized with the synopsisSubcommandLabel attribute.
For example, to clarify that a subcommand is mandatory, an application may specify COMMAND, without the [ and ] brackets:
@Command(name = "git", synopsisSubcommandLabel = "COMMAND")
class Git { /* ... */ }An application with a limited number of subcommands may want to show them all in the synopsis, for example:
@Command(name = "fs", synopsisSubcommandLabel = "(list | add | delete)",
subcommands = {List.class, Add.class, Delete.class}, mixinStandardHelpOptions = true)
class Fs { /* ... */ }@Command(name = "fs", synopsisSubcommandLabel = "(list | add | delete)",
subcommands = [List::class, Add::class, Delete::class],
mixinStandardHelpOptions = true)
class Fs { /* ... */ }This will show the following synopsis:
Usage: fs [-hV] (list | add | delete)
14.11. Header and Footer
The header will be shown at the top of the usage help message (before the synopsis). The first header line is also the line shown in the subcommand list if your command has subcommands (see Usage Help for Subcommands).
Use the footer attribute to specify one or more lines to show below the generated usage help message.
Each element of the attribute String array is displayed on a separate line.
14.12. Exit Code List
By default, the usage help message does not display exit code information.
Applications that call System.exit need to configure the exitCodeListHeading and exitCodeList annotation attributes.
For example:
@Command(exitCodeListHeading = "Exit Codes:%n",
exitCodeList = {
" 0:Successful program execution",
"64:Usage error: user input for the command was incorrect, " +
"e.g., the wrong number of arguments, a bad flag, " +
"a bad syntax in a parameter, etc.",
"70:Internal software error: an exception occurred when invoking " +
"the business logic of this command."})
class App {}
new CommandLine(new App()).usage(System.out);@Command(exitCodeListHeading = "Exit Codes:%n",
exitCodeList = [
" 0:Successful program execution",
"64:Usage error: user input for the command was incorrect," +
"e.g., the wrong number of arguments, a bad flag, " +
"a bad syntax in a parameter, etc.",
"70:Internal software error: an exception occurred when invoking " +
"the business logic of this command."])
class App {}
fun main(args: Array<String>) : Unit = CommandLine(App()).usage(System.out)This will print the following usage help message to the console:
Usage: <main class>
Exit Codes:
0 Successful program execution
64 Usage error: user input for the command was incorrect, e.g., the wrong
number of arguments, a bad flag, a bad syntax in a parameter, etc.
70 Internal software error: an exception occurred when invoking the
business logic of this command.14.13. Format Specifiers
All usage help message elements can have embedded line separator (%n) format specifiers.
These are converted to the platform-specific line separator when the usage help message is printed.
Version help may have format specifiers that format additional arguments passed to the printVersionHelp method.
See the java.util.Formatter JavaDoc for details.
Note that to show percent '%' characters in the usage help message, they need to be escaped with another %. For example: @Parameters(description = "%%-age of the total") is rendered as %-age of the total.
|
An alternative way to control the layout of the usage help message is that some sections (header, footer, and description) can be specified as an array of Strings,
where each element of the array is displayed on a separate line in the usage help message.
14.14. Section Headings
Section headers can be used to make usage message layout appear more spacious. The example below demonstrates the use of embedded line separator (%n) format specifiers:
@Command(name = "commit",
sortOptions = false,
headerHeading = "Usage:%n%n",
synopsisHeading = "%n",
descriptionHeading = "%nDescription:%n%n",
parameterListHeading = "%nParameters:%n",
optionListHeading = "%nOptions:%n",
header = "Record changes to the repository.",
description = "Stores the current contents of the index in a new commit " +
"along with a log message from the user describing the changes.")
class GitCommit { /* ... */ }@Command(name = "commit",
sortOptions = false,
headerHeading = "Usage:%n%n",
synopsisHeading = "%n",
descriptionHeading = "%nDescription:%n%n",
parameterListHeading = "%nParameters:%n",
optionListHeading = "%nOptions:%n",
header = ["Record changes to the repository."],
description = ["Stores the current contents of the index in a new commit " +
"along with a log message from the user describing the changes."])
class GitCommit { /* ... */ }The usage help message generated from this class is shown below in Expanded Example.
14.15. Expanded Example
The below example demonstrates what a customized usage message can look like. Note how section headings with line separators can create a more spacious usage message, and also that options are listed in declaration order (instead of in alphabetic order).
Usage:
Record changes to the repository.
git commit [-ap] [--fixup=<commit>] [--squash=<commit>] [-c=<commit>]
[-C=<commit>] [-F=<file>] [-m[=<msg>...]] [<files>...]
Description:
Stores the current contents of the index in a new commit along with a log
message from the user describing the changes.
Parameters:
<files> the files to commit
Options:
-a, --all Tell the command to automatically stage files
that have been modified and deleted, but new
files you have not told Git about are not
affected.
-p, --patch Use the interactive patch selection interface to
chose which changes to commit
-C, --reuse-message=<commit>
Take an existing commit object, and reuse the log
message and the authorship information
(including the timestamp) when creating the
commit.
-c, --reedit-message=<commit>
Like -C, but with -c the editor is invoked, so
that the user can further edit the commit
message.
--fixup=<commit> Construct a commit message for use with rebase
--autosquash.
--squash=<commit> Construct a commit message for use with rebase
--autosquash. The commit message subject line is
taken from the specified commit with a prefix
of "squash! ". Can be used with additional
commit message options (-m/-c/-C/-F).
-F, --file=<file> Take the commit message from the given file. Use
- to read the message from the standard input.
-m, --message[=<msg>...] Use the given <msg> as the commit message. If
multiple -m options are given, their values are
concatenated as separate paragraphs.
The annotated class that this usage help message is generated from is shown in Section Headings.
14.16. Option-Parameter Separators
The separator displayed between options and option parameters (= by default)
in the synopsis and the option list can be configured with the separator attribute.
@Command(separator = " ")
The @Command(separator = " ") annotation also affects how picocli parses the command line. See also Custom Separators.
|
14.17. Hidden Options and Parameters
Options and Parameters with the hidden attribute set to true will not be shown in the usage help message.
This is useful for example when a parameter at some index is captured into multiple fields:
by default each of these fields would be shown in the usage message, which would be confusing for users.
For example, the all field below is annotated as hidden = true:
@Command()
class App {
@Parameters(index = "0", description = "destination host") InetAddress host;
@Parameters(index = "1", description = "destination port") int port;
@Parameters(index = "2..*", description = "files to transfer") String[] files;
@Parameters(hidden = true) String[] all;
}@Command
class App {
@Parameters(index = "0", description = ["destination host"])
lateinit var host: InetAddress
@Parameters(index = "1", description = ["destination port"])
var port = 0
@Parameters(index = "2..*", description = ["files to transfer"])
lateinit var files: Array<String>
@Parameters(hidden = true)
lateinit var all: Array<String>
}The above will generate the following usage help message, where the all field is not shown:
Usage: <main class> <host> <port> [<files>...]
host destination host
port destination port
files files to transfer
14.18. Show At Files
As of picocli 4.2, an entry for @<filename> can be shown in the options and parameters list of the usage help message of a command with the @Command(showAtFileInUsageHelp = true) annotation.
14.18.1. Example
Example command:
@Command(name = "myapp", showAtFileInUsageHelp = true,
mixinStandardHelpOptions = true, description = "Example command.")
class MyApp {
@Parameters(description = "A file.") File file;
}@Command(name = "myapp", showAtFileInUsageHelp = true,
mixinStandardHelpOptions = true, description = ["Example command."])
class MyApp {
@Parameters(description = ["A file."])
lateinit var file: File
}The usage help message for this command looks like this:
Usage: myapp [-hV] [@<filename>...] <file>
Example command.
[@<filename>...] One or more argument files containing options.
<file> A file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
14.18.2. Changing the At File Entry Location
By default, the @<filename> entry is shown before the positional parameters in the synopsis as well as in the parameters list.
This can be changed with the Help API for reordering sections. For example:
import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_AT_FILE_PARAMETER;
import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST_HEADING;
@Command(name = "myapp", showAtFileInUsageHelp = true,
mixinStandardHelpOptions = true, description = "Example command.")
class MyApp {
@Parameters(description = "A file.") File file;
public static void main(String... args) {
CommandLine cmd = new CommandLine(new MyApp());
List<String> copy = new ArrayList<>(cmd.getHelpSectionKeys());
copy.remove(SECTION_KEY_AT_FILE_PARAMETER);
copy.add(copy.indexOf(SECTION_KEY_COMMAND_LIST_HEADING), SECTION_KEY_AT_FILE_PARAMETER);
cmd.setHelpSectionKeys(copy);
cmd.usage(System.out);
}
}import picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST_HEADING
import picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_AT_FILE_PARAMETER
// ...
@Command(name = "myapp", showAtFileInUsageHelp = true,
mixinStandardHelpOptions = true, description = ["Example command."])
class MyApp {
@Parameters(description = ["A file."]) lateinit var file: File
companion object {
@JvmStatic
fun main(args: Array<String>) {
val cmd = CommandLine(MyApp())
val copy: MutableList<String> = ArrayList(cmd.helpSectionKeys)
copy.remove(SECTION_KEY_AT_FILE_PARAMETER)
copy.add(copy.indexOf(SECTION_KEY_COMMAND_LIST_HEADING), SECTION_KEY_AT_FILE_PARAMETER)
cmd.helpSectionKeys = copy
cmd.usage(System.out)
}
}
}The resulting usage help message shows the @<filename> entry has moved to the bottom, following the options list:
Usage: myapp [-hV] [@<filename>...] <file>
Example command.
<file> A file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
[@<filename>...] One or more argument files containing options.
14.18.3. Changing the At File Entry Text
Both the label and the description of the @<filename> entry have been defined with custom variables, to allow applications to change the text. The variables are:
-
picocli.atfile.label -
picocli.atfile.description
By setting the above variables in either system properties, environment variables or the resource bundle for a command, the text can be customized.
For example, if we define these system properties:
System.setProperty("picocli.atfile.label", "my@@@@file");
System.setProperty("picocli.atfile.description", "@files rock!");then the usage help for our above example changes to this:
Usage: myapp [-hV] [my@@@@file...] <file>
Example command.
[my@@@@file...] @files rock!
<file> A file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
The description of the @<filename> entry can also be specified in a resource bundle for internationalization and localization.
The descriptionKey for the @<filename> entry in resource bundles is:
-
picocli.atfile
14.19. Show End of Options
As of picocli 4.3, an entry for the -- End of Options delimiter can be shown in the options list of the usage help message of a command with the @Command(showEndOfOptionsDelimiterInUsageHelp = true) annotation.
14.19.1. Example
Example command:
@Command(name = "myapp", showEndOfOptionsDelimiterInUsageHelp = true,
mixinStandardHelpOptions = true, description = "Example command.")
class MyApp {
@Parameters(description = "A file.") File file;
}@Command(name = "myapp", showEndOfOptionsDelimiterInUsageHelp = true,
mixinStandardHelpOptions = true, description = ["Example command."])
class MyApp {
@Parameters(description = ["A file."])
lateinit var file: File
}The usage help message for this command looks like this:
Usage: myapp [-hV] [--] <file>
Example command.
<file> A file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
-- This option can be used to separate command-line options from
the list of positional parameters.
14.19.2. Changing the End of Options Entry Location
By default, the -- End of Options entry is shown between the options and the positional parameters in the synopsis, and at the end of the options list.
This can be changed with the Help API for reordering sections. For example:
import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_END_OF_OPTIONS;
import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST;
@Command(name = "myapp", showEndOfOptionsDelimiterInUsageHelp = true,
mixinStandardHelpOptions = true, description = "Example command.")
class MyApp {
@Parameters(description = "A file.") File file;
public static void main(String... args) {
CommandLine cmd = new CommandLine(new MyApp());
List<String> copy = new ArrayList<>(cmd.getHelpSectionKeys());
copy.remove(SECTION_KEY_END_OF_OPTIONS);
copy.add(copy.indexOf(SECTION_KEY_OPTION_LIST), SECTION_KEY_END_OF_OPTIONS);
cmd.setHelpSectionKeys(copy);
cmd.usage(System.out);
}
}import picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST
import picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_END_OF_OPTIONS
// ...
@Command(name = "myapp", showEndOfOptionsDelimiterInUsageHelp = true,
mixinStandardHelpOptions = true, description = ["Example command."])
class MyApp {
@Parameters(description = ["A file."])
lateinit var file: File
companion object {
@JvmStatic
fun main(args: Array<String>) {
val cmd = CommandLine(MyApp())
val copy: MutableList<String> = ArrayList(cmd.helpSectionKeys)
copy.remove(SECTION_KEY_END_OF_OPTIONS)
copy.add(copy.indexOf(SECTION_KEY_OPTION_LIST), SECTION_KEY_END_OF_OPTIONS)
cmd.helpSectionKeys = copy
cmd.usage(System.out)
}
}
}The resulting usage help message shows the -- End of Options entry has moved up, to the beginning the options list:
Usage: myapp [-hV] [--] <file>
Example command.
<file> A file.
-- This option can be used to separate command-line options from
the list of positional parameters.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
14.19.3. Changing the End of Options Entry Text
The description of the -- End of Options delimiter entry has been defined with a custom variable, to allow applications to change the text. The variable is:
-
picocli.endofoptions.description
By setting the above variable in either system properties, environment variables or the resource bundle for a command, the text can be customized.
For example, if we define this system property:
System.setProperty("picocli.endofoptions.description", "End of options. Remainder are positional parameters.");then the usage help for our above example changes to this:
Usage: myapp [-hV] [--] <file>
Example command.
<file> A file.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
-- End of options. Remainder are positional parameters.
The description of the End of Options delimiter entry can also be specified in a resource bundle for internationalization and localization.
The descriptionKey for the End of Options delimiter entry in resource bundles is:
-
picocli.endofoptions
14.20. Show Default Values
14.20.1. ${DEFAULT-VALUE} Variable
From picocli 3.2, it is possible to embed the default values in the description for an option or positional parameter by
specifying the variable ${DEFAULT-VALUE} in the description text.
Picocli uses reflection to get the default values from the annotated fields.
The variable is replaced with the default value regardless of the @Command(showDefaultValues) attribute
and regardless of the @Option(showDefaultValues) or @Parameters(showDefaultValues) attribute.
class DefaultValues {
@Option(names = {"-f", "--file"}, defaultValue = "config.xml",
description = "the file to use (default: ${DEFAULT-VALUE})")
File file;
}
CommandLine.usage(new DefaultValues(), System.out);class DefaultValues {
@Option(names = ["-f", "--file"], defaultValue = "config.xml",
description = ["the file to use (default: \${DEFAULT-VALUE})"])
lateinit var file: File
}
fun main(args: Array<String>) = CommandLine(DefaultValues()).usage(System.out)This produces the following usage help:
Usage: <main class> [-f=<file>] -f, --file=<file> the file to use (default: config.xml)
14.20.2. ${COMPLETION-CANDIDATES} Variable
Similarly, it is possible to embed the completion candidates in the description for an option or positional parameter by
specifying the variable ${COMPLETION-CANDIDATES} in the description text.
This works for java enum classes and for options or positional parameters of non-enum types for which completion candidates are specified.
enum Lang { java, groovy, kotlin, javascript, frege, clojure }
static class MyAbcCandidates extends ArrayList<String> {
MyAbcCandidates() { super(Arrays.asList("A", "B", "C")); }
}
class ValidValuesDemo {
@Option(names = "-l", description = "Enum values: ${COMPLETION-CANDIDATES}")
Lang lang = null;
@Option(names = "-o", completionCandidates = MyAbcCandidates.class,
description = "Candidates: ${COMPLETION-CANDIDATES}")
String option;
}
CommandLine.usage(new ValidValuesDemo(), System.out);enum class Lang { java, groovy, kotlin, javascript, frege, clojure }
class MyAbcCandidates : ArrayList<String?>(listOf("A", "B", "C"))
class ValidValuesDemo {
@Option(names = ["-l"], description = ["Enum values: \${COMPLETION-CANDIDATES}"])
lateinit var lang: Lang
@Option(names = ["-o"], completionCandidates = MyAbcCandidates::class,
description = ["Candidates: \${COMPLETION-CANDIDATES}"])
lateinit var option: String
}
fun main(args: Array<String>) = CommandLine(ValidValuesDemo()).usage(System.out)This produces the following usage help:
Usage: <main class> [-l=<lang>] [-o=<option>] -l=<lang> Enum values: java, groovy, kotlin, javascript, frege, clojure -o=<option> Candidates: A, B, C
14.20.3. Legacy Configuration for Displaying Default Values
Prior to picocli 3.2, you need to use the @Command(showDefaultValues = true) attribute to append the default value of
all non-null options and positional parameters to the description column.
Additionally, picocli 3.0 introduced a showDefaultValue attribute to the @Option and @Parameters annotation.
This allows you to specify for each individual option and positional parameter whether its default value should be shown in the usage help.
This attribute accepts three values:
-
ALWAYS- always display the default value of this option or positional parameter, evennullvalues, regardless what value ofshowDefaultValueswas specified on the command -
NEVER- don’t show the default value for this option or positional parameter, regardless what value ofshowDefaultValueswas specified on the command -
ON_DEMAND- (this is the default) only show the default value for this option or positional parameter ifshowDefaultValueswas specified on the command
These legacy mechanisms still work but for maximum flexibility use the variables explained above.
15. ANSI Colors and Styles
Using colors in your command’s output does not just look good: by contrasting important elements like option names from the rest of the message, it reduces the cognitive load on the user.
15.1. Colorized Example
Below shows the same usage help message as shown in Expanded Example, with ANSI escape codes enabled.
15.2. Usage Help with Styles and Colors
You can use colors and styles in the descriptions, header and footer of the usage help message.
Picocli supports a custom markup notation for mixing colors and styles in text,
following a convention introduced by Jansi, where
@| starts a styled section, and |@ ends it.
Immediately following the @| is a comma-separated list of colors and styles, so @|STYLE1[,STYLE2]… text|@.
For example:
@Command(description = "Custom @|bold,underline styles|@ and @|fg(red) colors|@.")@Command(description = ["Custom @|bold,underline styles|@ and @|fg(red) colors|@."])
| Pre-defined Styles | Pre-defined Colors |
|---|---|
bold |
black |
faint |
red |
underline |
green |
italic |
yellow |
blink |
blue |
reverse |
magenta |
reset |
cyan |
white |
Colors are applied as foreground colors by default.
You can set background colors by specifying bg(<color>).
For example, @|bg(red) text with red background|@.
Similarly, fg(<color>) explicitly sets the foreground color.
The example below shows how this markup can be used to add colors and styles to the headings and descriptions of a usage help message:
@Command(name = "commit",
sortOptions = false,
headerHeading = "@|bold,underline Usage|@:%n%n",
synopsisHeading = "%n",
descriptionHeading = "%n@|bold,underline Description|@:%n%n",
parameterListHeading = "%n@|bold,underline Parameters|@:%n",
optionListHeading = "%n@|bold,underline Options|@:%n",
header = "Record changes to the repository.",
description = "Stores the current contents of the index in a new commit " +
"along with a log message from the user describing the changes.")
class GitCommit { /* ... */ }@Command(name = "commit",
sortOptions = false,
headerHeading = "@|bold,underline Usage|@:%n%n",
synopsisHeading = "%n",
descriptionHeading = "%n@|bold,underline Description|@:%n%n",
parameterListHeading = "%n@|bold,underline Parameters|@:%n",
optionListHeading = "%n@|bold,underline Options|@:%n",
header = ["Record changes to the repository."],
description = ["Stores the current contents of the index in a new commit " +
"along with a log message from the user describing the changes."])
class GitCommit { /* ... */ }
Markup styles cannot be nested, for example: @|bold this @|underline that|@|@ will not work. You can achieve the same by combining styles, for example: @|bold this|@ @|bold,underline that|@ will work fine.
|
As of picocli 4.2, custom markup like @|bold mytext|@, @|italic mytext|@ etc. can also be converted to custom markup like <b>mytext</b> and <i>mytext</i> in HTML, or *mytext* and _mytext_ in lightweight markup languages like AsciiDoc.
Applications can control this by setting a ColorScheme with a custom markup map.
This feature is used to generate man page documentation.
15.3. Styles and Colors in Application Output
The use of ANSI colors and styles is not limited to the usage help and version information.
Applications can use the picocli Ansi class directly to create colored output.
By using the Ansi.AUTO enum value, picocli will auto-detect whether it can emit ANSI escape codes or only the plain text.
import picocli.CommandLine.Help.Ansi;
// ...
String str = Ansi.AUTO.string("@|bold,green,underline Hello, colored world!|@");
System.out.println(str);import picocli.CommandLine.Help.Ansi;
// ...
val str: String = Ansi.AUTO.string("@|bold,green,underline Hello, colored world!|@")
println(str)15.4. More Colors
Most terminals support a 256 color indexed palette:
0x00-0x07: standard colors (the named colors) 0x08-0x0F: high intensity colors (often similar to named colors + bold style) 0x10-0xE7: 6 × 6 × 6 cube (216 colors): 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5) 0xE8-0xFF: grayscale from black to white in 24 steps
Colors from the 256 color palette can be specified by their index values or by their RGB components.
RGB components must be separated by a semicolon ; and each component must be between 0 and 5, inclusive.
For example, @|bg(0;5;0) text with red=0, green=5, blue=0 background|@,
or @|fg(46) the same color by index, as foreground color|@.
15.5. Configuring Fixed Elements
15.5.1. Color Scheme
Picocli uses a default color scheme for options, parameters and commands. There are no annotations to modify this color scheme, but it can be changed programmatically.
The below code snippet shows how a custom color scheme can be specified to configure the usage help message style:
// see also CommandLine.Help.defaultColorScheme()
ColorScheme colorScheme = new ColorScheme.Builder()
.commands (Style.bold, Style.underline) // combine multiple styles
.options (Style.fg_yellow) // yellow foreground color
.parameters (Style.fg_yellow)
.optionParams(Style.italic)
.errors (Style.fg_red, Style.bold)
.stackTraces (Style.italic)
.applySystemProperties() // optional: allow end users to customize
.build();
CommandLine.usage(annotatedObject, System.out, colorScheme);
// ...// see also CommandLine.Help.defaultColorScheme()
val colorScheme: Help.ColorScheme = ColorScheme.Builder()
.commands (Style.bold, Style.underline) // combine multiple styles
.options (Style.fg_yellow) // yellow foreground color
.parameters (Style.fg_yellow)
.optionParams(Style.italic)
.errors (Style.fg_red, Style.bold)
.stackTraces (Style.italic)
.applySystemProperties() // optional: allow end users to customize
.build()
CommandLine.usage(annotatedObject, System.out, colorScheme)When using the execute API, you can configure a ColorScheme like this:
public static void main(String[] args) {
ColorScheme colorScheme = createColorScheme();
new CommandLine(new MyApp())
.setColorScheme(colorScheme) // use this color scheme in the usage help message
.execute(args);
}fun main(args: Array<String>) {
val colorScheme: ColorScheme = createColorScheme()
CommandLine(MyApp())
.setColorScheme(colorScheme) // use this color scheme in the usage help message
.execute(*args)
}15.5.2. Color Scheme Overrides
The following system properties override the color scheme styles. This allows end users to adjust for their individual terminal color setup.
picocli.color.commands picocli.color.options picocli.color.parameters picocli.color.optionParams picocli.color.errors picocli.color.stackTraces
For example:
java -Dpicocli.color.options=blink,blue -Dpicocli.color.parameters=reverse com.app.MainSystem property values may specify multiple comma separated styles.
15.6. Supported Platforms
Picocli will only emit ANSI escape codes on supported platforms. For details, see Heuristics for Enabling ANSI.
15.6.1. Unix and Linux
Most Unix and Linux platforms support ANSI colors natively. On Windows, when picocli detects it is running under a Unix variant like Cygwin or MSYS(2) on Windows it will display ANSI colors and styles, otherwise it will not emit ANSI codes.
15.6.2. Windows
Displaying colors on Windows Command Console and PowerShell requires a bit of extra work.
The easiest way to accomplish this is to use the Jansi library in your application.
| None of the below is mandatory. If not supported, picocli will simply not emit ANSI escape codes, and everything will work without colors. |
Jansi
To use Jansi, you need to enable it in your application. For example:
import org.fusesource.jansi.AnsiConsole;
// ...
public static void main(String[] args) {
AnsiConsole.systemInstall(); // enable colors on Windows
new CommandLine(new WindowsJansiDemo()).execute(args);
AnsiConsole.systemUninstall(); // cleanup when done
}import org.fusesource.jansi.AnsiConsole;
// ...
fun main(args: Array<String>) {
AnsiConsole.systemInstall() // enable colors on Windows
CommandLine(WindowsJansiDemo()).execute(*args)
AnsiConsole.systemUninstall() // cleanup when done
}Jansi in GraalVM Native Images
In Java applications compiled to a GraalVM native image for Windows, Jansi by itself is insufficient to show colors. This is partly because GraalVM requires configuration and partly because Jansi internally depends on non-standard system properties, without a graceful fallback if these properties are absent (as is the case in GraalVM).
Users may be interested in combining Jansi with picocli-jansi-graalvm until this issue is fixed. Example usage:
import picocli.jansi.graalvm.AnsiConsole; // not org.fusesource.jansi.AnsiConsole
// ...
public static void main(String[] args) {
int exitCode;
try (AnsiConsole ansi = AnsiConsole.windowsInstall()) {
exitCode = new CommandLine(new MyApp()).execute(args);
}
System.exit(exitCode);
}import picocli.jansi.graalvm.AnsiConsole // not org.fusesource.jansi.AnsiConsole
// ...
fun main(args: Array<String>) {
val exitCode: Int
AnsiConsole.windowsInstall().use
{ exitCode = CommandLine(MyApp()).execute(*args) }
System.exit(exitCode)
}For Reference: Without Jansi on Windows 10 Command Console and PowerShell
| As of this writing, the practical way to get colors in Command Console and PowerShell is to use Jansi. The below is just for reference. |
Starting from Windows 10, the Windows Console supports ANSI escape sequences,
but it’s not enabled by default.
Unless the specific software you’re using (e.g. java) enables ANSI processing by calling the SetConsoleMode API with the ENABLE_VIRTUAL_TERMINAL_PROCESSING (0x0400) flag (java doesn’t), you won’t see colors or get ANSI processing for that application.
Note that there is a registry setting to change the global default from opt in to opt out. This Stack Overflow answer has more details.
Note that picocli’s heuristics for enabling ANSI currently do not include detecting whether support for Virtual Terminal / ANSI escape sequences has been turned on or off via SetConsoleMode or a registry change.
So just making these changes is not sufficient to let a picocli-based application show colors.
Applications that enabled colors via SetConsoleMode may want to set system property picocli.ansi to tty.
Environments that enabled colors via a Windows Registry change may want to set environment variable CLICOLOR=1.
|
For Reference: Windows Subsystem for Linux (WSL)
You may want to recommend your users to try getting Windows Subsystem for Linux (WSL). This lets them run a GNU/Linux environment — including most command-line tools, utilities, and applications — directly on Windows, unmodified, without the overhead of a virtual machine. Picocli-based applications will show ANSI colors in WSL by default.
15.7. Forcing ANSI On/Off
You can force picocli to either always use ANSI codes or never use ANSI codes regardless of the platform:
-
Setting system property
picocli.ansitotrueforces picocli to use ANSI codes; settingpicocli.ansitofalseforces picocli to not use ANSI codes. It may be useful for your users to mention this system property in the documentation for your command line application. -
Setting system property
picocli.ansitotty(case-insensitive) forces picocli to use ANSI codes only if picocli guesses that the process is using an interactive console: eitherSystem.console() != nullor picocli guesses the application is running in a pseudo-terminal pty on a Linux emulator in Windows. Otherwise the below heuristics are used to determine whether to output ANSI escape codes. -
You can decide to force disable or force enable ANSI escape codes programmatically by specifying
Ansi.ONorAnsi.OFFwhen invokingCommandLine.usage. This overrides the value of system propertypicocli.ansi. For example:
import picocli.CommandLine.Help.Ansi;
// print usage help message to STDOUT without ANSI escape codes
CommandLine.usage(new App(), System.out, Ansi.OFF);import picocli.CommandLine.Help.Ansi
// print usage help message to STDOUT without ANSI escape codes
CommandLine.usage(App(), System.out, Ansi.OFF)15.8. Heuristics for Enabling ANSI
Below is the exact sequence of steps picocli uses to determine whether or not to emit ANSI escape codes.
-
If
Ansi.ONorAnsi.OFFis explicitly specified, either via system propertypicocli.ansior programmatically, this value is used. -
ANSI is disabled when environment variable
NO_COLORis defined (regardless of its value). -
ANSI is enabled when environment variable
CLICOLOR_FORCEis defined and has any value other than0(zero). -
ANSI is enabled when system property
os.namestarts with"Windows"and JAnsi Console is installed. -
ANSI is disabled when environment variable
CLICOLOR == 0. -
ANSI is disabled when environment variable
ConEmuANSI == OFF. -
ANSI is disabled when Picocli guesses the program’s output stream is not connected to a terminal: when
System.console()returnsnull. This check is omitted if picocli guesses the program is running in a Windows Cygwin, MSYS or MSYS2 environment: when system propertyos.namestarts with"Windows"and either environment variableTERMcontainscygwinor starts withxtermor environment variableOSTYPEis defined. -
ANSI is enabled when environment variable
ANSICONis defined. -
ANSI is enabled when environment variable
CLICOLOR == 1. -
ANSI is enabled when environment variable
ConEmuANSI == ON. -
ANSI is enabled when picocli detects the program is running in a non-Windows OS (system property
os.namedoes not start with"Windows"). -
ANSI is enabled when picocli guesses the program is running in a Cygwin, MSYS or MSYS2 environment (either environment variable
TERMcontainscygwinor starts withxtermor environment variableOSTYPEis defined).
ANSI escape codes are not emitted if none of the above apply.
16. Usage Help API
For further customization of the usage help message, picocli has a Help API.
The Help class provides a number of high-level operations, and a set of components like Layout, TextTable, IOptionRenderer, etc., that can be used to build custom help messages.
Details of the Help API are out of scope for this document, but the following sections give some idea of what is possible.
16.1. Reordering Sections
One thing you may want to do is reorder sections of the usage message or add custom sections.
Picocli 3.9 introduces new API to facilitate customizing the usage help message:
IHelpFactory allows applications to plug in Help subclasses, and
IHelpSectionRenderer allows applications to add custom sections to the usage help message, or redefine existing sections.
The usage help message is no longer hard-coded, but is now constructed from the section renderers defined in CommandLine::getHelpSectionMap (or UsageMessageSpec::sectionMap for a single CommandSpec).
By default this map contains the predefined section renderers:
import static picocli.CommandLine.Model.UsageMessageSpec.*;
// ...
// The default section renderers delegate to methods in Help for their implementation
// (using Java 8 lambda notation for brevity):
Map<String, IHelpSectionRenderer> map = new HashMap<>();
map.put(SECTION_KEY_HEADER_HEADING, help -> help.headerHeading());
map.put(SECTION_KEY_HEADER, help -> help.header());
//e.g. Usage:
map.put(SECTION_KEY_SYNOPSIS_HEADING, help -> help.synopsisHeading());
//e.g. <cmd> [OPTIONS] <subcmd> [COMMAND-OPTIONS] [ARGUMENTS]
map.put(SECTION_KEY_SYNOPSIS, help -> help.synopsis(help.synopsisHeadingLength()));
//e.g. %nDescription:%n%n
map.put(SECTION_KEY_DESCRIPTION_HEADING, help -> help.descriptionHeading());
//e.g. {"Converts foos to bars.", "Use options to control conversion mode."}
map.put(SECTION_KEY_DESCRIPTION, help -> help.description());
//e.g. %nPositional parameters:%n%n
map.put(SECTION_KEY_PARAMETER_LIST_HEADING, help -> help.parameterListHeading());
//e.g. [FILE...] the files to convert
map.put(SECTION_KEY_PARAMETER_LIST, help -> help.parameterList());
//e.g. %nOptions:%n%n
map.put(SECTION_KEY_OPTION_LIST_HEADING, help -> help.optionListHeading());
//e.g. -h, --help displays this help and exits
map.put(SECTION_KEY_OPTION_LIST, help -> help.optionList());
//e.g. %nCommands:%n%n
map.put(SECTION_KEY_COMMAND_LIST_HEADING, help -> help.commandListHeading());
//e.g. add this command adds the frup to the frooble
map.put(SECTION_KEY_COMMAND_LIST, help -> help.commandList());
map.put(SECTION_KEY_EXIT_CODE_LIST_HEADING, help -> help.exitCodeListHeading());
map.put(SECTION_KEY_EXIT_CODE_LIST, help -> help.exitCodeList());
map.put(SECTION_KEY_FOOTER_HEADING, help -> help.footerHeading());
map.put(SECTION_KEY_FOOTER, help -> help.footer());import picocli.CommandLine.Model.UsageMessageSpec.*
// ...
// The default section renderers delegate to methods in Help for their implementation
// (using lambda expressions for brevity):
val map: MutableMap<String, IHelpSectionRenderer> = HashMap()
map[SECTION_KEY_HEADER_HEADING] =
IHelpSectionRenderer { help: Help -> help.headerHeading() }
map[SECTION_KEY_HEADER] =
IHelpSectionRenderer { help: Help -> help.header() }
//e.g. Usage:
map[SECTION_KEY_SYNOPSIS_HEADING] =
IHelpSectionRenderer { help: Help -> help.synopsisHeading() }
//e.g. <cmd> [OPTIONS] <subcmd> [COMMAND-OPTIONS] [ARGUMENTS]
map[SECTION_KEY_SYNOPSIS] =
IHelpSectionRenderer { help: Help -> help.synopsis(help.synopsisHeadingLength()) }
//e.g. %nDescription:%n%n
map[SECTION_KEY_DESCRIPTION_HEADING] =
IHelpSectionRenderer { help: Help -> help.descriptionHeading() }
//e.g. {"Converts foos to bars.", "Use options to control conversion mode."}
map[SECTION_KEY_DESCRIPTION] =
IHelpSectionRenderer { help: Help -> help.description() }
//e.g. %nPositional parameters:%n%n
map[SECTION_KEY_PARAMETER_LIST_HEADING] =
IHelpSectionRenderer { help: Help -> help.parameterListHeading() }
//e.g. [FILE...] the files to convert
map[SECTION_KEY_PARAMETER_LIST] =
IHelpSectionRenderer { help: Help -> help.parameterList() }
//e.g. %nOptions:%n%n
map[SECTION_KEY_OPTION_LIST_HEADING] =
IHelpSectionRenderer { help: Help -> help.optionListHeading() }
//e.g. -h, --help displays this help and exits
map[SECTION_KEY_OPTION_LIST] =
IHelpSectionRenderer { help: Help -> help.optionList() }
//e.g. %nCommands:%n%n
map[SECTION_KEY_COMMAND_LIST_HEADING] =
IHelpSectionRenderer { help: Help -> help.commandListHeading() }
//e.g. add this command adds the frup to the frooble
map[SECTION_KEY_COMMAND_LIST] =
IHelpSectionRenderer { help: Help -> help.commandList() }
map[SECTION_KEY_EXIT_CODE_LIST_HEADING] =
IHelpSectionRenderer { help: Help -> help.exitCodeListHeading() }
map[SECTION_KEY_EXIT_CODE_LIST] =
IHelpSectionRenderer { help: Help -> help.exitCodeList() }
map[SECTION_KEY_FOOTER_HEADING] =
IHelpSectionRenderer { help: Help -> help.footerHeading() }
map[SECTION_KEY_FOOTER] =
IHelpSectionRenderer { help: Help -> help.footer() }Applications can add, remove or replace sections in this map. The CommandLine::getHelpSectionKeys method (or UsageMessageSpec::sectionKeys for a single CommandSpec) returns the section keys in the order that the usage help message should render the sections. The default keys are (in order):
-
SECTION_KEY_HEADER_HEADING
-
SECTION_KEY_HEADER
-
SECTION_KEY_SYNOPSIS_HEADING
-
SECTION_KEY_SYNOPSIS
-
SECTION_KEY_DESCRIPTION_HEADING
-
SECTION_KEY_DESCRIPTION
-
SECTION_KEY_PARAMETER_LIST_HEADING
-
SECTION_KEY_AT_FILE_PARAMETER
-
SECTION_KEY_PARAMETER_LIST
-
SECTION_KEY_OPTION_LIST_HEADING
-
SECTION_KEY_OPTION_LIST
-
SECTION_KEY_COMMAND_LIST_HEADING
-
SECTION_KEY_COMMAND_LIST
-
SECTION_KEY_EXIT_CODE_LIST_HEADING
-
SECTION_KEY_EXIT_CODE_LIST
-
SECTION_KEY_FOOTER_HEADING
-
SECTION_KEY_FOOTER
This ordering may be modified with the CommandLine::setHelpSectionKeys setter method (or UsageMessageSpec::sectionKeys(List) for a single CommandSpec).
16.1.1. Custom Help Section Example
The below example shows how to add a custom Environment Variables section to the usage help message.
// help section keys
final String SECTION_KEY_ENV_HEADING = "environmentVariablesHeading";
final String SECTION_KEY_ENV_DETAILS = "environmentVariables";
// ...
// the data to display
Map<String, String> env = new LinkedHashMap<>();
env.put("FOO", "explanation of foo");
env.put("BAR", "explanation of bar");
env.put("XYZ", "xxxx yyyy zzz");
// register the custom section renderers
CommandLine cmd = new CommandLine(new MyApp());
cmd.getHelpSectionMap().put(SECTION_KEY_ENV_HEADING,
help -> help.createHeading("Environment Variables:%n"));
cmd.getHelpSectionMap().put(SECTION_KEY_ENV_DETAILS,
help -> help.createTextTable(env).toString());
// specify the location of the new sections
List<String> keys = new ArrayList<>(cmd.getHelpSectionKeys());
int index = keys.indexOf(CommandLine.Model.UsageMessageSpec.SECTION_KEY_FOOTER_HEADING);
keys.add(index, SECTION_KEY_ENV_HEADING);
keys.add(index + 1, SECTION_KEY_ENV_DETAILS);
cmd.setHelpSectionKeys(keys);// help section keys
val SECTION_KEY_ENV_HEADING = "environmentVariablesHeading"
val SECTION_KEY_ENV_DETAILS = "environmentVariables"
// ...
// the data to display
val env: MutableMap<String, String> = LinkedHashMap()
env["FOO"] = "explanation of foo"
env["BAR"] = "explanation of bar"
env["XYZ"] = "xxxx yyyy zzz"
// register the custom section renderers
val cmd = CommandLine(MyApp())
cmd.helpSectionMap[SECTION_KEY_ENV_HEADING] =
IHelpSectionRenderer { help: Help -> help.createHeading("Environment Variables:%n") }
cmd.helpSectionMap[SECTION_KEY_ENV_DETAILS] =
IHelpSectionRenderer { help: Help -> help.createTextTable(env).toString() }
// specify the location of the new sections
val keys = ArrayList(cmd.helpSectionKeys)
val index = keys.indexOf(SECTION_KEY_FOOTER_HEADING)
keys.add(index, SECTION_KEY_ENV_HEADING)
keys.add(index + 1, SECTION_KEY_ENV_DETAILS)
cmd.helpSectionKeys = keysMore examples for customizing the usage help message are here.
16.2. Custom Layout
Picocli also supports unconventional option list layouts. An example of an unconventional layout is the zip application, which shows multiple options per row:
CommandLine.usage(new ZipHelpDemo(), System.out);CommandLine.usage(ZipHelpDemo(), System.out)Copyright (c) 1990-2008 Info-ZIP - Type 'zip "-L"' for software license. Zip 3.0 (July 5th 2008). Command: zip [-options] [-b path] [-t mmddyyyy] [-n suffixes] [zipfile list] [-xi list] The default action is to add or replace zipfile entries from list, which can include the special name - to compress standard input. If zipfile and list are omitted, zip compresses stdin to stdout. -f freshen: only changed files -u update: only changed or new files -d delete entries in zipfile -m move into zipfile (delete OS files) -r recurse into directories -j junk (don't record) directory names -0 store only -l convert LF to CR LF (-ll CR LF to LF) -1 compress faster -9 compress better -q quiet operation -v verbose operation/print version info -c add one-line comments -z add zipfile comment -@ read names from stdin -o make zipfile as old as latest entry -x exclude the following names -i include only the following names -F fix zipfile (-FF try harder) -D do not add directory entries -A adjust self-extracting exe -J junk zipfile prefix (unzipsfx) -T test zipfile integrity -X eXclude eXtra file attributes -y store symbolic links as the link instead of the referenced file -e encrypt -n don't compress these suffixes -h2 show more help
This can be achieved in picocli by subclassing the Help.Layout class. See the CustomLayoutDemo class in the picocli tests for how to achieve this.
17. Subcommands
Sophisticated command-line tools, like the prominent git tool, have many subcommands (e.g., commit, push, …), each with its own set of options and positional parameters.
Picocli makes it very easy to have commands with subcommands, and sub-subcommands, to any level of depth.
17.1. Subcommand Examples
If you want to jump ahead and see some examples first, these resources may be helpful:
-
The Executing Subcommands section below has an example that uses both the
@Command(subcommands = <class>)syntax and the@Command-annotated method syntax. -
The Quick Guide has an example application featuring subcommands, with a detailed explanation.
-
The
picocli-examplescode module has a subcommand section with several minimal code samples, explaining the use of subcommands both via methods and when defined in their own class. -
The
picocli-examplescode module also shows subcommand examples in other languages, like Scala and Kotlin, as well as Java.
17.2. Registering Subcommands Declaratively
Subcommands can be registered declaratively with the @Command annotation’s subcommands attribute since picocli 0.9.8.
This is the recommended way when you want to use the picocli annotation processor to generate documentation, autocompletion scripts or GraalVM configuration files.
@Command(subcommands = {
GitStatus.class,
GitCommit.class,
GitAdd.class,
GitBranch.class,
GitCheckout.class,
GitClone.class,
GitDiff.class,
GitMerge.class,
GitPush.class,
GitRebase.class,
GitTag.class
})
public class Git { /* ... */ }@Command(subcommands = [
GitStatus.class,
GitCommit.class,
GitAdd.class,
GitBranch.class,
GitCheckout.class,
GitClone.class,
GitDiff.class,
GitMerge.class,
GitPush.class,
GitRebase.class,
GitTag.class
])
public class Git { /* ... */ }@Command(subcommands = [
GitStatus::class,
GitCommit::class,
GitAdd::class,
GitBranch::class,
GitCheckout::class,
GitClone::class,
GitDiff::class,
GitMerge::class,
GitPush::class,
GitRebase::class,
GitTag::class]
)
public class Git { /* ... */ }@Command(subcommands = Array(
classOf[GitStatus],
classOf[GitCommit],
classOf[GitAdd],
classOf[GitBranch],
classOf[GitCheckout],
classOf[GitClone],
classOf[GitDiff],
classOf[GitMerge],
classOf[GitPush],
classOf[GitRebase],
classOf[GitTag]
))
class Git { /* ... */ }Subcommands referenced in a subcommands attribute must have a @Command annotation with a name attribute, or an exception is thrown from the CommandLine constructor.
This name will be used both for generating usage help and for recognizing subcommands when parsing the command line.
Command names are case-sensitive by default, but this is customizable.
Custom type converters registered on a CommandLine instance will apply to all subcommands that were declared on the main command with the subcommands annotation.
Subcommands referenced in a subcommands attribute need to have a public no-argument constructor to be instantiated, unless a Custom Factory is installed to instantiate classes.
Prior to picocli 4.2, the declared subcommands were instantiated immediately when the top-level CommandLine (the new CommandLine(new Git()) object in the above example) was constructed.
From picocli 4.2, the declared subcommands are not instantiated until they are matched on the command line, unless they have a @Spec or @ParentCommand-annotated field; these are injected during initialization, and in order to inject them the subcommand is instantiated during initialization.
17.3. Subcommands as Methods
As of picocli 3.6 it is possible to register subcommands in a very compact manner by having a @Command class with @Command-annotated methods.
The methods are automatically registered as subcommands of the enclosing @Command class.
See the command methods section for more details and examples.
The picocli-examples module has an minimal example application, demonstrating the definition of subcommands via methods. This example was coded in Java, Kotlin and Scala.
17.4. Registering Subcommands Programmatically
Subcommands can be registered with the CommandLine.addSubcommand method.
You pass in the name of the command and the annotated object to populate with the subcommand options.
The specified name is used by the parser to recognize subcommands in the command line arguments.
CommandLine commandLine = new CommandLine(new Git())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("add", new GitAdd())
.addSubcommand("branch", new GitBranch())
.addSubcommand("checkout", new GitCheckout())
.addSubcommand("clone", new GitClone())
.addSubcommand("diff", new GitDiff())
.addSubcommand("merge", new GitMerge())
.addSubcommand("push", new GitPush())
.addSubcommand("rebase", new GitRebase())
.addSubcommand("tag", new GitTag());def commandLine = new CommandLine(new Git())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("add", new GitAdd())
.addSubcommand("branch", new GitBranch())
.addSubcommand("checkout", new GitCheckout())
.addSubcommand("clone", new GitClone())
.addSubcommand("diff", new GitDiff())
.addSubcommand("merge", new GitMerge())
.addSubcommand("push", new GitPush())
.addSubcommand("rebase", new GitRebase())
.addSubcommand("tag", new GitTag());val commandLine = CommandLine(Git())
.addSubcommand("status", GitStatus())
.addSubcommand("commit", GitCommit())
.addSubcommand("add", GitAdd())
.addSubcommand("branch", GitBranch())
.addSubcommand("checkout", GitCheckout())
.addSubcommand("clone", GitClone())
.addSubcommand("diff", GitDiff())
.addSubcommand("merge", GitMerge())
.addSubcommand("push", GitPush())
.addSubcommand("rebase", GitRebase())
.addSubcommand("tag", GitTag())val commandLine: CommandLine = new CommandLine(new Git())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("add", new GitAdd())
.addSubcommand("branch", new GitBranch())
.addSubcommand("checkout", new GitCheckout())
.addSubcommand("clone", new GitClone())
.addSubcommand("diff", new GitDiff())
.addSubcommand("merge", new GitMerge())
.addSubcommand("push", new GitPush())
.addSubcommand("rebase", new GitRebase())
.addSubcommand("tag", new GitTag())It is strongly recommended that subcommands have a @Command annotation with name and description attributes.
From picocli 3.1, the usage help synopsis of the subcommand shows not only the subcommand name but also the parent command name.
For example, if the git command has a commit subcommand, the usage help for the commit subcommand shows Usage: git commit <options>.
| Note on custom type converters: custom type converters are registered only with the subcommands and nested sub-subcommands that were added before the custom type was registered. To ensure a custom type converter is available to all subcommands, register the type converter last, after adding subcommands. |
17.5. Executing Subcommands
The easiest way to design an application with subcommands is to let each command and subcommand either be a class that implements Runnable or Callable, or a @Command-annotated method.
This will allow you to parse the command line, deal with requests for help and requests for version information, deal with invalid user input, and invoke the business logic of the user-specified subcommand - all of that - in one line of code: the execute method.
For example:
@Command(name = "foo", subcommands = Bar.class)
class Foo implements Callable<Integer> {
@Option(names = "-x") int x;
@Override public Integer call() {
System.out.printf("hi from foo, x=%d%n", x);
boolean ok = true;
return ok ? 0 : 1; // exit code
}
public static void main(String... args) {
int exitCode = new CommandLine(new Foo()).execute(args);
System.exit(exitCode);
}
}
@Command(name = "bar", description = "I'm a subcommand of `foo`")
class Bar implements Callable<Integer> {
@Option(names = "-y") int y;
@Override public Integer call() {
System.out.printf("hi from bar, y=%d%n", y);
return 23;
}
@Command(name = "baz", description = "I'm a subcommand of `bar`")
int baz(@Option(names = "-z") int z) {
System.out.printf("hi from baz, z=%d%n", z);
return 45;
}
}@Command(name = "foo", subcommands = Bar.class)
class Foo implements Callable<Integer> {
@Option(names = "-x") def x
@Override public Integer call() {
println "hi from foo, x=$x"
def ok = true;
return ok ? 0 : 1 // exit code
}
public static void main(String... args) {
def exitCode = new CommandLine(new Foo()).execute(args)
System.exit(exitCode)
}
}
@Command(name = "bar", description = "I'm a subcommand of `foo`")
class Bar implements Callable<Integer> {
@Option(names = "-y") int y
@Override public Integer call() {
println "hi from bar, y=$y"
return 23
}
@Command(name = "baz", description = "I'm a subcommand of `bar`")
int baz(@Option(names = "-z") int z) {
println "hi from baz, z=$z"
return 45
}
}@Command(name = "foo", subcommands = [Bar::class])
class Foo : Callable<Int> {
@Option(names = ["-x"]) var x: Int = 0
override fun call(): Int {
println("hi from foo, x=$x")
var ok: Boolean = true
return if (ok) 0 else 1 // exit code
}
}
fun main(args: Array<String>) : Unit = exitProcess(CommandLine(Foo()).execute(*args))
@Command(name = "bar", description = ["I'm a subcommand of `foo`"])
class Bar : Callable<Int> {
@Option(names = ["-y"]) var y: Int = 0
override fun call(): Int {
println("hi form bar, y=$y")
return 23
}
@Command(name = "baz", description = ["I'm a subcommand of `bar`"])
fun baz( @Option(names = ["-z"]) z: Int) : Int {
println("hi from baz, z=$z")
return 45
}
}@Command(name = "foo", subcommands = Array(classOf[Bar]))
class Foo extends Callable[Integer] {
@Option(names = Array("-x"))
var x = 0
override def call: Integer = {
println(s"hi from foo, $x")
val ok = true
if (ok) 0 else 1 // exit code
}
}
object Foo{
def main(args: Array[String]): Unit = {
val exitCode : Int = new CommandLine(new Foo()).execute(args: _*)
System.exit(exitCode)
}
}
@Command(name = "bar", description = Array("I'm a subcommand of `foo`")) class Bar extends Callable[Integer] {
@Option(names = Array("-y"))
var y = 0
override def call: Integer = {
println(s"hi from bar, y=$y")
23
}
@Command(name = "baz", description = Array("I'm a subcommand of `bar`"))
def baz(@Option(names = Array("-z")) z: Int): Int = {
println(s"hi from baz, z=$z")
45
}
}To test our example on Linux, we created an alias foo that invokes our Java application.
This could also be a script or a function that calls our Java program:
alias foo='java Foo'Next, we call our top-level command with an option like this:
$ foo -x 123
hi from foo, x=123
#check the exit code
$ echo $?
0We can also specify a subcommand:
$ foo -x 123 bar -y=456
hi from bar, y=456
#check the exit code
$ echo $?
23And finally, we can also specify a sub-subcommand:
$ foo bar baz -z=789
hi from baz, z=789
#check the exit code
$ echo $?
45As you can see, the last specified command or subcommand is executed and its exit code is returned. See also Executing Commands with Subcommands for details on configuring this.
17.6. Initialization Before Execution
Sometimes an application needs to take some action before execution.
With a single command, you can simply do this in the beginning of the run or call method, but in an application with subcommands you don’t want to repeat this code in every subcommand.
One idea is to put the shared initialization logic in a custom execution strategy. For example:
@Command(subcommands = {Sub1.class, Sub2.class, Sub3.class})
class MyApp implements Runnable {
// A reference to this method can be used as a custom execution strategy
// that first calls the init() method,
// and then delegates to the default execution strategy.
private int executionStrategy(ParseResult parseResult) {
init(); // custom initialization to be done before executing any command or subcommand
return new CommandLine.RunLast().execute(parseResult); // default execution strategy
}
private void init() {
// ...
}
public static void main(String[] args) {
MyApp app = new MyApp();
new CommandLine(app)
.setExecutionStrategy(app::executionStrategy)
.execute(args);
}
// ...
}@Command(subcommands = [Sub1.class, Sub2.class, Sub3.class])
class MyApp implements Runnable {
// A reference to this method can be used as a custom execution strategy
// that first calls the init() method,
// and then delegates to the default execution strategy.
def int executionStrategy(ParseResult parseResult) {
init(); // custom initialization to be done before executing any command or subcommand
return new CommandLine.RunLast().execute(parseResult); // default execution strategy
}
def void init() {
// ...
}
public static void main(String[] args) {
def app = new MyApp();
new CommandLine(app)
.setExecutionStrategy(app.&executionStrategy)
.execute(args);
}
// ...
}@Command(subcommands = [Sub1::class, Sub2::class, Sub3::class])
class MyApp : Runnable {
// A reference to this method can be used as a custom execution strategy
// that first calls the init() method,
// and then delegates to the default execution strategy.
private fun executionStrategy(parseResult: ParseResult): Int {
init() // custom initialization to be done before executing any command or subcommand
return RunLast().execute(parseResult) // default execution strategy
}
private fun init() {
// ...
}
companion object {
@JvmStatic
fun main(args: Array<String>) {
val app = MyApp()
CommandLine(app)
.setExecutionStrategy {
parseResult: ParseResult -> app.executionStrategy(parseResult) }
.execute(*args)
}
}
// ...
}@Command(subcommands = Array(classOf[Sub1], classOf[Sub2], classOf[Sub3]))
class MyApp extends Runnable {
// A reference to this method can be used as a custom execution strategy
// that first calls the init() method,
// and then delegates to the default execution strategy.
private def executionStrategy(parseResult: ParseResult ) = {
init() // custom initialization to be done before executing any command or subcommand
new CommandLine.RunLast().execute(parseResult) // default execution strategy
}
private def init(): Unit = {
// ...
}
}
object MyApp {
def main(args: Array[String]): Unit = {
val app = new MyApp
new CommandLine(app)
.setExecutionStrategy(app.executionStrategy)
.execute(args: _*)
}
}This ensures the init method is called after the command line is parsed (so all options and positional parameters are assigned) but before the user-specified subcommand is executed.
The logging example in picocli-examples shows how this can be used to configure the Log4j log level based on a --verbose option, prior to execution.
17.7. @ParentCommand Annotation
In command line applications with subcommands, options of the top level command are often intended as "global" options that apply to all the subcommands. Prior to picocli 2.2, subcommands had no easy way to access their parent command options unless the parent command made these values available in a global variable.
The @ParentCommand annotation introduced in picocli 2.2 makes it easy for subcommands to access their parent command options:
subcommand fields annotated with @ParentCommand are initialized with a reference to the parent command.
For example:
@Command(name = "fileutils", subcommands = ListFiles.class)
class FileUtils {
@Option(names = {"-d", "--directory"},
description = "this option applies to all subcommands")
File baseDirectory;
}@Command(name = "fileutils", subcommands = [ListFiles.class])
class FileUtils {
@Option(names = ["-d", "--directory"],
description = "this option applies to all subcommands")
def baseDirectory;
}@Command(name = "fileutils", subcommands = [ListFiles::class])
class FileUtils {
@Option(names = ["-d", "--directory"],
description = ["this option applies to all subcommands"])
var baseDirectory: File? = null
}@Command(name = "fileutils", subcommands = Array(classOf[ListFiles]))
class FileUtils {
@Option(names = Array("-d", "--directory"),
description = Array("this option applies to all subcommands"))
var baseDirectory: File = null
}The above top-level command has a --directory option that applies to its subcommands.
The ListFiles subcommand can use the @ParentCommand annotation to get a reference to the parent command, so it can easily access the parent command options.
@Command(name = "list")
class ListFiles implements Runnable {
@ParentCommand
private FileUtils parent; // picocli injects reference to parent command
@Option(names = {"-r", "--recursive"},
description = "Recursively list subdirectories")
private boolean recursive;
@Override
public void run() {
list(new File(parent.baseDirectory, "."));
}
private void list(File dir) {
System.out.println(dir.getAbsolutePath());
if (dir.isDirectory()) {
for (File f : dir.listFiles()) {
if (f.isDirectory() && recursive) {
list(f);
} else {
System.out.println(f.getAbsolutePath());
}
}
}
}
}@Command(name = "list")
class ListFiles : Runnable {
@ParentCommand
private val parent: FileUtils? = null // picocli injects reference to parent command
@Option(names = ["-r", "--recursive"],
description = ["Recursively list subdirectories"])
private var recursive = false
override fun run() {
list(File(parent!!.baseDirectory, "."))
}
private fun list(dir: File) {
println(dir.absolutePath)
if (dir.isDirectory) {
for (f in dir.listFiles()) {
if (f.isDirectory && recursive) {
list(f)
} else {
println(f.absolutePath)
}
}
}
}
}17.8. Subcommand Aliases
Commands may optionally define an aliases attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:
@Command(name = "status", aliases = {"st"}, description = "Show the working tree status.")
class GitStatus { ... }@Command(name = "status", aliases = ["st"], description = ["Show the working tree status."])
class GitStatus { ... }Would result in this help fragment:
status, st Show the working tree status.
17.9. Inherited Command Attributes
Picocli 4.6 adds support for inheriting @Command attributes with the scope = ScopeType.INHERIT annotation.
Commands with this scope have their @Command attributes copied to all subcommands (and sub-subcommands, to any level of depth).
When a subcommand specifies an explicit value in its @Command annotation, this value is used instead of the inherited value.
For example:
@Command(name = "app", scope = ScopeType.INHERIT,
mixinStandardHelpOptions = true, version = "app version 1.0",
header = "App header",
description = "App description",
footerHeading = "Copyright%n", footer = "(c) Copyright by the authors",
showAtFileInUsageHelp = true)
class App implements Runnable {
@Option(names = "-x") int x;
public void run() { System.out.printf("Hello from app!%nx = %d%n", x); }
@Command(header = "Subcommand header", description = "Subcommand description")
void sub(@Option(names = "-y") int y) {
System.out.printf("Hello app sub!%ny = %d", y);
}
}@Command(name = "app", scope = ScopeType.INHERIT,
mixinStandardHelpOptions = true, version = ["app version 1.0"],
header = ["App header"],
description = ["App description"],
footerHeading = "Copyright%n", footer = ["(c) Copyright by the authors"],
showAtFileInUsageHelp = true)
class App : Runnable {
@Option(names = ["-x"]) var x = 0
override fun run() { println("Hello from app!\nx = $x") }
@Command(header = ["Subcommand header"], description = ["Subcommand description"])
fun sub(@Option(names = ["-y"]) y: Int) {
println("Hello from sub!\ny = $y")
}
}The app command in the above example has scope = ScopeType.INHERIT, so its @Command properties are inherited by the sub subcommand.
The sub subcommand defines its own header and description, so these are not inherited from the parent command.
The help message for the subcommand looks like this:
Subcommand header
Usage: app sub [-hV] [-y=<arg0>] [@<filename>...]
Subcommand description
[@<filename>...] One or more argument files containing options.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
-y=<arg0>
Copyright
(c) Copyright by the authors
Note that the subcommand has inherited the mixed-in standard help options (--help and --version), the @file usage help, and the footer and footer heading.
It also inherited the version string, shown when the user invokes app sub --version.
When a command has scope = INHERIT, the following attributes are copied to its subcommands:
-
all usage help attributes: description, descriptionHeading, header, headerHeading, footer, footerHeading, customSynopsis, synopsisHeading, synopsisSubcommandLabel, abbreviateSynopsis, optionListHeading, parameterListHeading, commandListHeading, exitCodeList, exitCodeListHeading, requiredOptionMarker, showDefaultValues, sortOptions, autoWidth, width, showAtFileInUsageHelp, showEndOfOptionsDelimiterInUsageHelp, and hidden
-
exit codes: exitCodeOnSuccess, exitCodeOnUsageHelp, exitCodeOnVersionHelp, exitCodeOnInvalidInput, exitCodeOnExecutionException
-
the help and version options mixed in by
mixinStandardHelpOptions -
separator between option and option parameter
-
version
-
versionProvider
-
defaultValueProvider
-
subcommandsRepeatable
-
whether this command is a
helpCommand
Attributes that are not copied include:
-
command name
-
command aliases
-
options and parameters (other than the help and version options mixed in by
mixinStandardHelpOptions) -
other mixins than
mixinStandardHelpOptions -
subcommands
-
argument groups
17.10. Inherited Options
Picocli 4.3 adds support for "inherited" options.
Options defined with scope = ScopeType.INHERIT are shared with all subcommands (and sub-subcommands, to any level of depth).
Applications can define an inherited option on the top-level command, in one place, to allow end users to specify this option anywhere: not only on the top-level command, but also on any of the subcommands and nested sub-subcommands.
|
Inherited options currently cannot be used in Argument Groups. Applications that want to reuse Argument Groups across subcommands need to use Mixins. See this example for sharing an Argument Group defining global options between subcommands. |
Below is an example where an inherited option is used to configure logging.
@Command(name = "app", subcommands = Sub.class)
class App implements Runnable {
private static Logger logger = LogManager.getLogger(App.class);
@Option(names = "-x", scope = ScopeType.LOCAL) // option is not shared: this is the default
int x;
@Option(names = "-v", scope = ScopeType.INHERIT) // option is shared with subcommands
public void setVerbose(boolean[] verbose) {
// Configure log4j.
// (This is a simplistic example: a real application may use more levels and
// perhaps configure only the ConsoleAppender level instead of the root log level.)
Configurator.setRootLevel(verbose.length > 0 ? Level.DEBUG : Level.INFO);
}
public void run() {
logger.debug("-x={}", x);
}
}
@Command(name = "sub")
class Sub implements Runnable {
private static Logger logger = LogManager.getLogger(Sub.class);
@Option(names = "-y")
int y;
public void run() {
logger.debug("-y={}", y);
}
}@Command(name = "app", subcommands = [Sub::class])
class App : Runnable {
private val logger = LogManager.getLogger(App::class.java)
@Option(names = ["-x"], scope = ScopeType.LOCAL) // option is not shared by default
var x = 0
@Option(names = ["-v"], scope = ScopeType.INHERIT) // option is shared with subcommands
fun setVerbose(verbose: BooleanArray) {
// Configure log4j.
// (This is a simplistic example: a real application may use more levels and
// perhaps configure only the ConsoleAppender level instead of the root log level.)
Configurator.setRootLevel(if (verbose.size > 0) Level.DEBUG else Level.INFO)
}
override fun run() {
logger.debug("-x={}", x)
}
}
@Command(name = "sub")
class Sub : Runnable {
private val logger = LogManager.getLogger(Sub::class.java)
@Option(names = ["-y"])
var y = 0
override fun run() {
logger.debug("-y={}", y)
}
}Users can specify the -v option on either the top-level command or on the subcommand, and it will have the same effect.
# the -v option can be specified on the top-level command java App -x=3 -v sub -y=4
Specifying the -v option on the subcommand will have the same effect. For example:
# specifying the -v option on the subcommand also changes the log level java App -x=3 sub -y=4 -v
|
Subcommands don’t need to do anything to receive inherited options, but a potential drawback is that subcommands do not get a reference to inherited options. Subcommands that need to inspect the value of an inherited option can use the |
17.11. Manually Parsing Subcommands
For the following example, we assume we created an alias git that invokes our Java application. This could also be a script or a function that calls our Java program:
alias git='java picocli.Demo$Git'Next, we call our command with some arguments like this:
git --git-dir=/home/rpopma/picocli status -sb -unoWhere git (actually java picocli.Demo$Git) is the top-level command, followed by a global option and a subcommand status with its own options.
Setting up the parser and parsing the command line could look like this:
public static void main(String... args) {
// Set up the parser
CommandLine commandLine = new CommandLine(new Git());
// add subcommands programmatically (not necessary if the parent command
// declaratively registers the subcommands via annotation)
commandLine.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
// ...
;
// Invoke the parseArgs method to parse the arguments
ParseResult parsed = commandLine.parseArgs(args);
handleParseResult(parsed);
}fun main(args: Array<String>) {
// Set up the parser
val commandLine = CommandLine(Git())
// add subcommands programmatically (not necessary if the parent command
// declaratively registers the subcommands via annotation)
commandLine.addSubcommand("status", GitStatus())
.addSubcommand("commit", GitCommit())
// ...
// Invoke the parseArgs method to parse the arguments
val parsed = commandLine.parseArgs(*args)
handleParseResult(parsed)
}The CommandLine.parseArgs method returns a ParseResult that can be queried to get information about
the top-level command (the Java class invoked by git in this example).
The ParseResult.subcommand() method returns a nested ParseResult if the parser found a subcommand.
This can be recursively queried until the last nested subcommand was found and the ParseResult.subcommand() method returns null.
private void handleParseResult(ParseResult parsed) {
assert parsed.subcommand() != null : "at least 1 command and 1 subcommand found";
ParseResult sub = parsed.subcommand();
assert parsed.commandSpec().userObject().getClass() == Git.class : "main command";
assert sub.commandSpec().userObject().getClass() == GitStatus.class : "subcommand";
Git git = (Git) parsed.commandSpec().userObject();
assert git.gitDir.equals(new File("/home/rpopma/picocli"));
GitStatus gitstatus = (GitStatus) sub.commandSpec().userObject();
assert gitstatus.shortFormat : "git status -s";
assert gitstatus.branchInfo : "git status -b";
assert !gitstatus.showIgnored : "git status --showIgnored not specified";
assert gitstatus.mode == GitStatusMode.no : "git status -u=no";
}private fun handleParseResult(parsed: CommandLine.ParseResult) {
assert(parsed.subcommand() != null) { "at least 1 command and 1 subcommand found" }
val sub = parsed.subcommand()
assert(parsed.commandSpec().userObject().javaClass == Git::class.java) { "main command" }
assert(sub.commandSpec().userObject().javaClass == GitStatus::class.java) { "subcommand" }
val git = parsed.commandSpec().userObject() as Git
assert(git.gitDir == File("/home/rpopma/picocli"))
val gitstatus = sub.commandSpec().userObject() as GitStatus
assert(gitstatus.shortFormat) { "git status -s" }
assert(gitstatus.branchInfo) { "git status -b" }
assert(!gitstatus.showIgnored) { "git status --showIgnored not specified" }
assert(gitstatus.mode === GitStatusMode.no) { "git status -u=no" }
}You may be interested in the execute method to reduce error handling and other boilerplate code in your application. See also the section, Executing Subcommands.
17.12. Nested sub-Subcommands
When registering subcommands declaratively, subcommands can be nested by specifying the subcommands attribute on subcommand classes:
@Command(name = "main", subcommands = {
ChildCommand1.class,
ChildCommand2.class,
ChildCommand3.class })
class MainCommand { }
@Command(name = "cmd3", subcommands = {
GrandChild3Command1.class,
GrandChild3Command2.class,
GrandChild3Command3.class })
class ChildCommand3 { }
@Command(name = "cmd3sub3", subcommands = {
GreatGrandChild3Command3_1.class,
GreatGrandChild3Command3_2.class })
class GrandChild3Command3 { }
// ...@Command(name = "main", subcommands = [
ChildCommand1::class,
ChildCommand2::class,
ChildCommand3::class]
)
class MainCommand { }
@Command(name = "cmd3", subcommands = [
GrandChild3Command1::class,
GrandChild3Command2::class,
GrandChild3Command3::class]
)
class ChildCommand3 { }
@Command(name = "cmd3sub3", subcommands = [
GreatGrandChild3Command3_1::class,
GreatGrandChild3Command3_2::class]
)
class GrandChild3Command3 {}
// ...When registering subcommands programmatically, the object passed to the addSubcommand method can be an annotated object or a CommandLine instance with its own nested subcommands.
For example:
CommandLine commandLine = new CommandLine(new MainCommand())
.addSubcommand("cmd1", new ChildCommand1())
.addSubcommand("cmd2", new ChildCommand2())
.addSubcommand("cmd3", new CommandLine(new ChildCommand3())
.addSubcommand("cmd3sub1", new GrandChild3Command1())
.addSubcommand("cmd3sub2", new GrandChild3Command2())
.addSubcommand("cmd3sub3", new CommandLine(new GrandChild3Command3())
.addSubcommand("cmd3sub3sub1", new GreatGrandChild3Command3_1())
.addSubcommand("cmd3sub3sub2", new GreatGrandChild3Command3_2())
)
);val commandLine = CommandLine(MainCommand())
.addSubcommand("cmd1", ChildCommand1())
.addSubcommand("cmd2", ChildCommand2())
.addSubcommand("cmd3", CommandLine(ChildCommand3())
.addSubcommand("cmd3sub1", GrandChild3Command1())
.addSubcommand("cmd3sub2", GrandChild3Command2())
.addSubcommand("cmd3sub3", CommandLine(GrandChild3Command3())
.addSubcommand("cmd3sub3sub1", GreatGrandChild3Command3_1())
.addSubcommand("cmd3sub3sub2", GreatGrandChild3Command3_2())
)
)By default, the usage help message only shows the subcommands of the specified command,
and not the nested sub-subcommands. This can be customized by specifying your own IHelpSectionRenderer for the command list section.
The picocli-examples module has an example that shows how to accomplish this.
To get usage help for nested subcommands, either set mixinStandardHelpOptions = true in all commands in the hierarchy, and/or add picocli.CommandLine.HelpCommand to the subcommands of all commands. Then you can get help message for a nested (sub-)subcommand like this:
$ main cmd3 cmd3sub3 cmd3sub3sub1 --help # mixinStandardHelpOptions
Usage: main cmd3 cmd3sub3 cmd3sub3sub1 [-hV] [-y=<y>] ...
...
$ main cmd3 cmd3sub3 help cmd3sub3sub1 # HelpCommand
Usage: main cmd3 cmd3sub3 cmd3sub3sub1 [-y=<y>] ... [COMMAND]
...17.13. Repeatable Subcommands
From picocli 4.2, it is possible to specify that a command’s subcommands can be specified multiple times by marking it with @Command(subcommandsRepeatable = true).
17.13.1. Example
Below is an example where the top-level command myapp is marked as subcommandsRepeatable = true.
This command has three subcommands, add, list and send-report:
@Command(name = "myapp", subcommandsRepeatable = true)
class MyApp implements Runnable {
@Command
void add(@Option(names = "-x") String x, @Option(names = "-w") double w) { ... }
@Command
void list(@Option(names = "--where") String where) { ... }
@Command(name = "send-report")
void sendReport(@Option(names = "--to", split = ",") String[] recipients) { ... }
public static void main(String... args) {
new CommandLine(new MyApp()).execute(args);
}
}@Command(name = "myapp", subcommandsRepeatable = true)
class MyApp : Runnable {
@Command
fun add(@Option(names = ["-x"]) x: String, @Option(names = ["-w"]) w: Double) { ... }
@Command
fun list(@Option(names = ["--where"]) where: String) { ... }
@Command(name = "send-report")
fun sendReport(@Option(names = ["--to"], split = ",") recipients: Array<String>) { ... }
companion object {
@JvmStatic
fun main(args: Array<String>) {
CommandLine(MyApp()).execute(*args)
}
}
}The above example command allows users to specify one or more of its subcommands multiple time. For example, this would be a valid invocation:
myapp add -x=item1 -w=0.2 \
add -x=item2 -w=0.5 \
add -x=item3 -w=0.7 \
list --where "w>0.2" \
send-report --to=recipient@myorg.comIn the above command line invocation, the myapp top-level command is followed by its subcommand add.
Next, this is followed by another two occurrences of add, followed by list and send-report.
These are all "sibling" commands, that share the same parent command myapp.
This invocation is valid because myapp is marked with subcommandsRepeatable = true.
17.13.2. Repeatable Subcommands Specification
Normally, subcommandsRepeatable is false, so for each command, only one of its subcommands can be specified, potentially followed by only one sub-subcommand of that subcommand, etc.
In mathematical terms, a valid sequence of commands and subcommands can be represented by a directed rooted tree that starts at the top-level command. This is illustrated by the diagram below.
When subcommandsRepeatable is set to true on a command, the subcommands of this command may appear multiple times.
Also, a subcommand can be followed by a "sibling" command (another command with the same parent command).
In mathematical terms, when a parent command has this property, the additional valid sequences of its subcommands form a fully connected subgraph (a complete digraph).
The blue and green dotted arrows in the diagram below illustrate the additional sequences that are allowed when a command has repeatable subcommands.
Note that it is not valid to specify a subcommand followed by its parent command:
# invalid: cannot move _up_ the hierarchy
myapp add -x=item1 -w=0.2 myapp17.13.3. Repeatable Subcommands Execution
The default IExecutionStrategy (picocli.CommandLine.RunLast) only executes the last subcommands with the same parent. For example, if
toplevelcmd subcmd-A subcmd-B subsub-B1 subsub-B2
is invoked, only the last two sub-subcommands subsub-B1 and subsub-B2 (who both have parent command subcmd-B) are executed by default. You can set a different execution strategy if this does not meet your needs.
17.14. Usage Help for Subcommands
After registering subcommands, calling the commandLine.usage method will show a usage help message that includes all registered subcommands. For example:
CommandLine commandLine = new CommandLine(new Git());
// add subcommands programmatically (not necessary if the parent command
// declaratively registers the subcommands via annotation)
commandLine.addSubcommand("status", new GitStatus());
commandLine.addSubcommand("commit", new GitCommit());
...
commandLine.usage(System.out);val commandLine = CommandLine(Git())
// add subcommands programmatically (not necessary if the parent command
// declaratively registers the subcommands via annotation)
commandLine.addSubcommand("status", GitStatus())
commandLine.addSubcommand("commit", GitCommit())
commandLine.usage(System.out)The usage help message shows the commands in the order they were registered:
Usage: git [-hV] [--git-dir=<gitDir>] [COMMAND]
Git is a fast, scalable, distributed revision control system with an unusually
rich command set that provides both high-level operations and full access to
internals.
--git-dir=<gitDir> Set the path to the repository.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
Commands:
The most commonly used git commands are:
help Display help information about the specified command.
status Show the working tree status.
commit Record changes to the repository.
add Add file contents to the index.
branch List, create, or delete branches.
checkout Checkout a branch or paths to the working tree.
clone Clone a repository into a new directory.
diff Show changes between commits, commit and working tree, etc.
merge Join two or more development histories together.
push Update remote refs along with associated objects.
rebase Forward-port local commits to the updated upstream head.
tag Create, list, delete or verify a tag object signed with GPG.
The description of each subcommand in the command list is taken from the subcommand’s first header line, or the first description line if it does not have a header defined.
The above usage help message is produced from the annotations on the class below:
@Command(name = "git", mixinStandardHelpOptions = true,
version = "subcommand demo - picocli 4.0",
subcommands = HelpCommand.class,
description = "Git is a fast, scalable, distributed revision control " +
"system with an unusually rich command set that provides both " +
"high-level operations and full access to internals.",
commandListHeading = "%nCommands:%n%nThe most commonly used git commands are:%n")
class Git {
@Option(names = "--git-dir", description = "Set the path to the repository.")
private File gitDir;
}@Command(name = "git", mixinStandardHelpOptions = true,
version = ["subcommand demo - picocli 4.0"],
subcommands = [HelpCommand::class],
description = ["Git is a fast, scalable, distributed revision control " +
"system with an unusually rich command set that provides both " +
"high-level operations and full access to internals."],
commandListHeading = "%nCommands:%n%nThe most commonly used git commands are:%n")
class Git : Runnable {
@Option(names = ["--git-dir"], description = ["Set the path to the repository."])
lateinit var gitDir: File
}The above example uses the mixinStandardHelpOptions attribute to mix in
usageHelp and versionHelp options and registers the help subcommand.
Use the @Spec annotation for subcommands that need to show the usage help message explicitly.
|
From picocli 3.1, the usage help synopsis of the subcommand shows not only the subcommand name but also the parent command name.
For example, if the git command has a commit subcommand, the usage help for the commit subcommand shows Usage: git commit <options>.
If a subcommand explicitly wants to show the usage help message, the @Spec annotation may be useful.
The injected CommandSpec has its parent command initialized correctly, so the usage help can show the fully qualified name of the subcommand.
@Command(name = "commit", description = "...")
class Commit implements Runnable {
@Spec CommandSpec spec;
public void run() {
if (shouldShowHelp()) {
spec.commandLine().usage(System.out);
}
}
}@Command(name = "commit", description = ["..."] )
class Commit : Runnable {
@Spec
lateinit var spec: CommandSpec
override fun run() {
if (shouldShowHelp()) {
spec.commandLine().usage(System.out);
}
}
}For example, see Section Headings for an example subcommand (git commit), which produces the help message shown
in Expanded Example.
17.15. Hidden Subcommands
Commands with the hidden attribute set to true will not be shown in the usage help message of their parent command.
For example, the bar subcommand below is annotated as hidden = true:
@Command(name = "foo", description = "This is a visible subcommand")
class Foo { }
@Command(name = "bar", description = "This is a hidden subcommand", hidden = true)
class Bar { }
@Command(name = "app", subcommands = {Foo.class, Bar.class})
class App { }@Command(name = "foo", description = ["This is a visible subcommand"])
class Foo { }
@Command(name = "bar", description = ["This is a hidden subcommand"], hidden = true)
class Bar { }
@Command(name = "app", mixinStandardHelpOptions = true, subcommands = [Foo::class, Bar::class])
class App { }The usage help message for App looks like the below. Note that the bar subcommand is not shown:
Usage: app [COMMAND] Commands: foo This is a visible subcommand
17.16. Help Subcommands
Commands with the helpCommand attribute set to true are treated as help commands.
When picocli encounters a help command on the command line, required options and required positional parameters of the parent command
are not validated (similar to help options).
See Custom Help Subcommands for more details on creating help subcommands.
@Command(helpCommand = true)17.17. Required Subcommands
For some command suites, it does not make sense to invoke the top-level command by itself, and the user is required to specify a subcommand.
From version 4.3, picocli makes it easy to accomplish this: simply use the execute method to start your application, and make the top-level command a class that does not implement Runnable or Callable.
Then, when the user specifies only the top-level command, without a subcommand, while this top-level command does not implement Runnable or Callable, picocli internally throws a ParameterException with the error message "Missing required subcommand". This will cause the IParameterExceptionHandler to be called, which will display this message to the user.
Prior to picocli 4.3, applications could indicate that subcommands are required by letting the top-level command throw a ParameterException. For example:
@Command(name = "git", synopsisSubcommandLabel = "COMMAND", subcommands = { ... })
class Git implements Runnable {
@Spec CommandSpec spec;
public void run() {
throw new ParameterException(spec.commandLine(), "Missing required subcommand");
}
public static void main(String... args) {
System.exit(new CommandLine(new Git()).execute(args));
}
}@Command(name = "git", synopsisSubcommandLabel = "COMMAND", subcommands = [ ... ])
class Git : Runnable {
@Spec
lateinit var spec: CommandSpec
override fun run() {
throw ParameterException(spec.commandLine(), "Missing required subcommand")
}
companion object {
@JvmStatic
fun main(args: Array<String>) {
exitProcess(CommandLine(Git()).execute(*args))
}
}
}By default, the synopsis of a command with subcommands shows a trailing [COMMAND], indicating that a subcommand can optionally be specified.
To show that the subcommand is mandatory, use the synopsisSubcommandLabel attribute to replace this string with COMMAND (without the [ and ] brackets).
17.18. Subcommands and default values
There are some scenarios where picocli can not parse an option with a default value which is the same as a subcommand name. To work around this, you can parse the option yourself using IParameterConsumer. A simple implementation is shown below. See this issue for more details.
class ExecParameterConsumer implements IParameterConsumer {
public void consumeParameters(Stack<String> args,
ArgSpec argSpec,
CommandSpec commandSpec) {
if (args.isEmpty()) {
throw new ParameterException(
commandSpec.commandLine(),
"Missing required parameter for option " +
((OptionSpec) argSpec).longestName()
);
}
argSpec.setValue(args.pop());
}
}class MyParameterConsumer : CommandLine.IParameterConsumer {
override fun consumeParameters(
args: Stack<String>,
argSpec: CommandLine.Model.ArgSpec,
commandSpec: CommandLine.Model.CommandSpec
) {
if (args.isEmpty()) {
throw CommandLine.ParameterException(
commandSpec.commandLine(),
"Missing required parameter for option " +
(argSpec as CommandLine.Model.OptionSpec).longestName()
)
}
argSpec.setValue(args.pop())
}
}18. Reuse
You may find yourself defining the same options, parameters or command attributes in many command line applications. To reduce duplication, picocli supports two ways to reuse such options and attributes: subclassing and mixins.
18.1. Subclassing
One way to reuse options and attributes is to extend the class where they are defined.
Picocli will walk the class hierarchy to check for annotations, so @Option, @Parameters and @Command attributes declared on a superclass are available in all subclasses.
Below is an example class, ReusableOptions, that defines some usage help attributes and a --verbose option that we want to reuse.
@Command(synopsisHeading = "%nUsage:%n%n",
descriptionHeading = "%nDescription:%n%n",
parameterListHeading = "%nParameters:%n%n",
optionListHeading = "%nOptions:%n%n",
commandListHeading = "%nCommands:%n%n")
public class ReusableOptions {
@Option(names = { "-v", "--verbose" }, description = {
"Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`" })
protected boolean[] verbosity = new boolean[0];
}@Command(synopsisHeading = "%nUsage:%n%n",
descriptionHeading = "%nDescription:%n%n",
parameterListHeading = "%nParameters:%n%n",
optionListHeading = "%nOptions:%n%n",
commandListHeading = "%nCommands:%n%n")
public open class ReusableOptions {
@Option(names = ["-v", "--verbose"], description = [
"Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`"])
protected var verbosity = BooleanArray(0)
}Now, any command defined in a class that extends ReusableOptions will inherit the --verbose option, and generate a usage help message in the same spacious style. Example code:
@Command(name = "zip", description = "Example reuse by subclassing")
public class MyCommand extends ReusableOptions { /* ... */ }@Command(name = "zip", description = ["Example reuse by subclassing"])
class MyCommand : ReusableOptions(), Runnable {
override fun run() {
// ...
}
}18.2. Mixins
Picocli 3.0 introduced the concept of "mixins". Mixins allow reuse without subclassing: picocli annotations from any class can be added to ("mixed in" with) a command. Picocli’s mixinStandardHelpOptions internally uses a mixin.
A mixin is a separate class with options, positional parameters, subcommands and command attributes that you want to reuse in one or more other commands. A command receiving these mixed-in options, positional parameters, and command attributes is called the "mixee".
Mixins can be installed declaratively with a @Mixin-annotated field (or a @Mixin-annotated method parameter for command methods).
Alternatively, mixins can be installed programmatically by calling the CommandLine.addMixin method with an instance of the mixin class.
The examples below again use the sample ReusableOptions class as the mixin:
@Command(synopsisHeading = "%nUsage:%n%n",
descriptionHeading = "%nDescription:%n%n",
parameterListHeading = "%nParameters:%n%n",
optionListHeading = "%nOptions:%n%n",
commandListHeading = "%nCommands:%n%n")
public class ReusableOptions {
@Option(names = { "-v", "--verbose" }, description = {
"Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`" })
protected boolean[] verbosity = new boolean[0];
}@Command(synopsisHeading = "%nUsage:%n%n",
descriptionHeading = "%nDescription:%n%n",
parameterListHeading = "%nParameters:%n%n",
optionListHeading = "%nOptions:%n%n",
commandListHeading = "%nCommands:%n%n")
open class ReusableOptions {
@Option(names = ["-v", "--verbose"], description = [
"Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`"])
protected var verbosity = BooleanArray(0)
}18.2.1. @Mixin Annotation
A command defined in a class can include a mixin by annotating a field with @Mixin.
Similarly, a @Command-annotated method can include a mixin by declaring a @Mixin-annotated method parameter.
All picocli annotations found in the mixin class are added to the command (the "mixee").
For example:
@Command(name = "zip", description = "Example reuse with @Mixin annotation.")
public class MyCommand {
// adds the options defined in ReusableOptions to this command
@Mixin
private ReusableOptions myMixin;
@Command
void subcmd(@Mixin ReusableOptions opts) {
// ...
}
}@Command(name = "zip", description = ["Example reuse with @Mixin annotation."])
public class MyCommand {
// adds the options defined in ReusableOptions to this command
@Mixin
lateinit var myMixin: ReusableOptions
@Command
fun subcmd(@Mixin opts: ReusableOptions) : Unit {
// ...
}
}In addition to adding the options, subcommands and command attributes of the mixed-in object to the command,
the mixed-in object is also injected into the field annotated with @Mixin, making it trivial for the command to reference the mixed-in object if necessary.
MyCommand cmd = new MyCommand();
new CommandLine(cmd).parseArgs("-vvv");
// the options defined in ReusableOptions have been added to the `MyCommand` command
assert cmd.myMixin.verbosity.length == 3;val cmd = MyCommand()
CommandLine(cmd).parseArgs("-vvv")
// the options defined in ReusableOptions have been added to the `MyCommand` command
assert(cmd.myMixin.verbosity.size == 3)Mixins added with the @Mixin annotation can also be accessed via the map returned by CommandLine.getMixins.
The GitHub project has a full working example.
18.2.2. Mixin Example: Logger
Here is an example mixin class MyLogger.
It has an option -v that can be specified multiple times to increase verbosity.
The MyLogger class also provides some methods like debug and trace that can be used to print messages to the standard error stream.
public class MyLogger {
@Option(names = {"-v", "--verbose"},
description = "Increase verbosity. Specify multiple times to increase (-vvv).")
boolean[] verbosity = new boolean[0];
public void info(String pattern, Object... params) {
log(0, pattern, params);
}
public void debug(String pattern, Object... params) {
log(1, pattern, params);
}
public void trace(String pattern, Object... params) {
log(2, pattern, params);
}
private void log(int level, String pattern, Object... params) {
if (verbosity.length > level) {
System.err.printf(pattern, params);
}
}
}class MyLogger {
@Option(names = ["-v", "--verbose"],
description = ["Increase verbosity. Specify multiple times to increase (-vvv)."])
var verbosity = BooleanArray(0)
fun info(pattern: String, vararg params: Any) {
log(0, pattern, *params)
}
fun debug(pattern: String, vararg params: Any) {
log(1, pattern, *params)
}
fun trace(pattern: String, vararg params: Any) {
log(2, pattern, *params)
}
private fun log(level: Int, pattern: String, vararg params: Any) {
if (verbosity.size > level) {
System.err.printf(pattern, *params)
}
}
}An application could use the mixin like this:
class MyApp implements Runnable {
@Mixin MyLogger myLogger;
public void run() {
myLogger.info("Hello info%n");
myLogger.debug("Hello debug%n");
myLogger.trace("Hello trace%n");
}
public static void main(String[] args) {
System.exit(new CommandLine(new MyApp()).execute(args));
}
}class MyApp : Runnable {
@Mixin
lateinit var myLogger: MyLogger
override fun run() {
myLogger.info("Hello info%n")
myLogger.debug("Hello debug%n")
myLogger.trace("Hello trace%n")
}
companion object {
@JvmStatic
fun main(args: Array<String>) {
exitProcess(CommandLine(MyApp()).execute(*args))
}
}
}18.2.3. Accessing the Mixee from a Mixin
Sometimes you need to write a Mixin class that accesses the mixee (the command where it is mixed in).
From picocli 4.3, this can be accomplished with the @Spec(Spec.Target.MIXEE) annotation.
By default, the CommandSpec of the enclosing class is injected into a @Spec-annotated field, but when MIXEE is specified in a mixin class, the CommandSpec of the command receiving this mixin (the "mixee") is injected.
This can be useful when a mixin contains logic that is common to many commands.
For example:
class AdvancedMixin {
@Spec(Spec.Target.MIXEE) CommandSpec mixee;
/**
* When the -x option is specified on any subcommand,
* multiply its value with another integer supplied by this subcommand
* and set the result on the top-level command.
* @param x the value of the -x option
*/
@Option(names = "-x")
void setValue(int x) {
// get another value from the command we are mixed into
int y = ((java.util.function.IntSupplier) mixee.userObject()).getAsInt();
int product = x * y;
// set the result on the top-level (root) command
((java.util.function.IntConsumer) mixee.root().userObject()).accept(product);
}
}import java.util.function.IntConsumer
import java.util.function.IntSupplier
// ...
class AdvancedMixin {
@Spec(Spec.Target.MIXEE)
lateinit var mixee: CommandSpec
/**
* When the -x option is specified on any subcommand,
* multiply its value with another integer supplied by this subcommand
* and set the result on the top-level command.
* @param x the value of the -x option
*/
@Option(names = ["-x"])
fun setValue(x: Int) {
// get another value from the command we are mixed into
val y = (mixee.userObject() as IntSupplier).asInt
val product = x * y
// set the result on the top-level (root) command
(mixee.root().userObject() as IntConsumer).accept(product)
}
}18.2.4. Accessing the Parent Command from a Mixin
Since picocli 4.2, @ParentCommand-annotated fields can be used in mixins.
This injects a reference to the parent command of the mixee into the mixin.
Here is an example implementation:
// Define a mixin that delegates to the parent command.
class MyMixin {
@ParentCommand Top top;
@Option(names = {"-v", "--verbose"})
public void setVerbose(boolean verbose) { top.verbose = verbose; }
}
// An example Top-level command with a subcommand.
// The `-v` option can be specified on the top-level command as well as its subcommands.
@Command(subcommands = Sub.class)
class Top implements Runnable {
@Option(names = {"-v", "--verbose"})
boolean verbose;
public void verbose(String pattern, Object... params) {
if (verbose) {
System.out.printf(pattern, params);
}
}
public void run() { verbose("Hello from top%n"); }
public static void main(String[] args) {
new CommandLine(new Top()).execute(args);
}
}
// Subcommand classes can mix in the `-v` option with a @Mixin-annotated field.
@Command(name = "sub")
class Sub implements Runnable{
@Mixin MyMixin mymixin;
@Override
public void run() { mymixin.top.verbose("Hello from sub%n"); }
}// Define a mixin that delegates to the parent command.
class MyMixin {
@ParentCommand
lateinit var top: Top
@Option(names = ["-v", "--verbose"])
fun setVerbose(verbose: Boolean) { top.verbose = verbose }
}
// An example Top-level command with a subcommand.
// The `-v` option can be specified on the top-level command as well as its subcommands.
@Command(subcommands = [Sub::class])
class Top : Runnable {
@Option(names = ["-v", "--verbose"])
var verbose = false
fun verbose(pattern: String, vararg params: Any) {
if (verbose) {
System.out.printf(pattern, *params)
}
}
override fun run() { verbose("Hello from top%n") }
companion object {
@JvmStatic
fun main(args: Array<String>) {
CommandLine(Top()).execute(*args)
}
}
}
// Subcommand classes can mix in the `-v` option with a @Mixin-annotated field.
@Command(name = "sub")
class Sub : Runnable {
@Mixin
lateinit var mymixin: MyMixin
override fun run() { mymixin.top.verbose("Hello from sub%n") }
}With this, the -v option can be specified on the top-level command as well as its subcommands, so all of the below are valid invocations:
java Top -v java Top -v sub java Top sub -v
All of these invocations will print some output, since the -v option was specified.
18.2.5. Adding Mixins Programmatically
The below example shows how a mixin can be added programmatically with the CommandLine.addMixin method.
CommandLine commandLine = new CommandLine(new MyCommand());
ReusableOptions mixin = new ReusableOptions();
commandLine.addMixin("myMixin", mixin);val commandLine = CommandLine(MyCommand())
val mixin = ReusableOptions()
commandLine.addMixin("myMixin", mixin)Programmatically added mixins can be accessed via the map returned by CommandLine.getMixins. Continuing from the previous example:
commandLine.parseArgs("-vvv");
// the options defined in ReusableOptions have been added to the zip command
assert mixin == commandLine.getMixins().get("myMixin");
assert mixin.verbosity.length == 3;commandLine.parseArgs("-vvv")
// the options defined in ReusableOptions have been added to the zip command
assert(mixin === commandLine.mixins["myMixin"])
assert(mixin.verbosity.size == 3)18.3. Inherited Scope
A third reuse mechanism is setting scope = ScopeType.INHERIT.
When scope = INHERIT is used in the @Command annotation, all @Command attributes, except the command name and its subcommands, are copied to the subcommands.
See Inherited Command Attributes for details.
When scope = INHERIT is used in the @Option annotation, that option is copied to the subcommands.
See Inherited Options for details.
18.4. Use Case: Configure Log Level with a Global Option
This section shows a detailed example demonstrating Mixins.
For mixins that need to be reusable across more than two levels in the command hierarchy,
declaring a @Spec(MIXEE)-annotated field gives the mixin access to the full command hierarchy.
The MIXEE value indicates that the CommandSpec to inject is not the spec of the enclosing class, but the spec of the command where the @Mixin is used.
The example below shows a class that uses Log4j for logging, and has a "global" option --verbose that can be specified on any command to allow users to configure the Log4j log level.
The @Spec(MIXEE)-annotated field allows the mixin to climb the command hierarchy and store the "verbosity" value in a single place.
When the application is started, a custom execution strategy is used to configure the log level from that single value.
import org.apache.logging.log4j.*;
import org.apache.logging.log4j.core.config.Configurator;
import picocli.CommandLine;
import picocli.CommandLine.*;
import picocli.CommandLine.Model.CommandSpec;
import static picocli.CommandLine.Spec.Target.MIXEE;
class LoggingMixin {
private @Spec(MIXEE) CommandSpec mixee; // spec of the command where the @Mixin is used
boolean[] verbosity = new boolean[0];
/**
* Sets the specified verbosity on the LoggingMixin of the top-level command.
* @param verbosity the new verbosity value
*/
@Option(names = {"-v", "--verbose"}, description = {
"Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`"})
public void setVerbose(boolean[] verbosity) {
// Each subcommand that mixes in the LoggingMixin has its own instance
// of this class, so there may be many LoggingMixin instances.
// We want to store the verbosity value in a single, central place,
// so we find the top-level command,
// and store the verbosity level on our top-level command's LoggingMixin.
((MyApp) mixee.root().userObject()).loggingMixin.verbosity = verbosity;
}
}
@Command(name = "app", subcommands = Sub.class)
class MyApp implements Runnable {
private static Logger logger = LogManager.getLogger(MyApp.class);
@Mixin LoggingMixin loggingMixin;
@Override
public void run() {
logger.trace("Starting... (trace) from app");
logger.debug("Starting... (debug) from app");
logger.info ("Starting... (info) from app");
logger.warn ("Starting... (warn) from app");
}
private Level calcLogLevel() {
switch (loggingMixin.verbosity.length) {
case 0: return Level.WARN;
case 1: return Level.INFO;
case 2: return Level.DEBUG;
default: return Level.TRACE;
}
}
// A reference to this method can be used as a custom execution strategy
// that first configures Log4j based on the specified verbosity level,
// and then delegates to the default execution strategy.
private int executionStrategy(ParseResult parseResult) {
Configurator.setRootLevel(calcLogLevel()); // configure log4j
return new CommandLine.RunLast().execute(parseResult); // default execution strategy
}
public static void main(String[] args) {
MyApp app = new MyApp();
new CommandLine(app)
.setExecutionStrategy(app::executionStrategy)
.execute(args);
}
}
@Command(name = "sub")
class Sub implements Runnable {
private static Logger logger = LogManager.getLogger();
@Mixin LoggingMixin loggingMixin;
@Override
public void run() {
logger.trace("Hi (tracing) from app sub");
logger.debug("Hi (debugging) from app sub");
logger.info ("Hi (info) from app sub");
logger.warn ("Hi (warning) from app sub");
}
@Command
void subsubmethod(@Mixin LoggingMixin loggingMixin) {
logger.trace("Hi (tracing) from app sub subsubmethod");
logger.debug("Hi (debugging) from app sub subsubmethod");
logger.info ("Hi (info) from app sub subsubmethod");
logger.warn ("Hi (warning) from app sub subsubmethod");
}
}import org.apache.logging.log4j.*
import org.apache.logging.log4j.core.config.Configurator
import picocli.CommandLine
import picocli.CommandLine.*
import picocli.CommandLine.Model.CommandSpec
class LoggingMixin {
@Spec(Spec.Target.MIXEE)
private lateinit var mixee: CommandSpec// spec of the command where the @Mixin is used
var verbosity = BooleanArray(0)
/**
* Sets the specified verbosity on the LoggingMixin of the top-level command.
* @param verbosity the new verbosity value
*/
@Option(
names = ["-v", "--verbose"], description = [
"Specify multiple -v options to increase verbosity.",
"For example, `-v -v -v` or `-vvv`"]
)
fun setVerbose(verbosity: BooleanArray) {
// Each subcommand that mixes in the LoggingMixin has its own instance
// of this class, so there may be many LoggingMixin instances.
// We want to store the verbosity value in a single, central place,
// so we find the top-level command,
// and store the verbosity level on our top-level command's LoggingMixin.
(mixee.root().userObject() as MyApp).loggingMixin.verbosity = verbosity
}
}
@Command(name = "app", subcommands = [Sub::class])
class MyApp : Runnable {
@Mixin
lateinit var loggingMixin: LoggingMixin
override fun run() {
logger.trace("Starting... (trace) from app")
logger.debug("Starting... (debug) from app")
logger.info ("Starting... (info) from app")
logger.warn ("Starting... (warn) from app")
}
private fun calcLogLevel(): Level {
return when (loggingMixin.verbosity.size) {
0 -> Level.WARN
1 -> Level.INFO
2 -> Level.DEBUG
else -> Level.TRACE
}
}
// A reference to this method can be used as a custom execution strategy
// that first configures Log4j based on the specified verbosity level,
// and then delegates to the default execution strategy.
private fun executionStrategy(parseResult: ParseResult): Int {
Configurator.setRootLevel(calcLogLevel()) // configure log4j
return RunLast().execute(parseResult) // default execution strategy
}
companion object {
private val logger: Logger = LogManager.getLogger(MyApp::class.java)
@JvmStatic
fun main(args: Array<String>) {
val app = MyApp()
CommandLine(app)
.setExecutionStrategy { parseResult: ParseResult -> app.executionStrategy(parseResult) }
.execute(*args)
}
}
}
@Command(name = "sub")
class Sub : Runnable {
@Mixin
lateinit var loggingMixin: LoggingMixin
private val logger: Logger = LogManager.getLogger()
override fun run() {
logger.trace("Hi (tracing) from app sub")
logger.debug("Hi (debugging) from app sub")
logger.info ("Hi (info) from app sub")
logger.warn ("Hi (warning) from app sub")
}
@Command
fun subsubmethod(@Mixin loggingMixin: LoggingMixin?) {
logger.trace("Hi (tracing) from app sub subsubmethod")
logger.debug("Hi (debugging) from app sub subsubmethod")
logger.info ("Hi (info) from app sub subsubmethod")
logger.warn ("Hi (warning) from app sub subsubmethod")
}
}With this, the -v option can be specified on the top-level command as well as the subcommands, so all of the below are valid invocations:
java MyApp -v java MyApp -v sub java MyApp sub -v subsubmethod java MyApp sub subsubmethod -vv
See also the logging example in picocli-examples for a way to modify only the Log4j ConsoleAppenders' log level from the specified verbosity.
18.5. Sharing Options in Subcommands
The above use case can also be accomplished (with less code) via Inherited Options. Inherited options are another reuse mechanism where an application defines an option on one command, after which end users can specify this option on any of the subcommands, and it will set the value of the annotated field on the parent command.
18.6. Reuse Combinations
The above mechanisms can be combined in any way. Mixins can be nested, and there is no limitation to how deeply mixins can be nested. A mixin may also inherit options, positional parameters and command attributes from a super class.
An option with the same name should not be defined multiple times or a DuplicateOptionAnnotationsException is thrown during initialization. Positional parameters for the same position may be defined multiple times, they can co-exist.
Command attributes may be defined multiple times, but only one value is preserved. In case a command attribute is defined multiple times, the definition earlier in the following list takes priority over later in the list:
-
@Command attributes of the command itself
-
Attributes on the @Mixin commands
-
Attributes on a @Mixin nested in a @Mixin of the command
-
Attributes on superclass of nested @Mixin
-
Attributes on superclass of @Mixin
-
Attributes on superclass of the command
-
Attributes on programmatically added mixins
19. Internationalization
As of version 3.6, usage help message sections and the description for options and positional parameters can be specified in a resource bundle. A resource bundle can be set via annotations and programmatically.
In order to get you started quickly, the picocli-examples module has a minimal i18n example, coded both in Java and Kotlin.
19.1. Configuration
Annotation example:
@Command(name = "i18n-demo", resourceBundle = "my.org.I18nDemo_Messages")
class I18nDemo {}Programmatic example:
@Command class I18nDemo2 {}
CommandLine cmd = new CommandLine(new I18nDemo2());
cmd.setResourceBundle(ResourceBundle.getBundle("my.org.I18nDemo2_Messages"));@Command class I18nDemo2 {}
val cmd = CommandLine(I18nDemo2())
cmd.resourceBundle = ResourceBundle.getBundle("my.org.I18nDemo2_Messages")19.2. Example Resource Bundle
Example properties resource bundle:
# Usage Help Message Sections
# ---------------------------
# Numbered resource keys can be used to create multi-line sections.
usage.headerHeading = This is my app. It does stuff. Good stuff.%n
usage.header = header first line
usage.header.0 = header second line
usage.descriptionHeading = Description:%n
usage.description.0 = first line
usage.description.1 = second line
usage.description.2 = third line
usage.synopsisHeading = Usage:\u0020
# Leading whitespace is removed by default.
# Start with \u0020 to keep the leading whitespace.
usage.customSynopsis.0 = Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form)
usage.customSynopsis.1 = \u0020 or: ln [OPTION]... TARGET (2nd form)
usage.customSynopsis.2 = \u0020 or: ln [OPTION]... TARGET... DIRECTORY (3rd form)
# Headings can contain the %n character to create multi-line values.
usage.parameterListHeading = %nPositional parameters:%n
usage.optionListHeading = %nOptions:%n
usage.commandListHeading = %nCommands:%n
usage.footerHeading = Powered by picocli%n
usage.footer = footer
# Option Descriptions
# -------------------
# Use numbered keys to create multi-line descriptions.
# Example description for an option `@Option(names = "-x")`
x = This is the description for the -x option
# Example multi-line description for an option `@Option(names = "-y")`
y.0 = This is the first line of the description for the -y option
y.1 = This is the second line of the description for the -y option
# Example descriptions for the standard help mixin options:
help = Show this help message and exit.
version = Print version information and exit.
# Exit Code Description
# ---------------------
usage.exitCodeListHeading = Exit Codes:%n
usage.exitCodeList.0 = \u00200:Successful program execution. (notice leading space '\u0020')
usage.exitCodeList.1 = 64:Usage error: user input for the command was incorrect.
usage.exitCodeList.2 = 70:An exception occurred when invoking the business logic of this command.
# @file Description
# -----------------
picocli.atfile=One or more argument files containing options, commands and positional parameters.
# End-of-Options (--) Delimiter Description
# -----------------------------------------
picocli.endofoptions = Separates options from positional parameters.For options and positional parameters, the optional annotation attribute descriptionKey can be used to localize the description. For example:
@Option(names = "-x", descriptionKey = "xoption") int x;@Option(names = ["-x"], descriptionKey = "xoption") var x = 0The matching entry in the resource bundle could look like this:
xoption = This is the description for the -x option.
When the descriptionKey is omitted, the fallback for options is any option name without the leading dashes, for example:
@Option(names = {"-v", "--verbose"}) boolean[] verbose;@Option(names = ["-v", "--verbose"]) lateinit var verbose: BooleanArrayThe matching entry in the resource bundle could look like this:
verbose = Show more detail during execution. \
May be specified multiple times for increasing verbosity.
For positional parameters the fallback key is the paramLabel + [ index ], for example:
@Parameters(index = "0..*", paramLabel="FILES") File[] files;@Parameters(index = "0..*", paramLabel = "FILES") lateinit var files: Array<File>The matching entry in the resource bundle could look like this:
FILES[0..*] = The files to process.
For argument groups, use the headingKey to specify a resource bundle key. For example:
@ArgGroup(headingKey = "myBundleKey") MyArgGroup myGroup;@ArgGroup(headingKey = "myBundleKey") lateinit var myGroup: MyArgGroupThe matching entry in the resource bundle could look like this:
myBundleKey = The localized heading for this argument group%n
Note that the heading text should end with %n or the first option in the group will be on the same line.
This is to be consistent with other section headings in the usage help.
19.3. Shared Resource Bundles
Resources for multiple commands can be specified in a single ResourceBundle. Keys and their value can be
shared by multiple commands (so you don’t need to repeat them for every command), but alternatively, keys can be prefixed with
command name + "." to specify different values for different commands.
The most specific key wins. For example:
jfrog.rt.usage.header = Artifactory commands
jfrog.rt.config.usage.header = Configure Artifactory details.
jfrog.rt.upload.usage.header = Upload files.
# shared between all commands
usage.footerHeading = Environment Variables:
usage.footer.0 = footer line 0
usage.footer.1 = footer line 119.4. Localizing the Built-In Help
The built-in picocli.CommandLine.HelpCommand can be localized as follows:
-
help.usage.headercontrols the help command summary in the subcommand list -
helpCommand.helpis the resource bundle key for the--helpoption of the help subcommand -
helpCommand.commandis the resource bundle key for theCOMMANDpositional parameter of the help subcommand
# for a specific subcommand, e.g., `parent help`
parent.help.usage.header=This is the `help` subcommand of the `parent` command
parent.help.helpCommand.help = Specialized description of --help option of help subcommand for parent command
parent.help.helpCommand.command = Specialized description of COMMAND parameter of help subcommand for parent command
# or have one global entry for the `help` subcommand (for any and all commands)
help.usage.header=This is the `help` subcommand
helpCommand.help = Shared description of --help option of built-in help subcommand
helpCommand.command = Shared description of COMMAND parameter of built-in help subcommand19.5. Localizing Default Values
Options with a default value can use the ${DEFAULT-VALUE} variable in the localized option description in the resource bundle:
userName=Specify the user name. The default is ${DEFAULT-VALUE}.19.6. Controlling the locale
In your localized application, it may be desirable to specify the locale in order to determine the language of message texts and help output.
One way of controlling the locale is to give -Duser.language=desiredLocale as VM argument when running the app.
A more accessible and user-friendly approach is to implement a command line parameter (e. g. --locale) inside your app which can be used to change the locale.
The latter technique requires a two-phase approach to parsing in your application in order to get a valid load order.
The minimal example below demonstrates how to implement this two phase approach:
class InitLocale {
@Option(names = { "-l", "--locale" }, description = "locale for message texts (phase 1)")
void setLocale(String locale) {
Locale.setDefault(new Locale(locale));
}
@Unmatched
List<String> remainder; // ignore any other parameters and options in the first parsing phase
}
@Command(name = "GreetingApp", resourceBundle = "mybundle", mixinStandardHelpOptions = true)
public class GreetingApp implements Runnable {
@Option(names = { "-l", "--locale" }, paramLabel = "<locale>")
private String ignored;
@Parameters(arity = "1..", paramLabel = "<name1> <name2>")
private String[] names;
ResourceBundle bundle = ResourceBundle.getBundle("mybundle");
public void run() { // business logic here
for (String name : names) {
System.out.println(MessageFormat.format(bundle.getString("Hello"), name));
}
}
public static void main(String[] args) {
// first phase: configure locale
new CommandLine(new InitLocale()).parseArgs(args);
// second phase: parse all args (ignoring --locale) and run the app
new CommandLine(new GreetingApp()).execute(args);
}
}class InitLocale {
@Option(names = ["-l", "--locale"], description = ["locale for message texts (phase 1)"])
fun setLocale(locale: String?) {
Locale.setDefault(Locale(locale))
}
@Unmatched
lateinit var others : List<String> // ignore other parameters/options in first parsing phase
}
@Command(name = "GreetingApp", resourceBundle = "mybundle", mixinStandardHelpOptions = true)
class GreetingApp : Runnable {
@Option(names = ["-l", "--locale"], paramLabel = "<locale>")
lateinit var ignored: String
@Parameters(arity = "1..", paramLabel = "<name1> <name2>")
lateinit var names: Array<String>
private var bundle = ResourceBundle.getBundle("mybundle")
override fun run() { // business logic here
names.onEach {
println(MessageFormat.format(bundle.getString("Hello"), it))
}
}
}
fun main(args: Array<String>) {
// first phase: configure locale
CommandLine(picocli.examples.kotlin.i18n.localecontrol.InitLocale()).parseArgs(*args)
// second phase: parse all args (ignoring --locale) and run the app
exitProcess(CommandLine(GreetingApp()).execute(*args))
}Now put the default properties file (mybundle.properties, in English) and the Spanish language variant (mybundle_es.properties) in place:
Hello = Hello {0}!
Hello = ¡Hola {0}!
Eventually, we are ready to run our application:
java -cp "picocli-4.7.6.jar;myapp.jar" org.myorg.GreetingApp Sarah LeaWith no command line parameter --locale given, the message texts are printed in the default language (here: English):
Hello Sarah! Hello Lea!
In order to control the locale chosen for our output, we have to make use of the command line parameter --locale:
java -cp "picocli-4.7.6.jar;myapp.jar" org.myorg.GreetingApp --locale=es Sarah LeaNow our message texts are printed in Spanish:
¡Hola Sarah! ¡Hola Lea!
Using the command line parameter --locale, one can also determine the language of the help output of your application.
The picocli-examples module has examples with fully implemented, localized help output, coded both in Java and Kotlin.
20. Variable Interpolation
As of version 4.0, picocli supports variable interpolation (variable expansion) in annotation attributes as well as in text attributes of the programmatic API.
20.1. Variable Interpolation Example
@Command(name = "status", mixinStandardHelpOptions = true,
description = "This command logs the ${COMMAND-NAME} for ${PARENT-COMMAND-NAME}.",
version = {
"Versioned Command 1.0",
"Picocli " + picocli.CommandLine.VERSION,
"JVM: ${java.version} (${java.vendor} ${java.vm.name} ${java.vm.version})",
"OS: ${os.name} ${os.version} ${os.arch}"})
class Status {
// -d or --directories
@Option(names = {"${dirOptionName1:--d}", "${dirOptionName2:---directories}"},
description = {"Specify one or more directories, " +
"separated by '${sys:path.separator}'.",
"The default is the user home directory (${DEFAULT-VALUE})."},
arity = "${sys:dirOptionArity:-1..*}",
defaultValue = "${sys:user.home}",
split = "${sys:path.separator}")
String[] directories;
}@Command(name = "status", mixinStandardHelpOptions = true,
description = ["This command logs the \${COMMAND-NAME} for \${PARENT-COMMAND-NAME}."],
version = ["Versioned Command 1.0",
"Picocli $VERSION",
"JVM: \${java.version} (\${java.vendor} \${java.vm.name} \${java.vm.version})",
"OS: \${os.name} \${os.version} \${os.arch}"])
class Status {
// -d or --directories
@Option(names = ["\${dirOptionName1:--d}", "\${dirOptionName2:---directories}"],
description = ["Specify one or more directories, " +
"separated by '\${sys:path.separator}'.",
"The default is the user home directory (\${DEFAULT-VALUE})."],
arity = "\${sys:dirOptionArity:-1..*}",
defaultValue = "\${sys:user.home}",
split = "\${sys:path.separator}")
lateinit var directories: Array<String>
}
In Kotlin, the dollar sign ($) has to be escaped with a backslash (\) in order to prevent Kotlin string interpolation to occur: \${DEFAULT-VALUE}.
|
20.2. Predefined Variables
The following variables are predefined:
| Variable | Since | Use in | Meaning |
|---|---|---|---|
|
3.2 |
the description for an option or positional parameter |
replaced with the default value for that option or positional parameter |
|
4.0 |
the description for an option with optional parameter |
replaced with the fallback value for that option or positional parameter |
|
4.6 |
the description for map option or positional parameter that allows key-only parameters |
replaced with the map fallback value for that option or positional parameter |
|
3.2 |
the description for an option or positional parameter |
replaced with the completion candidates for that option or positional parameter |
|
4.0 |
any section of the usage help message for a command |
replaced with the name of the command |
|
4.0 |
any section of the usage help message for a command |
replaced with the fully qualified name of the command (that is, preceded by its parent fully qualified name) |
|
4.0 |
any section of the usage help message for a command |
replaced with the name of its parent command |
|
4.0 |
any section of the usage help message for a command |
replaced with the fully qualified name of its parent command (that is, preceded by the name(s) of the parent command’s ancestor commands) |
|
4.4 |
any section of the usage help message for a command |
replaced with the name of the top-level command (in a command suite with subcommands) |
20.3. Custom Variables
In addition, you can define your own variables. Currently the following syntaxes are supported:
-
${sys:key}: system property lookup, replaced by the value ofSystem.getProperty("key") -
${env:key}: environment variable lookup, replaced by the value ofSystem.getEnv("key") -
${bundle:key}: look up the value ofkeyin the resource bundle of the command -
${key}: search all of the above, first system properties, then environment variables, and finally the resource bundle of the command
20.4. Default Values for Custom Variables
You can specify a default value to use when no value is found for a custom variable. The syntax for specifying a default is ${a:-b}, where a is the variable name and b is the default value to use if a is not found.
So, for the individual lookups, this looks like this:
${key:-defaultValue}
${sys:key:-defaultValue}
${env:key:-defaultValue}
${bundle:key:-defaultValue}The default value may contain other custom variables. For example:
${bundle:a:-${env:b:-${sys:c:-X}}}The above variable is expanded as follows. First, try to find key a in the command’s resource bundle. If a is not found in the resource bundle, get the value of environment variable b. If no environment variable b exists, get the value of system property c. Finally, if no system property c exists, the value of the expression becomes X.
20.5. Escaping Variables
Sometimes you want to show a string like "${VAR}" in a description.
A $ character can be escaped with another $ character. Therefore, $${VAR} will not be interpreted as a VAR variable, but will be replaced by ${VAR} instead.
20.6. Switching Off Variable Interpolation
Variable interpolation can be switched off for the full command hierarchy by calling CommandLine.setInterpolateVariables(false), or for a particular command by calling CommandSpec.interpolateVariables(false).
20.7. Limitations of Variable Interpolation
Some attribute values need to be resolved early, when the model is constructed from the annotation values.
Specifically:
-
command names and aliases, option names, mixin names
-
arity(for options and positional parameters) -
index(for positional parameters) -
separator(for commands)
It is possible for these attributes to contain variables, but be aware of the limitations.
If these attributes have variables, and the variables get a different value after the model is constructed, the change will not be reflected in the model.
21. Tips & Tricks
21.1. Programmatic API
Picocli also provides a programmatic API, in addition to the annotations API.
The programmatic API allows applications to dynamically create command line options on the fly, where not all options are known in advance. It also makes it possible to use picocli in other JVM languages that do not support annotations.
Another use case is creating idiomatic domain-specific languages for processing command line arguments. For example, Groovy’s CliBuilder DSL is implemented using picocli’s programmatic API.
21.2. @Option and @Parameters Methods
As of version 3.2, @Option and @Parameters annotations can be added to methods as well as fields of a class.
For concrete classes, annotate "setter" methods (methods that accept a parameter) and when the option is specified on the command line, picocli will invoke the method with the value specified on the command line, converted to the type of the method parameter.
Alternatively, you may annotate "getter-like" methods (methods that return a value) on an interface, and picocli will create an instance of the interface that returns the values specified on the command line, converted to the method return type.
21.2.1. Annotating Methods of an Interface
The @Option and @Parameters annotations can be used on methods of an interface that return a value. For example:
interface Counter {
@Option(names = "--count")
int getCount();
}interface Counter {
@get:Option(names = ["--count"])
val count: Int
}You use it by specifying the class of the interface:
CommandLine cmd = new CommandLine(Counter.class); // specify a class
String[] args = new String[] {"--count", "3"};
cmd.parseArgs(args);
Counter counter = cmd.getCommand(); // picocli created an instance
assert counter.getCount() == 3; // method returns command line valueval cmd = CommandLine(Counter::class.java) // specify a class
val args = arrayOf("--count", "3")
cmd.parseArgs(*args)
val counter: Counter = cmd.getCommand() // picocli created an instance
assertEquals(3, counter.count) // method returns command line value21.2.2. Annotating Methods of a Concrete Class
The @Option and @Parameters annotations can be used on methods of a class that accept a parameter. For example:
class Counter {
int count;
@Option(names = "--count")
void setCount(int count) {
this.count = count;
}
}class Counter {
var count = 0
@JvmName("setCount1")
@Option(names = ["--count"])
fun setCount(count: Int) {
this.count = count
}
}You use it by passing an instance of the class:
Counter counter = new Counter(); // the instance to populate
CommandLine cmd = new CommandLine(counter);
String[] args = new String[] {"--count", "3"};
cmd.parseArgs(args);
assert counter.count == 3; // method was invoked with command line valueval counter = Counter() // the instance to populate
val cmd = CommandLine(counter)
val args = arrayOf("--count", "3")
cmd.parseArgs(*args)
assertEquals(3, counter.count) // method was invoked with command line valueMethods annotated with @Option and @Parameters can do simple input validation by throwing a ParameterException when invalid values are specified on the command line.
class ValidationExample {
private Map<String, String> properties = new LinkedHashMap<>();
@Spec private CommandSpec spec; // injected by picocli
@Option(names = {"-D", "--property"}, paramLabel = "KEY=VALUE")
public void setProperty(Map<String, String> map) {
for (String key : map.keySet()) {
String newValue = map.get(key);
validateUnique(key, newValue);
properties.put(key, newValue);
}
}
private void validateUnique(String key, String newValue) {
String existing = properties.get(key);
if (existing != null && !existing.equals(newValue)) {
throw new ParameterException(spec.commandLine(),
String.format("Duplicate key '%s' for values '%s' and '%s'.",
key, existing, newValue));
}
}
// ...
}class ValidationExample : Runnable {
private val properties: MutableMap<String, String?> = LinkedHashMap()
@Spec private lateinit var spec : CommandSpec // injected by picocli
@Option(names = ["-D", "--property"], paramLabel = "KEY=VALUE")
fun setProperty(map: Map<String, String>) {
for (key in map.keys) {
val newValue = map[key]
validateUnique(key, newValue)
properties[key] = newValue
}
}
private fun validateUnique(key: String, newValue: String?) {
val existing = properties[key]
if (existing != null && existing != newValue) {
throw ParameterException(spec.commandLine(),
"Duplicate key '$key' for values '$existing' and '$newValue'.")
}
}
// ...
}|
Applications that reuse a single Annotated setter method options that explicitly set If the setter method annotation does not explicitly set Java
Kotlin
|
21.3. @Command Methods
As of picocli 3.6, methods can be annotated with @Command.
The method parameters provide the command options and parameters. For example:
class Cat {
public static void main(String[] args) {
Method doit = CommandLine.getCommandMethods(Cat.class, "cat").get(0);
CommandLine cmd = new CommandLine(doit);
int exitCode = cmd.execute(args);
}
@Command(description = "Concatenate FILE(s) to standard output.",
mixinStandardHelpOptions = true, version = "4.1.3")
int cat(@Option(names = {"-E", "--show-ends"}) boolean showEnds,
@Option(names = {"-n", "--number"}) boolean number,
@Option(names = {"-T", "--show-tabs"}) boolean showTabs,
@Option(names = {"-v", "--show-nonprinting"}) boolean showNonPrinting,
@Parameters(paramLabel = "FILE") File[] files) {
// process files
return CommandLine.ExitCode.OK;
}
}class Cat {
@Command(description = ["Concatenate FILE(s) to standard output."],
mixinStandardHelpOptions = true, version = ["4.1.3"])
fun cat(@Option(names = ["-E", "--show-ends"]) showEnds: Boolean,
@Option(names = ["-n", "--number"]) number: Boolean,
@Option(names = ["-T", "--show-tabs"]) showTabs: Boolean,
@Option(names = ["-v", "--show-nonprinting"]) showNonPrinting: Boolean,
@Parameters(paramLabel = "FILE") files: Array<File>?): Int {
// process files
return CommandLine.ExitCode.OK
}
}
fun main(args: Array<String>) {
val doit: Method = CommandLine.getCommandMethods(Cat::class.java, "cat")[0]
val cmd = CommandLine(doit)
val exitCode = cmd.execute(*args)
}The usage help of the above command looks like this:
Usage: cat [-EhnTvV] [FILE...]
Concatenate FILE(s) to standard output.
[FILE...]
-E, --show-ends
-h, --help Show this help message and exit.
-n, --number
-T, --show-tabs
-v, --show-nonprinting
-V, --version Print version information and exit.
See below for an example that uses a resource bundle to define usage help descriptions outside the code.
For positional parameters, the @Parameters annotation may be omitted on method parameters.
If compiled with the -parameters flag on Java 8 or higher, the paramLabel of positional parameters is obtained from the method parameter name using reflection instead of the generic arg0, arg1, etc.
|
21.3.1. Subcommand Methods
If the enclosing class is annotated with @Command, method commands are automatically added as subcommands to the class command, unless the class command has attribute @Command(addMethodSubcommands = false).
For example:
@Command(name = "git", mixinStandardHelpOptions = true, version = "picocli-4.1.3",
resourceBundle = "Git_Messages", subcommands = { HelpCommand.class })
class Git {
@Option(names = "--git-dir", descriptionKey = "GITDIR")
Path path;
@Command
void commit(@Option(names = {"-m", "--message"}) String commitMessage,
@Option(names = "--squash", paramLabel = "<commit>") String squash,
@Parameters(paramLabel = "<file>") File[] files) {
// ... implement business logic
}
}@Command(name = "git", mixinStandardHelpOptions = true, version = ["picocli-4.1.3"],
resourceBundle = "Git_Messages", subcommands = [HelpCommand::class])
class Git {
@Option(names = ["--git-dir"], descriptionKey = "GITDIR")
lateinit var path: Path
@Command
fun commit(@Option(names = ["-m", "--message"]) commitMessage: String?,
@Option(names = ["--squash"], paramLabel = "<commit>") squash: String?,
@Parameters(paramLabel = "<file>") files: Array<File?>?) {
// ... implement business logic
}
}Use @Command(addMethodSubcommands = false) on the class @Command annotation if the @Command-annotated methods in this class should not be added as subcommands.
21.3.2. Description Text in ResourceBundle
The usage help of the above git commit example command is very minimal:
Usage: git commit [--squash=<commit>] [-m=<arg0>] [<file>...]
[<file>...]
--squash=<commit>
-m, --message=<arg0>
You can use a resource bundle to move the descriptions out of the code:
# shared between all commands help = Show this help message and exit. version = Print version information and exit. # command-specific strings git.usage.description = Version control system git.GITDIR = Set the path to the repository git.commit.usage.description = Record changes to the repository git.commit.message = Use the given <msg> as the commit message. git.commit.squash = Construct a commit message for use with rebase --autosquash. git.commit.<file>[0..*] = The files to commit.
With this resource bundle, the usage help for the git commit command looks like this:
Usage: git commit [--squash=<commit>] [-m=<arg0>] [<file>...]
Record changes to the repository
[<file>...] The files to commit.
--squash=<commit> Construct a commit message for use with rebase
--autosquash.
-m, --message=<arg0> Use the given <msg> as the commit message.
21.3.3. Mixin Support in @Command Methods
As of picocli 3.8, @Command methods accept @Mixin parameters.
All options and positional parameters defined in the mixin class are added to the command.
Example:
class CommonParams {
@Option(names = "-x") int x;
@Option(names = "-y") int y;
}
@Command
class App {
@Command
public void doit(@Mixin CommonParams params, @Option(names = "-z") int z) {}
}class CommonParams {
@Option(names = ["-x"]) var x = 0
@Option(names = ["-y"]) var y = 0
}
@Command
class App {
@Command
fun doit(@Mixin params: CommonParams?, @Option(names = ["-z"]) z: Int) {}
}In the above example, the -x and -y options are added to the -z-option of the doit command.
21.4. @Spec Annotation
Picocli 3.2 introduces a @Spec annotation for injecting the CommandSpec model of the command into a command field.
From picocli 4.6, @Spec-annotated elements can be used in ArgGroup classes.
|
This is useful when a command needs to use the picocli API, for example to walk the command hierarchy and iterate over its sibling commands.
This complements the @ParentCommand annotation; the @ParentCommand annotation injects a user-defined command object, whereas this annotation injects a picocli class.
@Command
class InjectSpecExample implements Runnable {
@Spec CommandSpec commandSpec;
//...
public void run() {
// do something with the injected spec
System.out.println("My full name is " + commandSpec.qualifiedName());
}
}@Command
class InjectSpecExample : Runnable {
@Spec lateinit var commandSpec: CommandSpec
//...
override fun run() {
// do something with the injected spec
println("My full name is ${commandSpec.qualifiedName()}")
}
}21.4.1. @Spec(MIXEE) Annotation
As of picocli 4.3, the @Spec annotation has a value element.
The value is Spec.Target.SELF by default, meaning that the CommandSpec of the enclosing class is injected into the @Spec-annotated field.
For classes that are used as a mixin, there is another value that may be useful.
When @Spec(Spec.Target.MIXEE) is specified in a mixin class, the CommandSpec of the command receiving this mixin (the "mixee") is injected into the @Spec-annotated field.
This can be useful when a mixin contains logic that is common to many commands.
See Accessing the Mixee from a Mixin for more details.
21.5. Custom Factory
Declaratively registered subcommands, type converters and version providers must be instantiated somehow. As of picocli 2.2, a custom factory can be specified when constructing a CommandLine instance. This allows full control over object creation and opens possibilities for Inversion of Control and Dependency Injection (see next section). For example:
IFactory myFactory = getCustomFactory();
CommandLine cmdLine = new CommandLine(new Git(), myFactory);val myFactory: IFactory = getCustomFactory()
val cmdLine = CommandLine(Git(), myFactory)Custom factories need to implement the picocli.CommandLine.IFactory interface:
public interface IFactory {
/**
* Creates and returns an instance of the specified class.
* @param clazz the class to instantiate
* @param <K> the type to instantiate
* @return the new instance
* @throws Exception an exception detailing what went wrong when creating the instance
*/
<K> K create(Class<K> clazz) throws Exception;
}If no factory is specified, a default factory is used. The default factory requires that the classes to instantiate have a public no-argument constructor: it instantiates the class by first calling clazz.newInstance(), and if that fails, clazz.getDeclaredConstructor().newInstance().
From version 4.0, picocli delegates all object creation to the factory, including creating Collection instances to capture multi-value @Option values.
Previously, Collection objects were instantiated separately without involving the factory.
It is recommended that custom factories should fall back to the default factory. Something like this:
@Override
public <K> K create(Class<K> clazz) throws Exception {
try {
return doCreate(clazz); // custom factory lookup or instantiation
} catch (Exception e) {
return CommandLine.defaultFactory().create(clazz); // fallback if missing
}
}override fun <K : Any> create(clazz: Class<K>): K {
return try {
doCreate(clazz) // custom factory lookup or instantiation
} catch (e: Exception) {
CommandLine.defaultFactory().create(clazz) // fallback if missing
}
}21.6. Model Transformations
From picocli 4.6, it is possible to use the annotations API to modify the model (commands, options, subcommands, etc.) dynamically at runtime.
The @Command annotation now has a modelTransformer attribute where applications can specify a class that implements the IModelTransformer interface:
interface IModelTransformer {
/**
* Given an original CommandSpec, return the object that should be used
* instead. Implementors may modify the specified CommandSpec and return it,
* or create a full or partial copy of the specified CommandSpec, and return
* that, or even return a completely new CommandSpec.
* <p>
* Implementors are free to add or remove options, positional parameters,
* subcommands or modify the command in any other way.
* </p><p>
* This method is called once, after the full command hierarchy is
* constructed, and before any command line arguments are parsed.
* </p>
* @return the CommandSpec to use instead of the specified one
*/
CommandSpec transform(CommandSpec commandSpec);
}This allows applications to dynamically add or remove options, positional parameters or subcommands, or modify the command in any other way, based on some runtime condition.
@Command(modelTransformer = Dynamic.SubCmdFilter.class)
class Dynamic {
static class SubCmdFilter implements IModelTransformer {
public CommandSpec transform(CommandSpec commandSpec) {
if (Boolean.getBoolean("disable_sub")) {
commandSpec.removeSubcommand("sub");
}
return commandSpec;
}
}
@Command
private void sub() {
// subcommand, business logic
}
}@Command(modelTransformer = Dynamic.SubCmdFilter::class)
class Dynamic {
class SubCmdFilter : CommandLine.IModelTransformer {
override fun transform(commandSpec: CommandSpec): CommandSpec {
if (Boolean.getBoolean("disable_sub")) {
commandSpec.removeSubcommand("sub")
}
return commandSpec
}
}
@Command
private fun sub() {
// subcommand, business logic
}
}All transformers are called once, after the full command hierarchy is constructed, and before any command line arguments are parsed.
If your model transformer is declared as nested class, make sure you mark this class as static, or picocli will not be able to instantiate your transformer class.
|
21.7. Automatic Parameter Indexes
21.7.1. Automatic Indexes
Positional parameters have an index attribute that determines which command line argument(s) are captured.
It is possible to omit the index attribute and let picocli automatically assign an index.
This means different things for single-value and for multi-value positional parameters.
For multi-value positional parameters (arrays or collections), omitting the index attribute means the field captures all positional parameters (the equivalent of index = "0..*").
For single-value positional parameters, picocli’s behaviour has changed since version 4.3:
prior to picocli 4.3, the default index for single-value positional parameters was also index = "0..*", even though only one value (usually the first argument) can be captured.
From version 4.3, the default index is index = "0+", which tells picocli to assign an index automatically, starting from zero, based on the other positional parameters defined in the same command.
A simple example can look like this:
class AutomaticIndex {
@Parameters(hidden = true) // "hidden": don't show this parameter in usage help message
List<String> allParameters; // no "index" attribute: captures _all_ arguments
@Parameters String group; // assigned index = "0"
@Parameters String artifact; // assigned index = "1"
@Parameters String version; // assigned index = "2"
}class AutomaticIndex {
@Parameters(hidden = true) // "hidden": don't show this parameter in usage help message
lateinit var allParameters: List<String> // no "index" attribute: captures _all_ arguments
@Parameters lateinit var group: String // assigned index = "0"
@Parameters lateinit var artifact: String // assigned index = "1"
@Parameters lateinit var version: String // assigned index = "2"
}Picocli initializes fields with the values at the specified index in the arguments array.
String[] args = { "info.picocli", "picocli", "4.3.0" };
AutomaticIndex auto = CommandLine.populateCommand(new AutomaticIndex(), args);
assert auto.group.equals("info.picocli");
assert auto.artifact.equals("picocli");
assert auto.version.equals("4.3.0");
assert auto.allParameters.equals(Arrays.asList(args));val args = arrayOf("info.picocli", "picocli", "4.3.0")
val auto = CommandLine.populateCommand(AutomaticIndex(), *args)
assertEquals("info.picocli", auto.group )
assertEquals("picocli", auto.artifact)
assertEquals("4.3.0", auto.version)
assertEquals(Arrays.asList(*args), auto.allParameters)|
Automatic indexes depend on the ability of Java reflection and Java annotation processors to iterate over fields in declaration order in the source code.
Officially this is not guaranteed by the Java spec.
In practice this has worked in Oracle JVMs and OpenJDK from Java 6, but there is some risk this may not work in the future or on other JVMs.
In general, for single-value positional parameters, using explicit indexes is the safer option.
(Multi-value positional parameters can safely omit the |
Methods cannot be iterated over in predictable order.
For applications with @Parameters-annotated methods or combinations of @Parameters-annotated methods and @Parameters-annotated fields, we recommend using explicit indexes for single-value positional parameters.
|
21.7.2. Anchored Automatic Index
The default automatic index (index = "0+") for single-value positional parameters is "anchored at zero": it starts at zero, and is increased with each additional positional parameter.
Sometimes you want to have indexes assigned automatically from a different starting point than zero. This can be useful when defining Mixins with positional parameters.
To accomplish this, specify an index with the anchor point and a + character to indicate that picocli should start to automatically assign indexes from that anchor point. For example:
class Anchored {
@Parameters(index = "1+") String p1; // assigned index = "1" or higher
@Parameters(index = "1+") String p2; // assigned index = "2" or higher
}class Anchored {
@Parameters(index = "1+") lateinit var p1: String // assigned index = "1" or higher
@Parameters(index = "1+") lateinit var p2: String // assigned index = "2" or higher
}21.7.3. Combining Explicit and Automatic Indexes
If a command defines a positional parameter with an explicit index at the anchor point, then automatic indexes anchored at that point will start from the explicit index plus 1. For example:
class ExplicitAndAutomaticIndexes {
@Parameters(index = "0" ) String explicit0; // explicit index "0" at default anchor point
@Parameters String pAuto1; // assigned index "1", anchor point + 1
@Parameters String pAuto2; // assigned index "2"
@Parameters(index = "1+") String pAnchored1; // assigned index "1": no explicit index 1
@Parameters(index = "1+") String pAnchored2; // assigned index "2"
@Parameters(index = "2" ) String explicit2; // explicit index "2", matching anchor for "2+"
@Parameters(index = "2+") String pAnchored3; // assigned index "3", anchor point + 1
@Parameters(index = "2+") String pAnchored4; // assigned index "4"
}class ExplicitAndAutomaticIndexes {
@Parameters(index = "0") lateinit var explicit0: String // explicit index "0"
// at default anchor point
@Parameters lateinit var pAuto1: String // assigned index "1",
// anchor point + 1
@Parameters lateinit var pAuto2: String // assigned index "2"
@Parameters(index = "1+") lateinit var pAnchored1: String // assigned index "1":
// no explicit index 1
@Parameters(index = "1+") lateinit var pAnchored2: String // assigned index "2"
@Parameters(index = "2") lateinit var explicit2: String // explicit index "2",
// matching anchor for "2+"
@Parameters(index = "2+") lateinit var pAnchored3: String // assigned index "3",
// anchor point + 1
@Parameters(index = "2+") lateinit var pAnchored4: String // assigned index "4"
}21.7.4. Unanchored Automatic Index
Sometimes you want to have indexes assigned automatically to come at the end. This can be useful when defining Mixins with positional parameters.
To accomplish this, specify an index with a + character to indicate that picocli should automatically assign indexes that come at the end.
For example:
class Unanchored {
@Parameters(index = "0" ) String p0;
@Parameters(index = "1+") String p1; // assigned index = "1"
@Parameters(index = "1+") String p2; // assigned index = "2"
@Parameters(index = "3" ) String p3;
@Parameters(index = "+" ) String p4; // assigned index = "4" <-- unanchored
@Parameters(index = "+" ) String p5; // assigned index = "5" <-- unanchored
}class Unanchored {
@Parameters(index = "0" ) lateinit var p0: String
@Parameters(index = "1+") lateinit var p1: String // assigned index = "1"
@Parameters(index = "1+") lateinit var p2: String // assigned index = "2"
@Parameters(index = "3" ) lateinit var p3: String
@Parameters(index = "+" ) lateinit var p4: String // assigned index = "4" <-- unanchored
@Parameters(index = "+" ) lateinit var p5: String // assigned index = "5" <-- unanchored
}21.7.5. Do Not Combine Unanchored Indexes with Open-ended Indexes
It is not possible to combine unanchored indexes (+) with open-ended explicit indexes (*):
the parameter with the open-ended index will capture all arguments, and there is no position "after the other indexes" that can be assigned.
The below example will always give a Missing required parameter: <last> error:
class BadCombination {
@Parameters(index = "0..*") List<String> all;
@Parameters(index = "+" ) String last;
}class BadCombination {
@Parameters(index = "0..*") lateinit var all: List<String>
@Parameters(index = "+" ) lateinit var last: String
}21.8. Improved Support for Chinese, Japanese and Korean
Picocli will align the usage help message to fit within some user-defined width (80 columns by default). A number of characters in Chinese, Japanese and Korean (CJK) are wider than others. If those characters are treated to have the same width as other characters, the usage help message may extend past the right margin.
From 4.0, picocli will use 2 columns for these wide characters when calculating where to put line breaks, resulting in better usage help message text.
This can be switched off with CommandLine.setAdjustLineBreaksForWideCJKCharacters(false).
21.9. Boolean Options with Parameters
By default the value of a boolean field is set to the logical negative of its default value when the option is specified on the command line.
It is possible to let end users explicitly specify "true" or "false" as a parameter for a boolean option by defining an explicit Arity attribute. A boolean option with arity = "0..1" accepts zero to one parameters, arity = "1" means the option must have one parameter. For example:
class BooleanOptionWithParameters {
@Option(names = "-x", arity = "1", description = "1 mandatory parameter")
boolean x;
@Option(names = "-y", arity = "0..1", description = "min 0 and max 1 parameter")
boolean y;
}class BooleanOptionWithParameters {
@Option(names = ["-x"], arity = "1", description = ["1 mandatory parameter"])
var x = false
@Option(names = ["-y"], arity = "0..1", description = ["min 0 and max 1 parameter"])
var y = false
}The following ways to invoke the program will be accepted (values are not case sensitive):
<command> -x true <command> -x FALSE <command> -x TRUE -y <command> -x True -y False
But trying to specify the -x option without a parameter, or with a value other than "true" or "false" (case insensitive) will result in a ParameterException.
21.10. Hexadecimal Values
Numeric values are interpreted as decimal numbers by default. If you want picocli to be more flexible, you can register a custom type converter that delegates to the decode method to convert strings to numbers.
The decode method looks at the prefix to determine the radix, so numbers
starting with 0x, 0X or # are interpreted as hexadecimal numbers, numbers starting with 0 are interpreted
as octal numbers, and otherwise the number is interpreted as a decimal number.
|
new CommandLine(obj)
.registerConverter(Byte.class, Byte::decode)
.registerConverter(Byte.TYPE, Byte::decode)
.registerConverter(Short.class, Short::decode)
.registerConverter(Short.TYPE, Short::decode)
.registerConverter(Integer.class, Integer::decode)
.registerConverter(Integer.TYPE, Integer::decode)
.registerConverter(Long.class, Long::decode)
.registerConverter(Long.TYPE, Long::decode);CommandLine(obj)
.registerConverter(Byte::class.java, java.lang.Byte::decode)
.registerConverter(java.lang.Byte.TYPE, java.lang.Byte::decode)
.registerConverter(Short::class.java, java.lang.Short::decode)
.registerConverter(java.lang.Short.TYPE, java.lang.Short::decode)
.registerConverter(Int::class.java, Integer::decode)
.registerConverter(Integer.TYPE, Integer::decode)
.registerConverter(Long::class.java, java.lang.Long::decode)
.registerConverter(java.lang.Long.TYPE, java.lang.Long::decode)ITypeConverter<Integer> intConverter = new ITypeConverter<Integer>() {
public Integer convert(String s) {
return Integer.decode(s);
}
};
commandLine.registerConverter(Integer.class, intConverter);
commandLine.registerConverter(Integer.TYPE, intConverter);
// ...var intConverter: ITypeConverter<Int> = object : ITypeConverter<Int> {
override fun convert(s: String): Int {
return Integer.decode(s)
}
}
commandLine.registerConverter(Int::class.java, intConverter)
commandLine.registerConverter(Integer.TYPE, intConverter)
// ...21.11. Option-Parameter Separators
21.11.1. Default Separators
Options may take an option parameter (also called option-argument).
For POSIX-style short options (like -f or -c), the option parameter may be attached to the option,
or it may be separated by a space or the separator string (= by default).
That is, all of the below are equivalent:
<command> -foutput.txt
<command> -f output.txt
<command> -f=output.txtLong option names (like --file) must be separated from their option parameter by a space or the
separator string (= by default). That is, the first two below examples are valid but the last example is invalid:
// valid (separator between --file and its parameter)
<command> --file output.txt
<command> --file=output.txt
// invalid (picocli will not recognize the --file option when attached to its parameter)
<command> --fileoutput.txt21.11.2. Custom Separators
The separator string can be customized programmatically or declaratively.
Use the separator attribute of the @Command annotation to declaratively set a separator string:
@Command(separator = ":") // declaratively set a separator
class OptionArg {
@Option(names = { "-f", "--file" }) String file;
}@Command(separator = ":") // declaratively set a separator
class OptionArg {
@Option(names = ["-f", "--file"]) lateinit var file: String
}OptionArg optionArg = CommandLine.populateCommand(new OptionArg(), "-f:output.txt");
assert optionArg.file.equals("output.txt");val optionArg = CommandLine.populateCommand(OptionArg(), "-f:output.txt")
assertEquals("output.txt", optionArg.file)Alternatively, the separator string can be changed programmatically with the CommandLine.setSeparator(String separator) method.
For example:
OptionArg optionArg = new OptionArg();
CommandLine commandLine = new CommandLine(optionArg);
commandLine.setSeparator(":"); // programmatically set a separator
commandLine.parseArgs("-f:output.txt");
assert optionArg.file.equals("output.txt");val optionArg = OptionArg()
val commandLine = CommandLine(optionArg)
commandLine.separator = ":" // programmatically set a separator
commandLine.parseArgs("-f:output.txt")
assertEquals("output.txt", optionArg.file)21.12. Best Practices for Command Line Interfaces
Picocli makes it easy to follow this new and modern set of Command Line Interface Guidelines.
Slightly older, but a classic: when designing your command line application, the GNU recommendations for command line interfaces and POSIX Utility Guidelines may be useful.
Generally, many applications use options for optional values and parameters for mandatory values. However, picocli lets you make options required if you want to, see Required Arguments.
21.13. Text Blocks for Java 15
When writing your command line program, you can use Java 15’s new "Text Block" feature. Multi-line text blocks can be used in command and option descriptions, headers and footers.
@Option(names = { "-v", "--verbose" },
description = """
Verbose mode. Helpful for troubleshooting.
Multiple -v options increase the verbosity.
""") // write description in text block@Option(names = [ "-v", "--verbose" ],
description = ["""
Verbose mode. Helpful for troubleshooting.
Multiple -v options increase the verbosity.
"""]) // write description in text blockFor more details, see this article by Java Language Architect Brian Goetz.
22. Dependency Injection
22.1. Guice Example
The below example shows how to create a custom IFactory implementation with a Guice Injector:
import com.google.inject.*;
import picocli.CommandLine;
import picocli.CommandLine.IFactory;
public class GuiceFactory implements IFactory {
private final Injector injector = Guice.createInjector(new DemoModule());
@Override
public <K> K create(Class<K> aClass) throws Exception {
try {
return injector.getInstance(aClass);
} catch (ConfigurationException ex) { // no implementation found in Guice configuration
return CommandLine.defaultFactory().create(aClass); // fallback if missing
}
}
static class DemoModule extends AbstractModule {
@Override
protected void configure() {
bind(java.util.List.class).to(java.util.LinkedList.class);
}
}
}import com.google.inject.*
import picocli.CommandLine
import picocli.CommandLine.IFactory
class GuiceFactory : IFactory {
private val injector = Guice.createInjector(DemoModule())
@Throws(Exception::class)
override fun <K> create(aClass: Class<K>): K {
return try {
injector.getInstance(aClass)
} catch (ex: ConfigurationException) { // no implementation found in Guice configuration
CommandLine.defaultFactory().create(aClass) // fallback if missing
}
}
class DemoModule : AbstractModule() {
override fun configure() {
bind(object : TypeLiteral<kotlin.collections.List<*>>() {})
.toInstance(kotlin.collections.ArrayList<Any>())
}
}
}Use the custom factory when creating a CommandLine instance, or when invoking the run or call convenience methods:
import javax.inject.*;
import picocli.CommandLine;
import picocli.CommandLine.*;
@Command(name = "di-demo")
public class InjectionDemo implements Runnable {
@Inject java.util.List list;
@Option(names = "-x") int x;
public static void main(String[] args) {
new CommandLine(InjectionDemo.class, new GuiceFactory()).execute(args);
}
@Override
public void run() {
assert list instanceof java.util.LinkedList;
}
}import picocli.CommandLine
import picocli.CommandLine.Command
import javax.inject.Inject
@Command(name = "di-demo")
class InjectionDemo : Runnable {
@Inject lateinit var list: kotlin.collections.List<Any>
@CommandLine.Option(names = ["-x"]) var x = 0
override fun run() {
assert(list is kotlin.collections.ArrayList<*>)
}
}
fun main(args: Array<String>) {
CommandLine(InjectionDemo::class.java, GuiceFactory()).execute(*args)
}22.2. Spring Boot Example
As of version 4.0, picocli comes with Spring Boot support by providing a custom factory in the picocli-spring-boot-starter module.
The Spring Boot example app below provides a command line interface to a mail client that can be used to send emails using an SMTP server.
The To address(es) and the subject line can be given as options, while a message body can be specified as parameter text.
To get started, visit the Spring Initializr first.
Our example app has Java Mail Sender as dependency, please note that this dependency is selected already.
Review all settings, and change if needed, especially if you want to code your app in Kotlin.
By clicking on the button Generate you can download a self-contained skeleton Spring Boot project, together with its dependencies, a build script and test cases.
Extract the archive file to a directory of your choice and open a shell or command prompt for this directory.
Since picocli dependencies are not available in the Spring Initializr, we have to add them manually:
<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli-spring-boot-starter</artifactId>
<version>4.7.6</version>
</dependency>dependencies {
implementation 'info.picocli:picocli-spring-boot-starter:4.7.6'
}dependencies {
implementation("info.picocli:picocli-spring-boot-starter:4.7.6")
}This will bring in the info.picocli:picocli and the info.picocli:picocli-spring-boot-starter dependencies.
Now open the pre-authored source file SpringBootDemoApplication.java, rename it to MySpringMailer.java and edit and extend it so that it looks like this:
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import picocli.CommandLine;
import picocli.CommandLine.IFactory;
@SpringBootApplication
public class MySpringMailer implements CommandLineRunner, ExitCodeGenerator {
private IFactory factory; (1)
private MailCommand mailCommand; (2)
private int exitCode;
// constructor injection
MySpringMailer(IFactory factory, MailCommand mailCommand) {
this.factory = factory;
this.mailCommand = mailCommand;
}
@Override
public void run(String... args) {
// let picocli parse command line args and run the business logic
exitCode = new CommandLine(mailCommand, factory).execute(args);
}
@Override
public int getExitCode() {
return exitCode;
}
public static void main(String[] args) {
// let Spring instantiate and inject dependencies
System.exit(SpringApplication.exit(SpringApplication.run(MySpringMailer.class, args)));
}
}| 1 | The injected factory is auto-configured to inject PicocliSpringFactory |
| 2 | The injected MailCommand is our @picocli.CommandLine.Command-annotated class, which is listed next: |
import org.springframework.boot.*
import org.springframework.boot.autoconfigure.SpringBootApplication
import picocli.CommandLine
import picocli.CommandLine.IFactory
@SpringBootApplication
class MySpringMailer : CommandLineRunner, ExitCodeGenerator {
private var factory: IFactory (1)
private var mailCommand: MailCommand (2)
private var exitCode = 0
// constructor injection
constructor(factory: IFactory, mailCommand: MailCommand) {
this.factory = factory // auto-configured to inject PicocliSpringFactory
this.mailCommand = mailCommand // your @picocli.CommandLine.Command-annotated class
}
override fun run(vararg args: String) {
// let picocli parse command line args and run the business logic
exitCode = CommandLine(mailCommand, factory).execute(*args)
}
override fun getExitCode(): Int {
return exitCode
}
}
fun main(args: Array<String>) {
runApplication<MySpringMailer>(*args)
}| 1 | The injected factory is auto-configured to inject PicocliSpringFactory |
| 2 | The injected MailCommand is our @picocli.CommandLine.Command-annotated class, which is listed next: |
import org.springframework.stereotype.Component;
import org.springframework.beans.factory.annotation.Autowired;
import picocli.CommandLine.*;
import java.util.List;
import java.util.concurrent.Callable;
@Component (1)
@Command(name = "mailCommand")
public class MailCommand implements Callable<Integer> {
@Autowired private IMailService mailService; (3)
@Option(names = "--to", description = "email(s) of recipient(s)", required = true)
List<String> to;
@Option(names = "--subject", description = "Subject")
String subject;
@Parameters(description = "Message to be sent")
String[] body = {};
public Integer call() throws Exception {
mailService.sendMessage(to, subject, String.join(" ", body)); (2)
return 0;
}
}| 1 | We annotate our command with the @org.springframework.stereotype.Component annotation so that Spring can autodetect it for dependency injection. |
| 2 | The business logic of your command looks like any other picocli command with options and parameters. |
| 3 | The interface for our autowired MailService is very simple: |
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.stereotype.Component
import picocli.CommandLine.*
import java.util.concurrent.Callable
@Component (1)
@Command(name = "mailCommand")
class MailCommand : Callable<Int> {
@Autowired private lateinit var mailService: IMailService (3)
@Option(names = ["--to"], description = ["email(s) of recipient(s)"], required = true)
private lateinit var to: List<String>
@Option(names = ["--subject"], description = ["Subject"])
private var subject: String = ""
@Parameters(description = ["Message to be sent"])
var body = arrayOf<String>()
@Throws(Exception::class)
override fun call(): Int {
mailService.sendMessage(to, subject, java.lang.String.join(" ", *body)) (2)
return 0
}
}| 1 | We annotate our command with the @org.springframework.stereotype.Component annontation so that Spring can autodetect it for dependency injection. |
| 2 | The business logic of your command looks like any other picocli command with options and parameters. |
| 3 | The interface for our autowired MailService is very simple: |
public interface IMailService {
void sendMessage(List<String> to, String subject, String text);
}interface IMailService {
fun sendMessage(to: List<String>, subject: String, text: String)
}And this is the implementation of our mail service:
import org.slf4j.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.*;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Service;
import java.util.List;
@Service("MailService")
public class MailServiceImpl implements IMailService {
private static final Logger LOGGER= LoggerFactory.getLogger(MailServiceImpl.class);
private static final String NOREPLY_ADDRESS = "noreply@picocli.info";
@Autowired private JavaMailSender emailSender; (1)
@Override
public void sendMessage(List<String> to, String subject, String text) {
try {
SimpleMailMessage message = new SimpleMailMessage(); // create message
message.setFrom(NOREPLY_ADDRESS); // compose message
for (String recipient : to) { message.setTo(recipient); }
message.setSubject(subject);
message.setText(text);
emailSender.send(message); // send message
LOGGER.info("Mail to {} sent! Subject: {}, Body: {}", to, subject, text); (2)
}
catch (MailException e) { e.printStackTrace(); }
}
}| 1 | The JavaMailSender is provided by the Spring framework. |
| 2 | Once a mail was successful sent, a log message will be emitted. |
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.mail.*
import org.springframework.mail.javamail.JavaMailSender
import org.springframework.stereotype.Service
@Service("MailService")
class MailServiceImpl : IMailService {
private val LOGGER = LoggerFactory.getLogger(MailServiceImpl::class.java)
private val NOREPLY_ADDRESS = "noreply@picocli.info"
@Autowired private lateinit var emailSender: JavaMailSender (1)
override fun sendMessage(to: List<String>, subject: String, text: String) {
try {
val message = SimpleMailMessage() // create message
message.setFrom(NOREPLY_ADDRESS) // compose message
for (recipient in to) {
message.setTo(recipient)
}
message.setSubject(subject)
message.setText(text)
emailSender.send(message) // send message
LOGGER.info("Mail to {} sent! Subject: {}, Body: {}", to, subject, text) (2)
} catch (e: MailException) {
e.printStackTrace()
}
}
}| 1 | The JavaMailSender is provided by the Spring framework. |
| 2 | Once a mail was successful sent, a log message will be emitted. |
Finally we have to configure our mail service. This can be done inside a file application.properties, which we put in a config subdirectory of your project:
# configuration mail service spring.mail.host=smtp.gmail.com spring.mail.port=587 spring.mail.username=email spring.mail.password=password spring.mail.properties.mail.smtp.auth=true spring.mail.properties.mail.smtp.starttls.enable=true spring.mail.properties.mail.smtp.starttls.required=true
With all our classes and configuration in place, we now can use the maven wrapper mvnw to compile and run our example app:
mvnw spring-boot:run
# ...
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.3.5.RELEASE)
# ...
#2020-11-01 19:35:31.084 INFO 15724 --- [ main] info.picocli.demo.MySpringMailer : Started MySpringMailer in 0.821 seconds (JVM running for 1.131)
Missing required option: '--to=<to>'
Usage: mailCommand [--subject=<subject>] --to=<to> [--to=<to>]... [<body>...]
[<body>...] Message to be sent
--subject=<subject> Subject
--to=<to> email(s) of recipient(s)
Since we specified no command line arguments, Picocli complains about the missing required option --to and outputs the usage help.
We have to pass in command line arguments into our command line call, we can use -Dspring-boot.run.arguments for that purpose:
mvnw compile spring-boot:dev -Dspring-boot.run.arguments="--to hans@mustermann.de \
--to zhang@san.cn --subject Testmail Easy mailing with Spring Boot and picocli"
# ...
2020-11-01 21:14:43.458 INFO 9656 --- [ main] info.picocli.demo.MailServiceImpl : Mail to [hans@mustermann.de, zhang@san.cn] successfully sent! Subject: Testmail, Body: Easy mailing with Spring Boot and picocli
# ...
With all options and parameters specified, a mail is sent successfully.
|
Depending on your configuration, Spring may use dynamic proxies for managed instances.
This is definitely the case when using features like The safest thing to do in Spring applications is to use public annotated setter methods for picocli’s |
The picocli-spring-boot-starter README has another example of a picocli app integrated into Spring Boot.
|
It may be a good idea to define an option Alternatively, you can define an unmatched field to capture all unknown options (and positional parameters): Java
Kotlin
|
22.3. Micronaut Example
The Micronaut microservices framework provides built-in support for picocli with its PicocliRunner class.
The micronaut example app below provides a command line interface to a HTTP client that can be used to retrieve the number of stars for a GitHub project via the GitHub REST API. Owner and name (called slug) of the project to be queried can be given as a command line parameter.
To get started, install the Micronaut framework first.
Now you can use the mn command line interface to generate your first project: git-stars.
mn create-cli-app git-stars --features http-client --lang=java
| Application created at /home/user/projects/micronaut/git-starsThis command will create a self-contained micronaut project with picocli support, together with its dependencies, a gradle build script and test cases.
Don’t forget the --features http-client option, which will add the io.micronaut:micronaut-http-client dependency to the project.
Use --lang=kotlin or --lang=groovy to generate code for other languages.
Open the auto-generated source file GitStarsCommand.java and alter and extend it so that it looks like this:
import java.util.Map;
import javax.inject.Inject;
import picocli.CommandLine.Command;
import picocli.CommandLine.Parameters;
import io.micronaut.configuration.picocli.PicocliRunner;
import io.micronaut.http.client.annotation.*;
import io.micronaut.http.client.*;
import static io.micronaut.http.HttpRequest.*;
@Command(name = "git-stars", description = "Retrieve number of stars for a GitHub project",
mixinStandardHelpOptions = true)
public class GitStarsCommand implements Runnable {
@Client("https://api.github.com")
@Inject RxHttpClient client; // example injected service
@Parameters(description = "GitHub slug", paramLabel = "<owner/repo>",
defaultValue = "remkop/picocli")
String slug;
public static void main(String[] args) {
PicocliRunner.execute(GitStarsCommand.class, args);
}
public void run() {
Map m = client.retrieve(GET("/repos/" + slug).header(
"User-Agent", "remkop-picocli"), Map.class).blockingFirst();
System.out.printf("%s has %s stars%n", slug, m.get("stargazers_count"));
}
}import javax.inject.Inject
import picocli.CommandLine.Command
import picocli.CommandLine.Parameters
import io.micronaut.configuration.picocli.PicocliRunner
import io.micronaut.http.HttpRequest
import io.micronaut.http.client.RxHttpClient
@Command(name = "git-stars-kotlin", description = ["Retrieve star count for GitHub project"],
mixinStandardHelpOptions = true)
class GitStarsKotlinCommand : Runnable {
val URI_GitHub_API: String = "https://api.github.com"
@Inject lateinit var client: RxHttpClient // example injected service
@Parameters(description = ["GitHub slug"], paramLabel = "<owner/repo>",
defaultValue = "remkop/picocli")
lateinit var slug: String
override fun run() {
val req = HttpRequest.GET<Any>("${URI_GitHub_API}/repos/$slug")
req.header("User-Agent", "remkop-picocli")
val flowable = client.retrieve(req, MutableMap::class.java).blockingFirst()
println("$slug has ${flowable.get("stargazers_count")} stars")
}
companion object {
@JvmStatic fun main(args: Array<String>) {
PicocliRunner.execute(GitStarsKotlinCommand::class.java, *args)
}
}
}You can now run the app using the gradle build tool:
cd git-stars
./gradlew run --args="micronaut-projects/micronaut-core"
# ...
> Task :run
21:12:17.660 [main] INFO i.m.context.env.DefaultEnvironment - Established active environments: [cli]
micronaut-projects/micronaut-core has 4245 starsUsing the mn command line interface, you can add another command (including a test case) to your project:
mn create-command second
Rendered command to src/main/java/git/stars/SecondCommand.java
Rendered command test to src/test/java/git/stars/SecondCommandTest.javaTo run the auto-generated test cases for the previously created class, simply issue:
mn test --tests git.stars.SecondCommandTest
# ...
> :test > Executing test git.stars.SecondCommandTestThe quick start guide for Micronaut’s Picocli integration has more information, including an extended code sample.
22.4. Quarkus Example
Quarkus 1.5 added support for Picocli Command Mode applications, which allows to use Picocli in Quarkus applications easily.
The Quarkus example app below provides a command line interface to a mail client that can be used to send emails using an SMTP server.
From and To addresses have to be given as options, while a message body can be specified as parameter text.
The headers subcommand can be used to specify one or more custom header lines.
To get started, visit the Quarkus Web Application Configurator first.
Our example app depends on the extensions Picocli and Mailer, please note that these extension are selected already.
If you want to code your app in Kotlin, you need to add the Kotlin extension, too.
Now move your mouse over the button Generate your application and select Download as zip.
This will download a self-contained skeleton Quarkus project with picocli support, together with its dependencies, a maven build script and test cases.
Extract the archive file to a directory of your choice and open a shell or command prompt for this directory.
Now open the pre-authored source file HelloCommando.java, rename it to MailCommando.java and edit and extend it so that it looks like this:
import javax.inject.Inject;
import java.util.*;
import io.quarkus.mailer.*;
import io.quarkus.picocli.runtime.annotations.TopCommand;
import picocli.CommandLine.*;
@TopCommand (3)
@Command(subcommands = MailCommand.HeaderCommand.class, requiredOptionMarker = '*')
public class MailCommand implements Runnable { (1)
private Mail mail = new Mail();
@Inject Mailer mailer; // Quarkus mailer
@Option(names = "--from", description = "email address of sender", required = true)
String from;
@Option(names = "--to", description = "email(s) of recipient(s)", required = true)
List<String> to;
@Option(names = "--subject", description = "Subject")
String subject;
@Parameters(description = "Message to be sent")
String[] body = {};
@Override
public void run() {
mail.setFrom(from) // compose mail
.setTo(to)
.setSubject(subject)
.setText(String.join(" ", body));
mailer.send(mail); // send mail
}
@Command(name = "headers", description = "adding custom header line(s)")
static class HeaderCommand implements Runnable { (2)
private static Map<String, List<String>> headerMap = new HashMap<>();
@ParentCommand private MailCommand parent;
@Option(names = "--header", paramLabel = "KEY=VALUE")
public void setProperty(Map<String, String> headers) {
headers.forEach((k,v) -> headerMap.put(k, Arrays.asList(v.split(" "))));
}
@Override
public void run() {
parent.mail.setHeaders(headerMap);
parent.run();
}
}
}| 1 | The MailCommand parent class serves as entry point for the picocli command line. |
| 2 | The static inner HeaderCommand class represents the headers subcommand. |
| 3 | Since both the MailCommand class and the HeaderCommand class are annotated with the picocli.CommandLine.Command annotation, there is an ambiguity concerning the entry point of the app. This is resolved by annotating the MailCommand class with the io.quarkus.picocli.runtime.annotations.TopCommand annotation. As an alternative, this ambiguity can be resolved by specifying the quarkus.picocli.top-command property, too. This property takes precedence over the TopCommand annotation. |
import io.quarkus.mailer.*
import io.quarkus.picocli.runtime.annotations.TopCommand
import picocli.CommandLine.*
import javax.inject.Inject
import kotlin.collections.HashMap
@TopCommand (3)
@Command(subcommands = [MailCommand.HeaderCommand::class], requiredOptionMarker = '*')
class MailCommand : Runnable { (1)
private val mail = Mail()
@Inject private lateinit var mailer : Mailer // Quarkus mailer
@Option(names = ["--from"], description = ["email address of sender"], required = true)
private lateinit var from: String
@Option(names = ["--to"], description = ["email(s) of recipient(s)"], required = true)
private lateinit var to: List<String>
@Option(names = ["--subject"], description = ["Subject"])
private var subject: String? = null
@Parameters(description = ["Message to be sent"])
private var body = arrayOf<String>()
override fun run() {
mail.setFrom(from) // compose mail
.setTo(to)
.setSubject(subject)
.text = body.joinToString(separator = " ")
mailer.send(mail) // send mail
}
@Command(name = "headers", description = ["adding custom header line(s)"])
internal class HeaderCommand : Runnable { (2)
private val headerMap: MutableMap<String, List<String>> = HashMap()
@ParentCommand private lateinit var parent: MailCommand
@Option(names = ["--header"], paramLabel = "KEY=VALUE")
fun setProperty(headers: Map<String, String>) {
headers.forEach { (k: String, v: String) ->
headerMap[k] = listOf(*v.split(" ").toTypedArray()) }
}
override fun run() {
parent.mail.headers = headerMap
parent.run()
}
}
}| 1 | The MailCommand parent class serves as the entry point for the picocli command line. |
| 2 | The inner HeaderCommand class represents the headers subcommand. |
| 3 | Since both the MailCommand class and the HeaderCommand class are annotated with the picocli.CommandLine.Command annotation, there is an ambiguity concerning the entry point of the app. This is resolved by annotating the MailCommand class with the io.quarkus.picocli.runtime.annotations.TopCommand annotation. As an alternative, this ambiguity can be resolved by specifying the quarkus.picocli.top-command property, too. This property takes precedence over the TopCommand annotation. |
Once you are done with coding, you can use the maven wrapper mvnw to compile and run our example app:
mvnw compile quarkus:dev
# ...
Missing required options: '--from=<from>', '--to=<to>'
Usage: <main class> --from=<from> [--subject=<subject>] --to=<to>
[--to=<to>]... [<body>...] [COMMAND]
[<body>...] Message to be sent
* --from=<from> email address of sender
* --to=<to> email(s) of recipient(s)
--subject=<subject> Subject
Commands:
header adding custom header line(s)
Since we specified no command line arguments, Picocli complains about the missing required options --from and --to and outputs the usage help.
We have to pass in command line arguments into our command line call, we can use -Dquarkus.args=our_values for that purpose:
mvnw compile quarkus:dev -Dquarkus.args="--from john@doe.info --to hans@mustermann.de \
--to zhang@san.cn Easy mailing with Quarkus and picocli"
# ...
2020-10-29 10:59:22,197 INFO [quarkus-mailer] (Quarkus Main Thread) Sending email null from john@doe.info to [hans@mustermann.de, zhang@san.cn], text body:
Easy mailing with Quarkus and picocli
html body:
<empty>
With all required options and parameters specified, a mail is sent successfully.
|
Sending emails in a development and production systems
If you are running Quarkus in DEV or TEST mode, mails are not actually sent, but printed on |
As an extra, our command line interface offers the opportunity to specify one or more custom header lines via the headers subcommand, more specifically via the --header option (KEY="MY VALUE STRINGS") of this subcommand:
./mvnw compile quarkus:dev -Dquarkus.args="--from= ... --to ... body message headers \
--header X-Mailer=Picocli/Quarkus --header X-Mailer-Version=1.0"
# ...
This command will add two additional custom header lines to our mail:
From: john@doe.info To: hans@mustermann.de X-Mailer: Picocli/Quarkus (1) X-Mailer-Version: 1.0 (2) # ...
| 1 | Custom header line 1, starting with X- as defined in RFC 822 |
| 2 | Custom header line 2 |
The Quarkus guide for the Command mode with Picocli has extended information on the Quarkus Picocli integration.
22.5. CDI 2.0 (JSR 365)
If your application runs in a dependency injection container that does not offer explicit support for picocli, it may still be possible to get dependency injection in your picocli commands, subcommands and other classes like version providers, default providers, type converters, etc.
In essence, all that is needed is an implementation of the picocli.CommandLine.IFactory interface that gets objects from the dependency injection container instead of instantiating them directly.
Below is an example CDI factory that works for any container that implements the Contexts and Dependency Injection for Java 2.0 specification (JSR 365).
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Instance;
import javax.enterprise.inject.spi.CDI;
import picocli.CommandLine;
import picocli.CommandLine.IFactory;
/**
* Factory used by picocli to look up subcommands and other classes
* in the CDI container before instantiating them directly,
* to support dependency injection in subcommands and other classes.
*/
@ApplicationScoped
public class CDIFactory implements IFactory {
private final IFactory fallbackFactory = CommandLine.defaultFactory();
@Override
public <K> K create(Class<K> cls) throws Exception {
Instance<K> instance = CDI.current().select(cls);
if (instance.isResolvable()) {
return instance.get();
}
return fallbackFactory.create(cls);
}
}How to use the above factory depends on the specific container, but in general it would look something like the below:
@Command(name = "cdi-app", mixinStandardHelpOptions = true)
class MyCDIApp implements Runnable {
boolean flag;
@Option(names = {"-x", "--option"}, description = "example option")
public void setFlag(boolean flag) {
this.flag = flag;
}
@Override
public void run() {
// business logic
}
public static void main(String[] args) {
CDIFactory cdiFactory = CDI.current().select(CDIFactory.class).get();
new CommandLine(MyCDIApp.class, cdiFactory).execute(args);
}
}|
Depending on your configuration, CDI may use dynamic proxies for managed instances. The safest thing to do in CDI applications is to use public annotated setter methods for picocli’s |
23. Java 9 JPMS Modules
The main picocli-${version}.jar is a JPMS module named info.picocli.
Starting from picocli 4.0, this jar will be an explicit module instead of an automatic module,
so the jlink tool can be used to provide a trimmed binary image that has only the required modules.
(Note that there are ways to use jlink with non-modular applications.)
Typically, a modular jar includes the module-info.class file in its root directory.
This causes problems for some older tools, which incorrectly process the module descriptor as if it were a normal Java class.
To provide the best backward compatibility, the main picocli artifact is a modular multi-release jar with the module-info.class file located in META-INF/versions/9.
23.1. Module Configuration
Applications that use Java 9’s modules need to configure their module to allow picocli reflective access to the annotated classes and fields.
Often applications want the annotated classes and fields to be private; there should be no need to make them part of the exported API of your module just to allow picocli to access them. The below settings make this possible.
module-info.javamodule your.module {
requires info.picocli;
// Open this package for reflection to external frameworks.
opens your.package.using.picocli;
// or: limit access to picocli only
// (Applications with ResourceBundles: see CAUTION section below!)
opens other.package.using.picocli to info.picocli;
}Note that neither package is exported, so other modules cannot accidentally compile against types in these packages.
Alternatively:
module-info.java// open all packages in the module to reflective access
open module your.module {
requires info.picocli;
}23.2. Resource Bundles in JPMS Modules
Applications using the @Command(resourceBundle="XXX") annotation may encounter an error saying "MissingResourceException: Can’t find bundle for base name XXX".
The only way I could get this annotation to work in a modular JPMS application was by using opens packageName in the module-info instead of opens packageName to info.picocli.
For example:
module-info.java for applications with ResourceBundlesmodule your.module {
requires info.picocli;
opens your.package.containing.resourceBundle;
//opens your.package.containing.resourceBundle to info.picocli; //MissingResourceException
}Alternatively, a workaround is to call the programmatic API CommandLine.setResourceBundle instead of using the @Command(resourceBundle="XXX") annotation.
24. OSGi Bundle
From 4.0, the picocli JAR is an OSGi bundle with Bundle-Name: picocli and other appropriate metadata in the manifest.
25. Tracing
Picocli 1.0 introduced support for parser tracing to facilitate troubleshooting.
Supported levels are OFF, WARN, INFO, and DEBUG. The default trace level is WARN.
-
DEBUG: Shows details of the decisions made by the parser during command line parsing.
-
INFO: Shows a high-level overview of what happens during command line parsing.
-
WARN: The default. Shows warnings instead of errors when lenient parsing is enabled: when single-value options were specified multiple times (and
CommandLine.overwrittenOptionsAllowedistrue), or when command line arguments could not be matched as an option or positional parameter (andCommandLine.unmatchedArgumentsAllowedistrue). -
OFF: Suppresses all tracing including warnings.
25.1. Trace Level via System Property
System property picocli.trace can be used to control the trace level.
Specifying system property -Dpicocli.trace without a value will set the trace level to INFO.
Example:
# create a custom 'git' command that invokes picocli.Demo$Git with tracing switched on
alias git='java -Dpicocli.trace -cp picocli-all.jar picocli.Demo$Git'
# invoke our command with some parameters
git --git-dir=/home/rpopma/picocli commit -m "Fixed typos" -- src1.java src2.java src3.java
# remove our 'git' pseudonym from the current shell environment
unalias gitOutput:
[picocli INFO] Parsing 8 command line args [--git-dir=/home/rpopma/picocli, commit, -m, "Fixed typos", --, src1.java, src2.java, src3.java] [picocli INFO] Setting File field 'Git.gitDir' to '\home\rpopma\picocli' for option --git-dir [picocli INFO] Adding [Fixed typos] to List<String> field 'GitCommit.message' for option -m [picocli INFO] Found end-of-options delimiter '--'. Treating remainder as positional parameters. [picocli INFO] Adding [src1.java] to List<String> field 'GitCommit.files' for args[0..*] [picocli INFO] Adding [src2.java] to List<String> field 'GitCommit.files' for args[0..*] [picocli INFO] Adding [src3.java] to List<String> field 'GitCommit.files' for args[0..*]
25.2. Tracer API
From picocli 4.7.0, applications can programmatically set the trace level, and use tracing in custom components.
In addition to setting system property picocli.trace, applications can now change the trace level via the Tracer::setLevel method. For example:
CommandLine.tracer().setLevel(CommandLine.TraceLevel.INFO);The new public method CommandLine.tracer() returns the singleton Tracer object that is used internally by picocli, and can also be used by custom component implementations to do tracing. For example:
class MyIntConverter implements ITypeConverter<Integer> {
public Integer convert(String value) {
try {
return Integer.parseInt(value);
} catch (NumberFormatException ex) {
CommandLine.tracer().info(
"Could not convert %s to Integer, returning default value -1", value);
return -1;
}
}
}26. TAB Autocomplete
Picocli-based applications can now have command line completion in Bash or Zsh Unix shells. See the Autocomplete for Java Command Line Applications manual for how to generate an autocompletion script tailored to your application.
27. Generate Man Page Documentation
From picocli 4.2, the picocli-codegen module has a ManPageGenerator tool that can generate AsciiDoc documentation using the manpage doctype and manpage document structure.
The generated AsciiDoc files can be converted to HTML, PDF and unix man pages with the wonderful asciidoctor tool.
See the Generate Documentation section of the picocli-codegen README for details on how to generate and customize this documentation.
To see some examples, the man pages for the picocli built-in tools were created with this tool:
-
gen-manpage (
picocli.codegen.docgen.manpage.ManPageGenerator) -
picocli.AutoComplete (
picocli.AutoComplete) -
generate-completion (
picocli.AutoComplete$GenerateCompletion- to be used as a subcommand) -
gen-reflect-config (
picocli.codegen.aot.graalvm.ReflectionConfigGenerator) -
gen-proxy-config (
picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator) -
gen-resource-config (
picocli.codegen.aot.graalvm.ResourceConfigGenerator)
From picocli 4.4, this tool can be used as a subcommand in your application, with the usual syntax:
import picocli.codegen.docgen.manpage.ManPageGenerator;
@Command(subcommands = ManPageGenerator.class)
...To use the ManPageGenerator tool as a subcommand, you will need the picocli-codegen jar in your classpath.
28. Testing Your Application
28.1. Black Box and White Box Testing
Picocli 4.0 introduced the execute, get/setOut, and get/setErr APIs that make testing a lot easier.
Applications can do black box testing by verifying the exit code and the output of the program to the standard output stream and standard error stream.
Additionally, you can do white box testing by keeping a reference to the application and asserting on its state after giving it various command line inputs.
For example:
MyApp app = new MyApp();
CommandLine cmd = new CommandLine(app);
StringWriter sw = new StringWriter();
cmd.setOut(new PrintWriter(sw));
// black box testing
int exitCode = cmd.execute("-x", "-y=123");
assertEquals(0, exitCode);
assertEquals("Your output is abc...", sw.toString());
// white box testing
assertEquals("expectedValue1", app.getState1());
assertEquals("expectedValue2", app.getState2());val app = MyApp()
val cmd = CommandLine(app)
val sw = StringWriter()
cmd.out = PrintWriter(sw)
// black box testing
val exitCode = cmd.execute("-x", "-y=123")
assertEquals(0, exitCode)
assertEquals("Your output is abc...", sw.toString())
// white box testing
assertEquals("expectedValue1", app.state1)
assertEquals("expectedValue2", app.state2)This assumes that the application uses the PrintWriter provided by CommandLine.getOut or CommandLine.getErr.
Applications can get these writers via the @Spec annotation:
@Command
class MyApp implements Runnable {
@Spec CommandSpec spec;
public void run() {
// make testing easier by printing to the Err and Out streams provided by picocli
spec.commandLine().getOut().println("Your output is abc...");
}
}@Command
class MyApp : Runnable {
@Spec lateinit var spec: CommandSpec
override fun run() {
// make testing easier by printing to the Err and Out streams provided by picocli
spec.commandLine().out.println("Your output is abc...")
}
}28.2. Testing the Output
Applications that print to System.out or System.err directly, or use a version of picocli lower than 4.0, can be tested by capturing the standard output and error streams.
There are various options for doing this, some of which are shown below.
28.2.1. Java 8+ with System-Lambda
Applications that use JUnit 5 or Java 8+ can use Stephan Birkner’s System-Lambda project for capturing output. This library has facilities for capturing the standard output and standard error streams separately or mixed together, and for normalizing line breaks.
Example usage:
import static com.github.stefanbirkner.systemlambda.SystemLambda.tapSystemErr;
import static com.github.stefanbirkner.systemlambda.SystemLambda.tapSystemOutNormalized;
// ...
class MyTest {
@Test
void testMyApp() throws Exception {
String errText = tapSystemErr(() -> {
String outText = tapSystemOutNormalized(() -> {
new CommandLine(new MyApp()).execute("--option=value", "arg0", "arg1");
});
assertEquals("--option='value'\n" +
"position[0]='arg0'\n" +
"position[1]='arg1'\n", outText);
});
assertEquals("", errText);
}
}28.2.2. JUnit 4 with System-Rules
Applications that use JUnit 4 can use Stephan Birkner’s System-Rules project for capturing output.
Example usage:
import org.junit.contrib.java.lang.system.SystemErrRule;
import org.junit.contrib.java.lang.system.SystemOutRule;
// ...
class MyTest {
@Rule
SystemErrRule systemErrRule = new SystemErrRule().enableLog().muteForSuccessfulTests();
@Rule
SystemOutRule systemOutRule = new SystemOutRule().enableLog().muteForSuccessfulTests();
@Test
void testMyApp() throws Exception {
new CommandLine(new MyApp()).execute("--option=value", "arg0", "arg1");
String expected = String.format("--option='value'%n" +
"position[0]='arg0'%n" +
"position[1]='arg1'%n");
assertEquals(expected, systemOutRule.getLog());
assertEquals("", systemErrRule.getLog());
}
}28.2.3. DIY Output Capturing
It is also possible to capture output in the tests yourself without using a library.
For example:
ByteArrayOutputStream err = new ByteArrayOutputStream();
ByteArrayOutputStream out = new ByteArrayOutputStream();
PrintStream oldErr = System.err;
PrintStream oldOut = System.out;
try {
System.setErr(new PrintStream(err)); // setup
System.setOut(new PrintStream(out));
String[] args = "my command args".split(" "); // test
new CommandLine(new MyApp()).execute(args);
} finally {
System.setErr(oldErr); // teardown
System.setOut(oldOut);
}
assertEquals("MY COMMAND OUTPUT", out.toString()); // verify
assertEquals("", err.toString());This looks verbose, but can be simplified a lot by letting the test framework do the setup and cleanup.
JUnit 4 lets you do setup in a @org.junit.Before-annotated method and teardown in an @org.junit.After-annotated method.
The JUnit 5 equivalent annotations are @org.junit.jupiter.api.BeforeEach and @org.junit.jupiter.api.AfterEach, respectively.
For example:
//import org.junit.After; // JUnit 4
//import org.junit.Before; // JUnit 4
import org.junit.jupiter.api.AfterEach; // JUnit 5
import org.junit.jupiter.api.BeforeEach; // JUnit 5
//...
class TestOutput {
final PrintStream originalOut = System.out;
final PrintStream originalErr = System.err;
final ByteArrayOutputStream out = new ByteArrayOutputStream();
final ByteArrayOutputStream err = new ByteArrayOutputStream();
//@Before // JUnit 4
@BeforeEach // JUnit 5
public void setUpStreams() {
out.reset();
err.reset();
System.setOut(new PrintStream(out));
System.setErr(new PrintStream(err));
}
//@After // JUnit 4
@AfterEach // JUnit 5
public void restoreStreams() {
System.setOut(originalOut);
System.setErr(originalErr);
}
@Test
public void test() {
String[] args = "my command args".split(" ");
new CommandLine(new MyApp()).execute(args);
assertEquals("MY COMMAND OUTPUT", out.toString());
assertEquals("", err.toString());
}
}28.3. Testing the Exit Code
Testing the exit code of applications that call System.exit can be tricky but is not impossible.
Depending on your programming language, your environment and your testing framework, you have several options:
-
Java 8: You can use Stephan Birkner’s System-Lambda project for testing the exit code
-
Java/Kotlin + Junit 5: You can use Todd Ginsberg’s System.exit() extension for Junit 5. The project README mentions common use cases.
-
Java + Junit 4: You can use Stephan Birkner’s System-Rules project for testing the exit code.
-
Kotlin + Kotest: Kotlin coders you may use the Kotest test framework which comes with System Exit extensions that allow you to test the exit code.
The listing below provides code samples for all of the four options mentioned above:
import static com.github.stefanbirkner.systemlambda.SystemLambda.catchSystemExit;
// ...
class MyTest {
@Command
static class MyApp implements Callable<Integer> {
public Integer call() {
System.out.println("Hi");
return 42;
}
public static void main(String[] args) {
System.exit(new CommandLine(new MyApp()).execute(args));
}
}
@Test
void testMyAppExit() throws Exception {
int exitCode = catchSystemExit(() -> {
MyApp.main();
});
assertEquals(42, exitCode);
}
}import com.ginsberg.junit.exit.ExpectSystemExitWithStatus;
import org.junit.jupiter.api.Test;
// ...
class MyTest {
@Command
static class MyApp implements Callable<Integer> {
@Override
public Integer call() throws Exception {
System.out.println("Hi");
return 42;
}
public static void main (String[] args) {
System.exit(new CommandLine(new MyApp()).execute(args));
}
}
@Test
@ExpectSystemExitWithStatus(42)
void testMyAppExit() {
MyApp.main(new String[] {});
}
}import org.junit.Rule;
import org.junit.Test;
import org.junit.contrib.java.lang.system.ExpectedSystemExit;
class MyTest {
@Rule public final ExpectedSystemExit exit = ExpectedSystemExit.none();
@Command
static class MyApp implements Callable<Integer> {
public Integer call() {
System.out.println("Hi");
return 42;
}
public static void main(String[] args) {
System.exit(new CommandLine(new MyApp()).execute(args));
}
}
@Test
public void testExitCode() {
exit.expectSystemExitWithStatus(42);
MyApp.main();
}
}import io.kotest.assertions.throwables.shouldThrow
import io.kotest.core.spec.style.StringSpec
import io.kotest.extensions.system.*
import io.kotest.matchers.shouldBe
// ...
class SystemExitTest : StringSpec() {
override fun listeners() = listOf(SpecSystemExitListener)
init {
"Picocli app should exit process with return code 42" {
shouldThrow<SystemExitException> {
main(arrayOf())
}.exitCode shouldBe 42
}
}
}
@Command
class PicocliApp : Callable<Int> {
override fun call(): Int {
return 42
}
}
fun main(args: Array<String>) : Unit = exitProcess(CommandLine(PicocliApp()).execute(*args))28.4. Testing Environment Variables
Since picocli offers support for using environment variables in the annotations, you may want to test this. Depending on your programming language, your environment and your testing framework, you have several options:
-
Java 8: You can use Stephan Birkner’s System-Lambda project for testing environment variables
-
Java + Junit 4: You can use Stephan Birkner’s System-Rules project for testing the environment variables.
-
Kotlin + Kotest: Kotlin coders you may use the Kotest test framework which comes with System Environment extension that allow you to test environment variables.
The listing below provides code samples for the three options mentioned above:
import static com.github.stefanbirkner.systemlambda.SystemLambda.withEnvironmentVariable;
// ...
@Test
void testEnvVar() throws Exception {
class MyApp {
@Option(names = "--option", defaultValue = "${env:MYVAR}",
description = "Some option. Default: ${DEFAULT-VALUE}")
String option;
}
String actual = withEnvironmentVariable("MYVAR", "some-value")
.and("OTHER_VAR", "second value")
.execute(() -> new CommandLine(new MyApp())
.getUsageMessage(CommandLine.Help.Ansi.OFF));
String expected = String.format("" +
"Usage: <main class> [--option=<option>]%n" +
" --option=<option> Some option. Default: some-value%n");
assertEquals(expected, actual);
}import org.junit.contrib.java.lang.system.EnvironmentVariables;
// ...
class MyTest {
@Rule
public final EnvironmentVariables environmentVariables = new EnvironmentVariables();
@Test
public void testEnvVar() {
class MyApp {
@Option(names = "--option", defaultValue = "${env:MYVAR}",
description = "Some option. Default: ${DEFAULT-VALUE}")
String option;
}
environmentVariables.clear("MYVAR", "OTHER_VAR", "THIRD_VAR");
environmentVariables.set("MYVAR", "some-value");
environmentVariables.set("OTHER_VAR", "second value");
String actual = new CommandLine(new MyApp())
.getUsageMessage(CommandLine.Help.Ansi.OFF);
String expected = String.format("" +
"Usage: <main class> [--option=<option>]%n" +
" --option=<option> Some option. Default: some-value%n");
assertEquals(expected, actual);
}
}import io.kotest.core.spec.style.StringSpec
import io.kotest.extensions.system.withEnvironment
import io.kotest.matchers.shouldBe
import picocli.CommandLine
import picocli.CommandLine.Command
class EnvironmentVarTest : StringSpec() {
init {
"env var" {
withEnvironment(mapOf("MYVAR" to "some-value", "OTHER_VAR" to "second value")) {
CommandLine(MyApp()).getUsageMessage(CommandLine.Help.Ansi.OFF) shouldBe
"Usage: <main class> [--option=<option>]" + System.lineSeparator() +
" --option=<option> Some option. Default: some-value" + System.lineSeparator()
}
}
}
}
@Command
class MyApp {
@CommandLine.Option(names = ["--option"], defaultValue = "\${env:MYVAR}",
description = ["Some option. Default: \${DEFAULT-VALUE}"])
lateinit var option: String
}
The latest versions of com.github.stefanbirkner:system-rules, 1.18 and 1.19, have an issue that means the Environment Variables rule will not work in JUnit 5. Use System Rules version 1.17.2 instead when combining with JUnit 5.
|
28.5. Mocking
If you prefer to use mocking in your tests, there are several frameworks available. This document will only cover some relevant aspects of some mocking frameworks based on feedback from the picocli community.
28.5.1. Mocking subcommands with Mockito
The Mockito framework creates a synthetic class for a mocked class.
The generated class is a subclass of the mocked class and also copies all the annotations to the mock.
If you are mocking a command with subcommands this might result in a picocli.CommandLine$DuplicateNameException.
To mitigate this, configure the mock to not copy the annotations.
The example below shows how to use the MockSettings API to accomplish this.
Example:
@Test
void testMockWithoutAnnotations() {
CheckSum checkSum = mock(CheckSum.class, withSettings().withoutAnnotations());
CommandLine cmdLine = new CommandLine(checkSum);
assertEquals(0, cmdLine.execute("test"));
}
You can’t use MockSettings with spy().
To mock commands with subcommands you will need to use mock() instead of spy().
|
29. Packaging Your Application
You finished your application. Congratulations! Now, how do you package it and distribute it to your users?
As mentioned in Running the Application, earlier in this manual, one way to run our application is like this:
java -cp "picocli-4.7.6.jar;myapp.jar" org.myorg.MyMainClass --option=value arg0 arg1That is quite verbose. You may want to package your application in such a way that end users can invoke it by its command name like this:
mycommand --option=value arg0 arg1After all, the usage help shows the command name defined in @Command(name = "mycommand"), so we would like users to be able to run the application with this command.
Below are some ideas on how to accomplish this.
29.1. Alias
On unix-based operating systems, you can ask your users to define an alias. For example:
alias mycommand='java -cp "/path/to/picocli-4.7.6.jar:/path/to/myapp.jar" org.myorg.MainClass'Append the above line to your ~/.bashrc file to make this alias available in every new shell session.
This requires that a JRE is installed on the machine and assumes that the java executable is in the PATH.
In Windows, the DOSKEY command can be used to define macros, but this has serious limitations.
|
Defining an alias is cheap and easy, but fragile and not very portable. A better alternative is to create a launcher script. Many build tools provide plugins to generate launcher scripts for your application, as detailed in the following section.
29.2. Launcher Script
The Application Assembler Maven Plugin can be used with Maven, and similarly, Gradle Application plugin can be used with Gradle, to create a distribution zip or tar file with launcher scripts.
Both require a JRE to be installed on the target machine.
An even more interesting solution may be to create a GraalVM native image for your application, as detailed in the following section.
29.3. GraalVM Native Image
29.3.1. What are GraalVM Native Images?
GraalVM Native Image allows you to ahead-of-time compile Java code to a standalone executable, called a native image. The resulting executable includes the application, the libraries, and the JDK and does not require a separate Java VM to be installed. The generated native image has faster startup time and lower runtime memory overhead compared to a Java VM.
GraalVM native images have some limitations and require some extra configuration to be able to use features like reflection, resources (including resource bundles) and dynamic proxies.
29.3.2. How do I Create a Native Image for my Application?
The picocli-codegen module contains an annotation processor that generates the necessary configuration files
under META-INF/native-image/picocli-generated/$project during compilation,
to be included in the application jar. The Annotation Processor section of the manual has details on configuring the annotation processor, and further information can be found in the picocli-codegen README
file.
By embedding these configuration files, your jar is instantly Graal-enabled: the
native-image tool
used to generate the native executable is able to get the configuration from the jar.
In most cases no further configuration is needed when generating a native image.
After installing GraalVM and installing the native-image generator utility (with gu install -L /path/to/native-image-installable),
you can then create a native image by invoking the native-image command:
path/to/native-image -cp picocli-4.7.6.jar --static -jar myapp.jar
| To create a native image, the compiler toolchain for your platform needs to be installed. See Build Great Native CLI Apps in Java with Graalvm and Picocli for details. |
GraalVM includes a Maven plugin and a Gradle plugin to generate a native image during the build. Although we recommend using the official GraalVM plugins, gradle users may be interested in the graalvm-native-image-plugin plugin.
29.3.3. Where can I get More Details?
This InfoQ article Build Great Native CLI Apps in Java with Graalvm and Picocli provides details on setting up the GraalVM toolchain for creating native images. It pays special attention to Windows, where setting up the compiler toolchain can be tricky.
This older article, "Picocli on GraalVM: Blazingly Fast Command Line Apps", may still be useful.
See also this demo Gradle project and this demo Maven project that provide a simple complete CLI app, with build instructions, that developers can clone, and build to get the stand-alone executable.
See also the korandoru/hawkeye for a real-world Maven project that provide a native image and a slim Docker image powered by native image.
|
Native images on Windows have the problem that the native image does not include the required dependency Many thanks to Matthew Mellon for suggesting to use pefrmdllembed as a workaround. Syntax:
|
29.4. Spring Boot Maven Plugin
The Spring Boot Maven Plugin provides a repackage goal to create executable archives that contain all of an application’s dependencies. It thus functions as an executable, is portable across operating systems and architectures, and is still a valid JAR file that can be executed explicitly or otherwise used as a JAR.
korandoru/hawkeye provides a real-world example to package a picocli application into an executable file. You can read the pom.xml file of hawkeye-cli module for details. Note that the default embeddedLaunchScript.sh assumes that the application may be a Spring Application while the hawkeye-cli example uses a customized tidy script.
29.5. Really Executable JAR
A really executable JAR
is a JAR file that is also a shell script which executes the JAR by running it with java.
It thus functions as an executable, is portable across operating systems and architectures,
and is still a valid JAR file that can be executed explicitly or otherwise used as a JAR.
The Really Executable JAR Maven Plugin can be used to create such a JAR, typically in combination with the shade plugin, as the JAR needs to be standalone, containing all of its dependencies.
29.6. launch4j
launch4j can create a native launcher executable. It can bundle a JRE (~200MB) or use a pre-installed one.
29.7. javapackager (Java 8)
JDK 8 javapackager can create a native launcher executable. It can bundle a JRE (~200MB) or use a pre-installed one.
29.8. jlink (Java 9+)
With the JPMS module system introduced in Java 9 it became possible to use jlink to create a custom light-weight JRE with only the necessary modules.
This JRE may be as small as 30-40MB.
Use jlink with the --launcher option to generate launcher scripts for your application.
See this article for using jlink for non-modular applications.
Gradle users may like these plugins: org.beryx Badass Runtime Plugin and org.beryx Badass JLink Plugin.
29.9. jpackage
jpackage is a packaging tool according to JEP 343 which ships with JDK 14.
JPackage can take the custom light-weight JRE produced by jlink and create an installer and a native application launcher.
The result is a Java "application image" that is a single directory in the filesystem containing
the native application launcher, resources and configuration files,
and the custom light-weight JRE runtime image (including the application modules) produced by jlink.
For further details, you may read the jpackage synopsis or study the Packaging Tool User’s Guide. This InfoQ article may be of interest, too.
29.10. jbang
jbang allows you to write scripts in Java that use external dependencies.
You use it with a //DEPS comment, similar to the @Grab annotation in Groovy.
Use jbang --init=cli helloworld.java to create an initial script with a picocli template.
This asciinema presentation shows what is possible.
29.11. JReleaser
JReleaser enables several packaging options such as Homebrew, Chocolatey, Snapcraft, Scoop, jbang, Docker, among others. Currently two different distribution types are supported: jlink, and standard zip/tar distributions. The latter can be generated with a combination of the appassembler-maven-plugin and maven-assembly-plugin plugins if using Maven, or the application plugin if using Gradle.
30. Picocli in Other Languages
Picocli may be used in other JVM languages that support annotations.
30.1. Groovy
30.1.1. Groovy Annotation Syntax
In Groovy, use [ and ] to surround array values, instead of the { and } used in Java.
@Command(name = "MyApp", version = "Groovy picocli v4.0 demo",
mixinStandardHelpOptions = true, // add --help and --version options
description = "@|bold Groovy|@ @|underline picocli|@ example")
class MyApp implements Runnable {
@Option(names = ["-c", "--count"], description = "number of repetitions")
int count = 1
void run() {
count.times {
println("hello world $it...")
}
}
static void main(String[] args) {
System.exit(new CommandLine(new MayApp()).execute(args))
}
}30.1.2. Groovy Scripts
|
Picocli 2.0 introduced special support for Groovy scripts.
From picocli 4.0 this was moved into a separate module, |
Scripts annotated with @picocli.groovy.PicocliScript2 are automatically transformed to use
picocli.groovy.PicocliBaseScript2 as their base class and can also use the @Command annotation to
customize parts of the usage message like command name, description, headers, footers etc.
Before the script body is executed, the PicocliBaseScript2 base class parses the command line and initializes
@Field variables annotated with @Option or @Parameters.
The script body is executed if the user input was valid and did not request usage help or version information.
@Grab('info.picocli:picocli-groovy:4.7.6')
@GrabConfig(systemClassLoader=true)
@Command(name = "myScript",
mixinStandardHelpOptions = true, // add --help and --version options
description = "@|bold Groovy script|@ @|underline picocli|@ example")
@picocli.groovy.PicocliScript2
import groovy.transform.Field
import static picocli.CommandLine.*
@Option(names = ["-c", "--count"], description = "number of repetitions")
@Field int count = 1;
// PicocliBaseScript2 prints usage help or version if requested by the user
count.times {
println "hi"
}
// the CommandLine that parsed the args is available as a property
assert this.commandLine.commandName == "myScript"The older @picocli.groovy.PicocliScript annotation is deprecated from picocli 4.6.
New scripts should use the @picocli.groovy.PicocliScript2 annotation (and associated picocli.groovy.PicocliBaseScript2 base class) instead.
The table below compares these two base classes.
PicocliBaseScript2 |
PicocliBaseScript |
|
|---|---|---|
Subcommands as methods |
Supported, subcommands can be defined as |
Unsupported |
|
Supported, both the built-in one and custom ones. |
Unsupported |
Exit codes |
Supported: scripts can override |
Unsupported |
Command execution |
Via invocation of |
Execution after parsing is defined in |
Custom handling of invalid user input |
Scripts can override |
Invalid input handling can be customized by overriding |
Custom error handling |
Scripts can override |
Runtime exception handling can be customized by overriding |
Principle |
Implements |
Script body is transformed to the |
When upgrading scripts from picocli versions older than 4.0, just changing the version number is not enough!
Scripts should use @Grab('info.picocli:picocli-groovy:4.7.6'). The old artifact id @Grab('info.picocli:picocli:4.7.6') will not work,
because the @picocli.groovy.PicocliScript annotation class and supporting classes have been moved into a separate module, picocli-groovy.
|
30.1.3. Closures in Annotations
As of picocli 4.6, Groovy programs can use closures in the picocli annotations instead of specifying a class. This can be especially useful in Groovy scripts, where one cannot define a static inner class.
Example:
@Command(name = "ClosureDemo",
versionProvider = {
{ -> ["line1" , "line2"] as String[] } as IVersionProvider (1)
},
defaultValueProvider = {
{ argSpec -> "some default" } as IDefaultValueProvider (2)
})
class ClosureDemo {
@Option(names = '-x', completionCandidates = {["A", "B", "C"]}) (3)
String x
@Option(names = '-y',
parameterConsumer = {
{ args, argSpec, commandSpec -> (4)
argSpec.setValue(args.toString() + commandSpec.name())
args.clear()
} as IParameterConsumer
})
String y
@Option(names = '-z', converter = [ // requires Groovy 3.0.7
{ { str -> MessageDigest.getInstance(str) } as ITypeConverter } (5)
])
MessageDigest z
}When a class is specified, picocli creates an instance of the class. By contrast, when a closure is specified, picocli calls the closure to get an instance. (To be precise, both of these are delegated to the configured factory, and the default factory implementation supports closures from picocli 4.6.)
As you can see in the above example, each closure in the annotation should contain another closure that has the required type (IVersionProvider, IDefaultValueProvider, etc.)
| 1 | Command versionProvider: note the empty parameter list before the → arrow. This is needed to help the Groovy compiler. The closure must be cast to IVersionProvider. |
| 2 | Command defaultProvider: return a default value for the specified ArgSpec parameter. The closure must be cast to IDefaultValueProvider. |
| 3 | Option or Parameters completionCandidates: return a list of Strings. No parameter list or casting is required. |
| 4 | Option or Parameters parameterConsumer: given a Stack, ArgSpec and CommandSpec, process the remaining arguments. The closure must be cast to IParameterConsumer. |
| 5 | Option or Parameters type converter takes an array of closures. Groovy 3.0.7 or greater is required: older versions of Groovy ignore closures in class array annotations. Each closure must have a parameter and be cast to ITypeConverter. |
From picocli version 4.7.0, this feature can be disabled by setting system property picocli.disable.closures to true. Disabling support for closures in annotations can improve the application startup time.
|
30.1.4. Older Versions of Groovy
When using a Groovy version older than 2.4.7, use this workaround for the Grape bug that causes this error:
java.lang.ClassNotFoundException: # Licensed to the Apache Software Foundation (ASF) under one or more.
|
@Grab('info.picocli:picocli-groovy:4.7.6')
@GrabExclude('org.codehaus.groovy:groovy-all') // work around GROOVY-7613
...In order to get you started quickly, you may have a look at the Groovy examples folder of the picocli code repository.
30.2. Kotlin
30.2.1. Kotlin Annotation Syntax
Kotlin 1.2 (released Nov 28, 2017) officially supports array literals in annotations, allowing a more compact notation:
@Command(name = "MyApp", version = ["Kotlin picocli v4.0 demo"],
mixinStandardHelpOptions = true, // add --help and --version options
description = ["@|bold Kotlin|@ @|underline picocli|@ example"])
class MyApp : Callable<Int> {
@Option(names = ["-c", "--count"], paramLabel = "COUNT",
description = ["the count"])
private var count: Int = 1
override fun call(): Int {
for (i in 0 until count) {
println("hello world $i...")
}
return 0
}
}
fun main(args: Array<String>) = System.exit(CommandLine(MyApp()).execute(*args))When specify a class as an argument of an annotation, use a Kotlin class (KClass). The Kotlin compiler will automatically convert it to a Java class, so that the Java code will be able to see the annotations and arguments normally.
@Command(name = "top", // ...
subcommands = [SubCmd::class, picocli.CommandLine.HelpCommand::class])
class TopCmd { // ...
}
@Command(name = "sub", /* ... */)
class SubCmd { // ...
}30.2.2. Older Versions of Kotlin
Kotlin versions prior to 1.2 did not allow the array literal syntax in annotations, so with older versions of Kotlin you will have to write arrayOf(…) for the names, description and type attributes.
@Command(name = "MyApp", version = arrayOf("picocli demo for Kotlin v1.0 and Kotlin v1.1"),
mixinStandardHelpOptions = true, // add --help and --version options
description = arrayOf("@|bold Kotlin|@ @|underline picocli|@ example"))
class MyApp : Callable<Int> {
@Option(names = arrayOf("-c", "--count"),
description = arrayOf("number of repetitions"))
private var count: Int = 1
override fun call(): Int {
for (i in 0 until count) {
println("hello world $i...")
}
return 0
}
}
fun main(args: Array<String>) = System.exit(CommandLine(MyApp()).execute(*args))In order to get you started quickly, you may have a look at the Kotlin examples folder of the picocli code repository.
30.3. Scala
Scala does not allow specifying array annotation attribute as a single value,
so be aware that you will have to write Array(…) for the names, description and type attributes.
@Command(name = "MyApp", version = Array("Scala picocli demo v4.0"),
mixinStandardHelpOptions = true, // add --help and --version options
description = Array("@|bold Scala|@ @|underline picocli|@ example"))
class MyApp extends Callable[Int] {
@Option(names = Array("-c", "--count"), paramLabel = "COUNT",
description = Array("the count"))
private var count: Int = 1
def call() : Int = {
for (i <- 0 until count) {
println(s"hello world $i...")
}
0
}
}
object MyApp {
def main(args: Array[String]): Unit = {
System.exit(new CommandLine(new MyApp()).execute(args: _*))
}
}In order to get you started quickly, you may have a look at the Scala examples folder of the picocli code repository.
31. API JavaDoc
Picocli API JavaDoc can be found here.
See also: Picocli 3.x JavaDoc.
32. GitHub Project
The GitHub project has the source code, tests, build scripts, etc.
Star and/or fork this project on GitHub if you like it!
33. Issue Tracker
The GitHub Issue Tracker can be used to report bugs or request features. There is also a Mailing List, and for questions where the user community may know the answer, StackOverflow is both a good resource and a great way to build an online knowledge base.
34. Mailing List
Join the picocli Google group if you are interested in discussing anything picocli-related and receiving announcements on new releases.
35. License
Picocli is licensed under the Apache License 2.0.
36. Releases
Previous versions are available from the GitHub project Releases.
37. Download
You can add picocli as an external dependency to your project, or you can include it as source.
37.1. Build tools
implementation 'info.picocli:picocli:4.7.6'implementation("info.picocli:picocli:4.7.6")<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli</artifactId>
<version>4.7.6</version>
</dependency>libraryDependencies += "info.picocli" % "picocli" % "4.7.6"<dependency org="info.picocli" name="picocli" rev="4.7.6" />@Grapes(
@Grab(group='info.picocli', module='picocli', version='4.7.6')
)[info.picocli/picocli "4.7.6"]'info.picocli:picocli:jar:4.7.6'//DEPS info.picocli:picocli:4.7.637.2. Source
By using picocli in source form, you can avoid having an external dependency on picocli.
Picocli has only one source file: CommandLine.java.
This facilitates including picocli in your project: simply copy and paste the code of this file into a file called CommandLine.java, add it to your project, and enjoy!