Picocli 4.1.2

The picocli community is pleased to announce picocli 4.1.2.

This release contains bugfixes, improvements, and documentation enhancements.

This version of picocli requires JLine 3.13.2 or higher and adds a PicocliCommands class that provides command descriptions that can be displayed in the terminal status bar via the new JLine TailTipWidgets functionality.

The built-in picocli.AutoComplete.GenerateCompletion (generate-completion) subcommand now omits validation of mandatory options in the parent command.

"Hidden" subcommands and options are no longer shown as suggestions in unmatched argument usage help or autocompletion scripts.

From 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.

This is the sixty-fourth public release.
Picocli follows semantic versioning.

Thanks to the Community

Special thanks to mattirn and to Andreas Deininger for the pull requests and feedback!

Table of Contents

• New and noteworthy
• Fixed issues
• Deprecations
• Potential breaking changes

New and Noteworthy

JLine3

JLine has had some interesting improvements in its 3.12 release.

This version of picocli requires JLine 3.13.2 or higher and adds a PicocliCommands class that provides command descriptions that can be displayed in the terminal status bar via the new JLine TailTipWidgets functionality.

See the picocli-shell-jline3 README for details.

Completion

The built-in picocli.AutoComplete.GenerateCompletion (generate-completion) subcommand now omits validation of mandatory options in the parent command.

Also, "hidden" subcommands and options are no longer shown as suggestions in unmatched argument usage help or autocompletion scripts.

Fixed issues

• [#888] (API) Added new PicocliCommands class to picocli-shell-jline3 module; bumped JLine to 3.13.2. Thanks to mattirn for the pull request.
• [#884] (Bugfix) Built-in picocli.AutoComplete.GenerateCompletion (generate-completion) subcommand now omits validation of mandatory options in the parent command. Thanks to Andreas Deininger for raising this.
• [#887] (Bugfix) "Hidden" subcommands and options are no longer shown as suggestions in unmatched argument usage help or autocompletion scripts. Thanks to Andreas Deininger for raising this.
• [#871] (Bugfix) All options in an exclusive group are now automatically considered required, to prevent unexpected results when mixing required and non-required options in exclusive ArgGroups. Thanks to W Scott Johnson for raising this.
• [#883] (DOC) Update of Quick Guide. Thanks to Andreas Deininger for the pull request.
• [#889][#885] (DOC) Update of Picocli Programmatic API documentation. Thanks to Andreas Deininger for the pull request.
• [#891] (DOC) Fixed broken links in README. Thanks to Andreas Deininger for the pull request.
• [#892] (DOC) Minor improvements to example app in picocli-shell-jline3.

Deprecations

No features were deprecated in this release.

Potential breaking changes

This release has no breaking changes.