All Versions
Latest Version
Avg Release Cycle
45 days
Latest Release

Changelog History
Page 2

  • v1.7.0 Changes

    January 24, 2019

    ๐Ÿ“œ The parsing procedure now maps much more sensibly to complex, nested subcommand structures. Each phase of the parsing happens on all subcommands before moving on with the next phase of the parse. This allows several features, like required environment variables, to work properly even through subcommand boundaries.
    Passing the same subcommand multiple times is better supported. Several new features were added as well, including Windows style option support, parsing strings directly, and ignoring underscores in names. Adding a set that you plan to change later must now be done with add_mutable_set.

    • ๐Ÿ Support Windows style options with ->allow_windows_style_options. #187 On by default on Windows. #190
    • โž• Added parse(string) to split up and parse a command-line style string directly. #186
    • โž• Added ignore_underscore and related functions, to ignore underscores when matching names. #185
    • 0๏ธโƒฃ The default INI Config will now add quotes to strings with spaces #195
    • 0๏ธโƒฃ The default message now will mention the help-all flag also if present #197
    • โž• Added ->description to set Option descriptions #199
    • Mutating sets (introduced in Version 1.6) now have a clear add method, add_mutable_set*, since the set reference should not expire #200
    • ๐Ÿ“œ Subcommands now track how many times they were parsed in a parsing process. count() with no arguments will return the number of times a subcommand was encountered. #179
    • ๐Ÿ“œ Parsing is now done in phases: shortcurcuits, ini, env, callbacks, and requirements; all subcommands complete a phase before moving on. #179
    • ๐Ÿ“œ Calling parse multiple times is now officially supported without clear (automatic). #179
    • โฌ‡๏ธ Dropped the mostly undocumented short_circuit property, as help flag parsing is a bit more complex, and the default callback behavior of options now works properly. #179
    • โœ… Use the standard BUILD_TESTING over CLI11_TESTING if defined (CLI11_TESTING may eventually be removed) #183
    • โš  Cleanup warnings #191
    • Remove deprecated names: set_footer, set_name, set_callback, and set_type_name. Use without the set_ instead. #192

    Converting from CLI11 1.6:

    ๐Ÿšš > - ->short_circuit() is no longer needed, just remove it if you were using it - raising an exception will happen in the proper place now without it.

    • ->add_set* becomes ->add_mutable_set* if you were using the editable set feature
    • footer, name, callback, and type_name must be used instead of the set_* versions (deprecated previously).
  • v1.6.2 Changes

    November 24, 2018

    โš  This version fixes some formatting bugs with help-all. It also adds fixes for several warnings, including an experimental optional error on Clang 7. Several smaller fixes.

    • ๐Ÿ›  Fixed help-all formatting #163
      • Printing help-all on nested command now fixed (App)
      • Missing space after help-all restored (Default formatter)
      • More detail printed on help all (Default formatter)
      • Help-all subcommands get indented with inner blank lines removed (Default formatter)
      • detail::find_and_replace added to utilities
    • ๐Ÿ›  Fixed CMake install as subproject with CLI11_INSTALL flag. #156
    • ๐Ÿ›  Fixed warning about local variable hiding class member with MSVC #157
    • ๐Ÿ›  Fixed compile error with default settings on Clang 7 and libc++ #158
    • ๐Ÿ›  Fixed special case of --help on subcommands (general fix planned for 1.7) #168
    • Removing an option with links #179
  • v1.6.1 Changes

    July 30, 2018

    ๐Ÿ This version provides a few fixes for special cases, such as mixing with Windows.h and better defaults for systems like Hunter. The one new feature is the ability to produce "branded" single file output for providing custom namespaces or custom macro names.

    • โž• Added fix and test for including Windows.h #145
    • ๐Ÿ— No longer build single file by default if main project, supports systems stuck on Python 2.6 #149, #151
    • ๐Ÿ‘ Branding support for single file output #150
  • v1.6.0 Changes

    June 28, 2018

    โž• Added a new formatting system #109. You can now set the formatter on Apps. This has also simplified the internals of Apps and Options a bit by separating most formatting code.

    • โž• Added CLI::Formatter and formatter slot for apps, inherited.
    • FormatterBase is the minimum required.
    • FormatterLambda provides for the easy addition of an arbitrary function.
    • โž• Added help_all support (not added by default).

    ๐Ÿ”„ Changes to the help system (most normal users will not notice this):

    • Renamed single_name to get_name(false, false) (the default).
    • The old get_name() is now get_name(false, true).
    • The old get_pname() is now get_name(true, false).
    • โœ‚ Removed help_* functions.
    • Protected function _has_help_positional removed.
    • format_help can now be chained.
    • โž• Added getters for the missing parts of options (help no longer uses any private parts).
    • ๐Ÿ“œ Help flags now use new short_circuit property to simplify parsing. #121

    ๐Ÿ†• New for Config file reading and writing #121:

    • Overridable, bidirectional Config.
    • 0๏ธโƒฃ ConfigINI provided and used by default.
    • ๐Ÿ“‡ Renamed ini to config in many places.
    • Has config_formatter() and get_config_formatter().
    • Dropped prefix argument from config_to_str.
    • โž• Added ConfigItem.
    • โž• Added an example of a custom config format using nlohmann/json. #138

    โฌ†๏ธ Validators are now much more powerful #118, all built in validators upgraded to the new form:

    • A subclass of CLI::Validator is now also accepted.
    • They now can set the type name to things like PATH and INT in [1-4].
    • Validators can be combined with & and |.
    • Old form simple validators are still accepted.

    Other changes:

    • ๐Ÿ›  Fixing parse(args)'s args setting and ordering after parse. #141
    • Replaced set_custom_option with type_name and type_size instead of set_custom_option. Methods return this. [#136]
    • Dropped set_ on Option's type_name, default_str, and default_val. [#136]
    • Removed set_ from App's failure_message, footer, callback, and name. [#136]
    • ๐Ÿ›  Fixed support N<-1 for type_size. #140
    • โž• Added ->each() to make adding custom callbacks easier. #126
    • ๐Ÿ‘ Allow empty options add_option("-n",{}) to be edited later with each #142
    • Added filter argument to get_subcommands, get_options; use empty filter {} to avoid filtering.
    • โž• Added get_groups() to get groups.
    • Better support for manual options with get_option, set_results, and empty. #119
    • lname and sname have getters, added const get_parent. #120
    • Using add_set will now capture L-values for sets, allowing further modification. #113
    • Dropped duplicate way to run get_type_name (get_typeval).
    • โœ‚ Removed requires in favor of needs (deprecated in last version). #112
    • Const added to argv. #126

    โœ… Backend and testing changes:

    • Internally, type_name is now a lambda function; for sets, this reads the set live. #116
    • โœ… Cleaner tests without app.reset() (and reset is now clear). #141
    • ๐Ÿ‘ Better CMake policy handling. #110
    • Includes are properly sorted. #120
    • โœ… Testing (only) now uses submodules. #111
  • v1.5.4 Changes

    June 14, 2018

    This version fixes the optional search in the single file version; some macros were not yet defined when it did the search. You can define the CLI11_*_OPTIONAL macros to 0 if needed to eliminate the search.

  • v1.5.3 Changes

    April 19, 2018

    ๐Ÿ›  This version fixes older AppleClang compilers by removing the optimization for casting. The minimum version of Boost Optional supported has been clarified to be 1.58. CUDA 7.0 NVCC is now supported.

  • v1.5.2 Changes

    April 17, 2018

    ๐Ÿš€ This is a quick patch release that makes LICENSE part of the single header file, making it easier to include. Minor cleanup from codacy. No significant code changes from 1.5.1.

  • v1.5.1 Changes

    April 12, 2018

    ๐Ÿš€ This patch release adds better access to the App progromatically, to assist with writing custom converters to other formats. It also improves the help output, and uses a new feature in CLI11 1.5 to fix an old "quirk" in the way unlimited options and positionals interact.

    • ๐Ÿ‘‰ Make mixing unlimited positionals and options more intuitive #102
    • Add missing getters get_options and get_description to App #105
    • The app name now can be set, and will override the auto name if present #105
    • โž• Add (REQUIRED) for required options #104
    • ๐Ÿ–จ Print simple name for Needs/Excludes #104
    • ๐Ÿ–จ Use Needs instead of Requires in help print #104
    • Groups now are listed in the original definition order #106
  • v1.5 Changes

    ๐Ÿ›  This version introduced support for optionals, along with clarification and examples of custom conversion overloads. Enums now have been dropped from the automatic conversion system, allowing explicit protection for out-of-range ints (or a completely custom conversion). This version has some internal cleanup and improved support for the newest compilers. Several bugs were fixed, as well.

    ๐Ÿš€ Note: This is the final release with requires, please switch to needs.

    • ๐Ÿ›  Fix unlimited short options eating two values before checking for positionals when no space present #90
    • Symmetric exclude text when excluding options, exclude can be called multiple times #64
    • Support for std::optional, std::experimental::optional, and boost::optional added if __has_include is supported #95
    • All macros/CMake variables now start with CLI11_ instead of just CLI_ #95
    • ๐Ÿ›  The internal stream was not being cleared before use in some cases. Fixed. #95
    • Using an enum now requires explicit conversion overload #97
    • ๐Ÿšš The separator -- now is removed when it ends unlimited arguments #100

    Other, non-user facing changes:

    • โž• Added Macros.hpp with better C++ mode discovery #95
    • ๐Ÿ—„ Deprecated macros added for all platforms
    • โœ… C++17 is now tested on supported platforms #95
    • โœ… Informational printout now added to CTest #95
    • ๐Ÿ‘ Better single file generation #95
    • โž• Added support for GTest on MSVC 2017 (but not in C++17 mode, will need next version of GTest)
    • Types now have a specific size, separate from the expected number - cleaner and more powerful internally #92
    • โœ… Examples now run as part of testing #99
  • v1.4 Changes

    ๐Ÿ”จ This version adds lots of smaller fixes and additions after the refactor in version 1.3. More ways to download and use CLI11 in CMake have been added. INI files have improved support.

    • Lexical cast is now more strict than before #68 and fails on overflow #84
    • โž• Added get_parent() to access the parent from a subcommand
    • โž• Added ExistingPath validator #73
    • app.allow_ini_extras() added to allow extras in INI files #70
    • ๐Ÿ‘ Multiline INI comments now supported
    • Descriptions can now be written with config_to_str #66
    • ๐Ÿ–จ Double printing of error message fixed #77
    • ๐Ÿ“‡ Renamed requires to needs to avoid C++20 keyword #75, #82
    • ๐Ÿ‘‰ MakeSingleHeader now works if outside of git #78
    • โž• Adding install support for CMake #79, improved support for find_package #83, #84
    • โž• Added support for #83