Permalink
Fetching contributors…
Cannot retrieve contributors at this time
2815 lines (1446 sloc) 139 KB

v2.32.0 (2018-06-26)

Minimum Required Rust

  • As of this release, clap requires rustc 1.21.0 or greater.

Features

  • Completions: adds completion support for Elvish. (e9d0562a)

Improvements

  • macros: Support shorthand syntax for ArgGroups (df9095e7)

Bug Fixes

  • OsValues: Add ExactSizeIterator implementation (356c69e5)
  • arg_enum!: Invalid expansions of some trailing-comma patterns (7023184f)
  • help message: Unconditionally uses long description for subcommands (6acc8b6a, closes #897)

Documentation

  • Refer to macOS rather than OSX. (ab0d767f)

v2.31.2 (2018-03-19)

Bug Fixes

  • Fish Completions: fixes a bug that only allowed a single completion in in Fish Shell (e8774a8, closes #1212)
  • AllowExternalSubcommands: fixes a bug where external subcommands would be blocked by a similarly named subcommand (suggestions were getting in the way). (a410e85)

Documentation

  • Fixes some typos in the README.md (c8e685d7)

v2.31.1 (2018-03-06)

Improvements

  • AllowMissingPositional: improves the ability of AllowMissingPositional to allow 'skipping' to the last positional arg with '--' (df20e6e2)

v2.31.0 (2018-03-04)

Features

  • Arg Indices: adds the ability to query argument value indices (f58d0576)
  • Indices: implements an Indices<Item=&usize> iterator (1e67be44)
  • Raw Args adds a convenience function to Arg that allows implying all of Arg::last Arg::allow_hyphen_values and Arg::multiple(true) (66a78f29)

Documentation

Improvements

  • Cargo.toml: use codegen-units = 1 in release and bench profiles (19f425ea)
  • Adds WASM support (clap now compiles on WASM!) (689949e5)
  • Uses the short help tool-tip for PowerShell completion scripts (ecda22ce)

v2.30.0 (2018-02-13)

Bug Fixes

  • YAML: Adds a missing conversion from Arg::last when instantiating from a YAML file (aab77c81a5, closes #1160)

Improvements

  • Bash Completions: instead of completing a generic option name, all bash completions fall back to file completions UNLESS Arg::possible_values was used (872f02ae)
  • Deps: No longer needlessly compiles ansi_term on Windows since its not used (b57ee946, closes #1155)
  • Help Message: changes the [values: foo bar baz] array to [possible values: foo bar baz] for consistency with the API (414707e4e97, closes #1160)

v2.29.4 (2018-02-06)

Bug Fixes

  • Overrides Self: fixes a bug where options with multiple values couldnt ever have multiple values (d95907cf)

v2.29.3 (2018-02-05)

Improvements

  • Overrides: clap now supports arguments which override with themselves (6c7a0010, closes #976)

Bug Fixes

  • Requirements: fixes an issue where conflicting args would still show up as required (e06cefac, closes #1158)
  • Fixes a bug which disallows proper nesting of -- (73993fe, closes #1161)

New Settings

  • AllArgsOverrideSelf: adds a new convenience setting to allow all args to override themselves (4670325d)

v2.29.2 (2018-01-16)

Features

  • completions/zsh.rs:
    • Escape possible values for options (25561dec)
    • Implement postional argument possible values completion (f3b0afd2)
    • Complete positional arguments properly (e39aeab8)

Bug Fixes

  • completions/zsh.rs:
    • Add missing autoload for is-at-least (a6522607)
    • Don't pass -S to _arguments if Zsh is too old (16b4f143)
    • Maybe fix completions with mixed positionals and subcommands (1146f0da)
  • completions/zsh.zsh: Remove redundant code from output (0e185b92, closes #1142)

2.29.1 (2018-01-09)

Documentation

Performance

  • further debloating by removing generics from error cases (eb8d919e)
  • debloats clap by deduplicating logic and refactors (03e413d7)

Bug Fixes

  • fixes the ripgrep benchmark by adding a value to a flag that expects it (d26ab2b9)
  • bash completion: Change the bash completion script code generation to support hyphens. (ba7f1d18)
  • completions/zsh.rs: Fix completion of long option values (46365cf8)

2.29.0 (2017-12-02)

API Additions

  • Arg: adds Arg::hide_env_values(bool) which allows one to hide any current env values and display only the key in help messages (fb41d062)

2.28.0 (2017-11-28)

The minimum required Rust is now 1.20. This was done to start using bitflags 1.0 and having >1.0 deps is a very good thing!

Documentation

  • changes the demo version to 2.28 to stay in sync (ce6ca492)
  • Fix URL path to github hosted files (ce72aada, closes #1106)
  • fix typo (002b07fc)
  • README.md: updates the readme and pulls out some redundant sections (db6caf86)

Improvements

  • adds '[SUBCOMMAND]' to usage strings with only AppSettings::AllowExternalSubcommands is used with no other subcommands (e78bb757, closes #1093)

API Additions

  • Adds Arg::case_insensitive(bool) which allows matching Arg::possible_values without worrying about ASCII case (1fec268e, closes #1118)
  • Adds the traits to be used with the clap-derive crate to be able to use Custom Derive (6f4c3412)

Bug Fixes

  • Fixes a regression where --help couldn't be overridden (a283d69f, closes #1112)
  • fixes a bug that allowed options to pass parsing when no value was provided (2fb75821, closes #1105)
  • ignore PropagateGlobalValuesDown deprecation warning (f61ce3f5, closes #1086)

Deps

  • Updates bitflags to 1.0

v2.27.1 (2017-10-24)

Bug Fixes

  • Adds term_size as an optional dependency (with feature wrap_help) to fix compile bug

v2.27.0 (2017-10-24)

** This release raises the minimum required version of Rust to 1.18 **

** This release also contains a very minor breaking change to fix a bug **

The only CLIs affected will be those using unrestrained multiple values and subcommands where the subcommand name can coincide with one of the multiple values.

See the commit 0c223f54 for full details.

Bug Fixes

  • Values from global args are now propagated UP and DOWN!
  • fixes a bug where using AppSettings::AllowHyphenValues would allow invalid arguments even when there is no way for them to be valid (77ed4684, closes #1066)
  • when an argument requires a value and that value happens to match a subcommand name, its parsed as a value (0c223f54, closes #1031, breaks #, #)
  • fixes a bug that prevented number_of_values and default_values to be used together (5eb342a9, closes #1050, #1056)
  • fixes a bug that didn't allow args with default values to have conflicts (58b5b4be, closes #1071)
  • fixes a panic when using global args and calling App::get_matches_from_safe_borrow multiple times (d86ec797, closes #1076)
  • fixes issues and potential regressions with global args values not being propagated properly or at all (a43f9dd4, closes #1010, #1061, #978)
  • fixes a bug where default values are not applied if the option supports zero values (9c248cbf, closes #1047)

Documentation

  • adds addtional blurbs about using multiples with subcommands (03455b77)
  • updates the docs to reflect changes to global args and that global args values can now be propagated back up the stack (ead076f0)
  • add html_root_url attribute (e67a061b)
  • sync README version numbers with crate version (5536361b)

Improvements

  • args that have require_delimiter(true) is now reflected in help and usage strings (dce61699, closes #1052)
  • if all subcommands are hidden, the subcommands section of the help message is no longer displayed (4ae7b046, closes #1046)

Breaking Changes

  • when an argument requires a value and that value happens to match a subcommand name, its parsed as a value (0c223f54, closes #1031, breaks #, #)

Deprecations

  • AppSettings::PropagateGlobalValuesDown: this setting is no longer required to propagate values down or up (2bb5ddce)

v2.26.2 (2017-09-14)

Improvements

  • if all subcommands are hidden, the subcommands section of the help message is no longer displayed (4ae7b046, closes #1046)

Bug Fixes

  • fixes a bug where default values are not applied if the option supports zero values (9c248cbf, closes #1047)

v2.26.1 (2017-09-14)

Bug Fixes

  • fixes using require_equals(true) and min_values(0) together (10ae208f, closes #1044)
  • escape special characters in zsh and fish completions (87e019fc)
  • avoid panic generating default help msg if term width set to 0 due to bug in textwrap 0.7.0 (b3eadb0d)
  • Change who's -> whose (53c1ffe8)
  • adds a debug assertion to ensure all args added to groups actually exist (7ad123e2, closes #917)
  • fixes a bug where args that allow values to start with a hyphen couldnt contain a double hyphen -- as a value (ab2f4c9e, closes #960)
  • fixes a bug where positional argument help text is misaligned (54c16836)
  • Help Message: fixes long_about not being usable (a8257ea0, closes #1043)
  • Suggestions: output for flag after subcommand (434ea5ba)

v2.26.0 (2017-07-29)

Minimum version of Rust is now v1.13.0 (Stable)

Improvements

  • bumps unicode-segmentation to v1.2 (cd7b40a2)

Performance

  • update textwrap to version 0.7.0 (c2d4e637)

v2.25.1 (2017-07-21)

Improvements

  • impl Default for Values + OsValues for any lifetime. (fb7d6231f1)

Documentation

  • Various documentation typos and grammar fixes

v2.25.0 (2017-06-20)

Features

  • use textwrap crate for wrapping help texts (b93870c1)

Improvements

  • Suggestions: suggests to use flag after subcommand when applicable (2671ca72)
  • Bumps bitflags crate to v0.9

Documentation

Documentation

  • App::template: adds details about the necessity to use AppSettings::UnifiedHelpMessage when using {unified} tags in the help template (cbea3d5a, closes #949)
  • Arg::allow_hyphen_values: updates the docs to include warnings for allow_hyphen_values and multiple(true) used together (f9b0d657)
  • README.md:
    • added a warning about using ~ deps (821929b5, closes #964)
  • clap_app!: adds using the @group specifier to the macro docs (826048cb, closes #932)

v2.24.2 (2017-05-15)

Bug Fixes

  • adds a debug assertion to ensure all args added to groups actually exist (14f6b8f3, closes #917)
  • fixes a bug where args that allow values to start with a hyphen couldnt contain a double hyphen -- as a value (ebf73a09, closes #960)
  • fixes a bug where positional argument help text is misaligned (54c16836)

Documentation

  • App::template: adds details about the necessity to use AppSettings::UnifiedHelpMessage when using {unified} tags in the help template (cf569438, closes #949)
  • Arg::allow_hyphen_values: updates the docs to include warnings for allow_hyphen_values and multiple(true) used together (ded5a2f1)
  • clap_app!: adds using the @group specifier to the macro docs (fe85fcb1, closes #932)

v2.24.0 (2017-05-07)

Bug Fixes

  • fixes a bug where args with last(true) and required(true) set were not being printed in the usage string (3ac533fe, closes #944)
  • fixes a bug that was printing the arg name, instead of value name when Arg::last(true) was used (e1fe8ac3, closes #940)
  • fixes a bug where flags were parsed as flags AND positional values when specific combinations of settings were used (20f83292, closes #946)

v2.24.0 (2017-05-05)

Documentation

API Additions

  • Arg: add default_value_os (d5ef8955)
  • arg_matches.rs: Added a Default implementation for Values and OsValues iterators. (0a4384e3)

v2.23.2 (2017-04-19)

Bug Fixes

  • PowerShell Completions: fixes a bug where powershells completions cant be used if no subcommands are defined (a8bce558, closes #931)

Improvements

  • bumps term_size to take advantage of better terminal dimension handling (e05100b7)
  • PowerShell Completions: massively dedups subcommand names in the generate script to make smaller scripts that are still functionally equiv (85b0e1cc)

Documentation

  • Fix a typo the minimum rust version required (71dabba3)

v2.23.1 (2017-04-05)

Bug Fixes

  • fixes a missing newline character in the autogenerated help and version messages in some instances (5ae9007d)

v2.23.0 (2017-04-05)

API Additions

  • App::long_about
  • App::long_version
  • App::print_long_help
  • App::write_long_help
  • App::print_long_version
  • App::write_long_version
  • Arg::long_help

Features

  • allows distinguishing between short and long version messages (-V/short or --version/long) (59272b06)
  • allows distinguishing between short and long help with subcommands in the same manner as args (6b371891)
  • allows specifying a short help vs a long help (i.e. varying levels of detail depending on if -h or --help was used) (ef1b24c3)
  • clap_app!: adds support for arg names with hyphens similar to longs with hyphens (f7a88779, closes #869)

Bug Fixes

  • fixes a bug that wasn't allowing help and version to be properly overridden (8b2ceb83, closes #922)

Documentation

  • clap_app!: documents the --("some-arg") method for using args with hyphens inside them (bc08ef3e, closes #919)

v2.22.2 (2017-03-30)

Bug Fixes

  • Custom Usage Strings: fixes the usage string regression when using help templates (0e4fd96d)

v2.22.1 (2017-03-24)

Bug Fixes

  • usage: fixes a big regression with custom usage strings (2c41caba)

v2.22.0 (2017-03-23)

API Additions

  • App::name: adds the ability to change the name of the App instance after creation (d49e8292, closes #908)
  • Arg::hide_default_value: adds ability to hide the default value of an argument from the help string (89e6ea86, closes #902)

v2.21.3 (2017-03-23)

Bug Fixes

  • yaml: adds support for loading author info from yaml (e04c390c)

v2.21.2 (2017-03-17)

Improvements

  • add fish subcommand help support (f8f68cf8)
  • options that use require_equals(true) now display the equals sign in help messages, usage strings, and errors" (c8eb0384, closes #903)

Bug Fixes

  • setting the max term width now correctly propagates down through child subcommands

v2.21.1 (2017-03-12)

Bug Fixes

  • ArgRequiredElseHelp: fixes the precedence of this error to prioritize over other error messages (74b751ff, closes #895)
  • Positionals: fixes some regression bugs resulting from old asserts in debug mode. (9a3bc98e, closes #896)

v2.21.0 (2017-03-09)

Performance

  • doesn't run arg_post_processing on multiple values anymore (ec516182)
  • changes internal use of VecMap to Vec for matched values of Args (22bf137a)
  • vastly reduces the amount of cloning when adding non-global args minus when they're added from App::args which is forced to clone (8da0303b)
  • refactor to remove unneeded vectors and allocations and checks for significant performance increases (0efa4119)

Documentation

  • Fix examples link in CONTRIBUTING.md (60cf875d)

Improvements

  • when AppSettings::SubcommandsNegateReqs and ArgsNegateSubcommands are used, a new more accurate double line usage string is shown (50f02300, closes #871)

API Additions

  • Arg::last: adds the ability to mark a positional argument as 'last' which means it should be used with -- syntax and can be accessed early (6a7aea90, closes #888)
  • provides default_value_os and default_value_if[s]_os (0f2a3782, closes #849)
  • provides App::help_message and App::version_message which allows one to override the auto-generated help/version flag associated help (389c413, closes #889)

New Settings

  • InferSubcommands: adds a setting to allow one to infer shortened subcommands or aliases (i.e. for subcommmand "test", "t", "te", or "tes" would be allowed assuming no other ambiguities) (11602032, closes #863)

Bug Fixes

  • doesn't print the argument sections in the help message if all args in that section are hidden (ce5ee5f5)
  • doesn't include the various [ARGS] [FLAGS] or [OPTIONS] if the only ones available are hidden (7b4000af, closes #882)
  • now correctly shows subcommand as required in the usage string when AppSettings::SubcommandRequiredElseHelp is used (8f0884c1)
  • fixes some memory leaks when an error is detected and clap exits (8c2dd287)
  • fixes a trait that's marked private accidentlly, but should be crate internal public (1ae21108)
  • Completions: fixes a bug that tried to propogate global args multiple times when generating multiple completion scripts (5e9b9cf4, closes #846)

Features

  • Options: adds the ability to require the equals syntax with options --opt=val (f002693d, closes #833)

v2.20.5 (2017-02-18)

Bug Fixes

  • clap_app!: fixes a critical bug of a missing fragment specifier when using !property style tags. (5635c1f94)

v2.20.4 (2017-02-15)

Bug Fixes

  • Completions: fixes a bug that tried to propogate global args multiple times when generating multiple completion scripts (5e9b9cf4, closes #846)

Documentation

  • Fix examples link in CONTRIBUTING.md (60cf875d)

v2.20.3 (2017-02-03)

Documentation

  • Macros: adds a warning about changing values in Cargo.toml not triggering a rebuild automatically (112aea3e, closes #838)

Bug Fixes

  • fixes a println->debugln typo (279aa62e)
  • fixes bash completions for commands that have an underscore in the name (7f5cfa72, closes #581)
  • fixes a bug where ZSH completions would panic if the binary name had an underscore in it (891a2a00, closes #581)
  • allow final word to be wrapped in wrap_help (564c5f0f, closes #828)
  • fixes a bug where global args weren't included in the generated completion scripts (9a1e006e, closes #841)

v2.20.2 (2017-02-03)

Bug Fixes

  • fixes a critical bug where subcommand settings were being propogated too far (74648c94, closes #832)

Improvements

  • adds ArgGroup::multiple to the supported YAML fields for building ArgGroups from YAML (d8590037, closes #840)

v2.20.1 (2017-01-31)

Bug Fixes

  • allow final word to be wrapped in wrap_help (564c5f0f, closes #828)
  • actually show character in debug output (84d8c547)
  • include final character in line lenght (aff4ba18)

Improvements

  • updates libc and term_size deps for the libc version conflict (6802ac4a)

Documentation

  • fix link from app_from_crate! to crate_authors! (#822) (5b29be9b)
  • fix spelling of "guaranteed" (4f30a65b)

New Settings

  • ArgsNegateSubcommands: disables args being allowed between subcommands (5e2af8c9, closes #793)
  • DontCollapseArgsInUsage: disables the collapsing of positional args into [ARGS] in the usage string (c2978afc, closes #769)
  • DisableHelpSubcommand: disables building the help subcommand (a10fc859)
  • AllowMissingPositional: allows one to implement $ prog [optional] <required> style CLIs where the second postional argument is required, but the first is optional (1110fdc7, closes #636)
  • PropagateGlobalValuesDown: automatically propagats global arg's values down through used subcommands (985536c8, closes #694)

API Additions

Arg
  • Arg::value_terminator: adds the ability to terminate multiple values with a given string or char (be64ce0c, closes #782)
  • Arg::default_value_if[s]: adds new methods for conditional default values (such as a particular value from another argument was used) (eb4010e7)
  • Arg::requires_if[s]: adds the ability to conditionally require additional args (such as if a particular value was used) (198449d6)
  • Arg::required_if[s]: adds the ability for an arg to be conditionally required (i.e. "arg X is only required if arg Y was used with value Z") (ee9cfddf)
  • Arg::validator_os: adds ability to validate values which may contain invalid UTF-8 (47232498)
Macros
  • crate_description!: Uses the Cargo.toml description field to fill in the App::about method at compile time (4d9a82db, closes #778)
  • crate_name!: Uses the Cargo.toml name field to fill in the App::new method at compile time (4d9a82db, closes #778)
  • app_from_crate!: Combines crate_version!, crate_name!, crate_description!, and crate_authors! into a single macro call to build a default App instance from the Cargo.toml fields (4d9a82db, closes #778)

Features

  • no_cargo: adds a no_cargo feature to disable Cargo-env-var-dependent macros for those not using cargo to build their crates (#786) (6fdd2f9d)

Bug Fixes

  • Options: fixes a critical bug where options weren't forced to have a value (5a5f2b1e, closes #665)
  • fixes a bug where calling the help of a subcommand wasn't ignoring required args of parent commands (d3d34a2b, closes #789)
  • Help Subcommand: fixes a bug where the help subcommand couldn't be overriden (d34ec3e0, closes #787)
  • Low Index Multiples: fixes a bug which caused combinations of LowIndexMultiples and Arg::allow_hyphen_values to fail parsing (26c670ca)

Improvements

  • Default Values: improves the error message when default values are involved (1f33de54, closes #774)
  • YAML: adds conditional requirements and conditional default values to YAML (9a4df327, closes #764)
  • Support --("some-arg-name") syntax for defining long arg names when using clap_app! macro (f41ec962)
  • Support ("some app name") syntax for defining app names when using clap_app! macro (9895b671, closes #759)
  • Help Wrapping: long app names (with spaces), authors, and descriptions are now wrapped appropriately (ad4691b7, closes #777)

Documentation

  • Conditional Default Values: fixes the failing doc tests of Arg::default_value_ifs (4ef09101)
  • Conditional Requirements: adds docs for Arg::requires_ifs (7f296e29)
  • README.md: fix some typos (f22c21b4)
  • src/app/mod.rs: fix some typos (5c9b0d47)

v2.19.3 (2016-12-28)

Bug Fixes

  • fixes a bug where calling the help of a subcommand wasn't ignoring required args of parent commands (a0ee4993, closes #789)

v2.19.2 (2016-12-08)

Bug Fixes

  • ZSH Completions: escapes square brackets in ZSH completions (7e17d5a3, closes #771)

Documentation

  • Examples: adds subcommand examples (0e0f3354, closes #766)
  • README.md: adds guidance on when to use ~ in version pinning, and clarifies breaking change policy (591eaefc, closes #765)

v2.19.1 (2016-12-01)

Bug Fixes

  • Help Messages: fixes help message alignment when specific settings are used on options (cd94b318, closes #760)

Improvements

  • Bash Completion: allows bash completion to fall back to traidtional bash completion upon no matching completing function (b1b16d56))

v2.19.0 (2016-11-21)

Features

  • allows specifying AllowLeadingHyphen style values, but only for specific args vice command wide (c0d70feb, closes #742)

Bug Fixes

  • Required Unless: fixes a bug where having required_unless set doesn't work when conflicts are also set (d20331b6, closes #753)
  • ZSH Completions: fixes an issue where zsh completions caused panics if there were no subcommands (49e7cdab, closes #754)

Improvements

  • Validators: improves the error messages for validators (65eb3385, closes #744)

Documentation

  • updates the docs landing page (01e1e33f)
  • adds the macro version back to the readme (45eb9bf1)
  • fix broken docs links (808e7cee)
  • Compatibility Policy: adds an official compatibility policy to (760d66dc, closes #740)
  • Contributing: updates the readme to improve the readability and contributing sections (eb51316c)

v2.18.0 (2016-11-05)

Features

  • Completions: adds completion support for PowerShell. (cff82c88, closes #729)

v2.17.1 (2016-11-02)

Bug Fixes

  • Low Index Multiples: fixes a bug where using low index multiples was propagated to subcommands (33924e88, closes #725)

v2.17.0 (2016-11-01)

Features

  • Positional Args: allows specifying the second to last positional argument as multiple(true) (1ced2a74, closes #725)

v2.16.4 (2016-10-31)

Improvements

  • Error Output: conflicting errors are now symetrical, meaning more consistent and less confusing (3d37001d, closes #718)

Documentation

  • Fix typo in example 13a_enum_values_automatic (c22fbc07)
  • README.md: fixes failing yaml example (#715) (21fba9e6)

Bug Fixes

  • ZSH Completions: fixes bug that caused panic on subcommands with aliases (5c70e1a0, closes #714)
  • debug: fixes the debug feature (#716) (6c11ccf4)

v2.16.3 (2016-10-28)

Bug Fixes

  • Derive display order after propagation (9cb6facf, closes #706)
  • yaml-example: inconsistent args (847f7199)

v2.16.2 (2016-10-25)

Bug Fixes

  • Fish Completions: fixes a bug where single quotes are not escaped (780b4a18, closes #704)

v2.16.1 (2016-10-24)

Bug Fixes

  • Help Message: fixes a regression bug where args with multiple(true) threw off alignment (ebddac79, closes #702)

v2.16.0 (2016-10-23)

Features

  • Completions: adds ZSH completion support (3e36b0ba, closes #699)

v2.15.0 (2016-10-21)

Features

  • AppSettings: adds new setting AppSettings::AllowNegativeNumbers (ab064546, closes #696)

Documentation

  • app/settings.rs: moves variants to roughly alphabetical order (9ed4d4d7)

v2.14.1 (2016-10-20)

Documentation

  • Improve documentation around features (4ee85b95)
  • reword docs for ErrorKind and app::Settings (3ccde7a4)
  • fix tests that fail when the "suggestions" feature is disabled (996fc381)
  • fix the OsString-using doc-tests (af9e1a39)
  • tag non-rust code blocks as such instead of ignoring them (0ba9f4b1)
  • ErrorKind: improve some errors about subcommands (9f6217a4)
  • yaml: make sure the doc-tests don't fail before "missing file" (8c0f5551)

Improvements

  • Stabilize clap_app! (cd516006)
  • with_defaults: Deprecate App::with_defaults() (26085409, closes #638)

Bug Fixes

  • fixes a bug that made determining when to auto-wrap long help messages inconsistent (468baadb, closes #688)
  • Completions: fish completions for nested subcommands (a61eaf8a)
  • features: Make lints not enable other nightly-requiring features (835f75e3)

v2.14.0 (2016-10-05)

Features

  • arg_aliases: Ability to alias arguments (33b5f6ef, closes #669)
  • flag_aliases: Ability to alias flags (40d6dac9)

Bug Fixes

  • UsageParser: Handle non-ascii names / options. (1d6a7c6e, closes #664)

Documentation

v2.13.0 (2016-09-18)

Documentation

  • updates README.md with new website information and updated video tutorials info (0c19c580)
  • updates the docs about removing implicit value_delimiter(true) (c81bc722)
  • Default Values: adds better examples on using default values (57a8d9ab, closes #418)

Bug Fixes

  • Value Delimiters: fixes the confusion around implicitly setting value delimiters. (default is now false) (09d4d0a9, closes #666)

v2.12.1 (2016-09-13)

Bug Fixes

  • Help Wrapping: fixes a regression-bug where the old {n} newline char stopped working (92ac353b, closes #661)

v2.12.0 (2016-09-13)

Features

  • Help: adds ability to hide the possible values on a per argument basis (9151ef73, closes #640)
  • help: allow for limiting detected terminal width (a43e28af, closes #653)

Documentation

  • Help Wrapping: removes the verbiage about using '{n}' to insert newlines in help text (c5a2b352)
  • Value Delimiters: updates the docs for the Arg::multiple method WRT value delimiters and default settings (f9d17a06)
  • appsettings: Document AppSetting::DisableVersion (94501965, closes #589)

Bug Fixes

  • AllowLeadingHyphen: fixes a bug where valid args aren't recognized with this setting (a9699e4d, closes #588)

Improvements

  • Help Wrapping:
    • clap now ignores hard newlines in help messages and properly re-aligns text, but still wraps if the term width is too small (c7678523, closes #617)
    • makes some minor changes to when next line help is automatically used (01cae799)
  • Value Delimiters: changes the default value delimiter rules (f9e69254, closes #655)
  • YAML: supports setting Arg::require_delimiter from YAML (b9b55a39)

Performance

  • help: fix redundant contains() checks (a8afed74)

v2.11.3 (2016-09-07)

Documentation

  • Help Wrapping: removes the verbiage about using '{n}' to insert newlines in help text (c5a2b352)

Improvements

  • Help Wrapping:
    • clap now ignores hard newlines in help messages and properly re-aligns text, but still wraps if the term width is too small (c7678523, closes #617)
    • makes some minor changes to when next line help is automatically used (01cae799)
  • YAML: supports setting Arg::require_delimiter from YAML (b9b55a39)

v2.11.2 (2016-09-06)

Improvements

  • Help Wrapping: makes some minor changes to when next line help is automatically used (5658b117)

v2.11.1 (2016-09-05)

Bug Fixes

  • Settings: fixes an issue where settings weren't propogated down through grand-child subcommands (b3efc107, closes #638)

Features

  • Errors: Errors with custom description (58512f2f)

Improvements

  • help: use term_size instead of home-grown solution (fc7327e9)

v2.11.0 (2016-08-28)

Bug Fixes

  • Groups: fixes some usage strings that contain both args in groups and ones that conflict with each other (3d782def, closes #616)

Documentation

Improvements

  • Completions: uses standard conventions for bash completion files, namely '{bin}.bash-completion' (27f5bbfb, closes #567)
  • Help: automatically moves help text to the next line and wraps when term width is determined to be too small, or help text is too long (150964c4, closes #597)
  • YAML Errors: vastly improves error messages when using YAML (f43b7c65, closes #574)

Features

  • adds App::with_defaults to automatically use crate_authors! and crate_version! macros (5520bb01, closes #600)

v2.10.4 (2016-08-25)

Bug Fixes

  • Help Wrapping: fixes a bug where help is wrapped incorrectly and causing a panic with some non-English characters (d0b442c7, closes #626)

v2.10.3 (2016-08-25)

Features

  • Help: adds new short hand way to use source formatting and ignore term width in help messages (7dfdaf20, closes #625)

Documentation

  • Term Width: adds details about set_term_width(0) (00b8205d)

Bug Fixes

  • Unicode: fixes two bugs where non-English characters were stripped or caused a panic with help wrapping (763a5c92, closes #626)

v2.10.2 (2016-08-22)

Bug Fixes

  • fixes a bug where the help is printed twice (a643fb28, closes #623)

v2.10.1 (2016-08-21)

Bug Fixes

  • Help Subcommand: fixes misleading usage string when using multi-level subcommmands (e203515e, closes #618)

Features

  • YAML: allows using lists or single values with arg declarations (9ade2cd4, closes #614, #613)

v2.10.0 (2016-07-29)

Features

  • Completions: one can generate a basic fish completions script at compile time (1979d2f2)

Bug Fixes

  • parser: preserve external subcommand name (875df243)

Breaking Changes

  • parser: preserve external subcommand name (875df243)

Documentation

  • YAML: fixes example 17's incorrect reference to arg_groups instead of groups (b6c99e13, closes #601)

2.9.3 (2016-07-24)

Bug Fixes

  • fixes bug where only first arg in list of required_unless_one is recognized (1fc3b55b, closes #575)
  • Settings: fixes typo subcommandsrequired->subcommandrequired (fc72cdf5, closes #593)

Features

  • Completions: adds the ability to generate completions to io::Write object (9f62cf73)
  • Settings: Add unset_setting and unset_settings fns to App (#598) (0ceba231, closes #590)

2.9.2 (2016-07-03)

Documentation

  • Completions: fixes the formatting of the Cargo.toml excerpt in the completions example (722f2607)

Bug Fixes

  • Completions: fixes bug where --help and --version short weren't added to the completion list (e9f2438e, closes #536)

2.9.1 (2016-07-02)

Improvements

  • Completions: allows multiple completions to be built by namespacing with bin name (57484b2d)

v2.9.0 (2016-07-01)

Documentation

  • Completions:
    • fixes some errors in the completion docs (9b359bf0)
    • adds documentation for completion scripts (c6c519e4)

Features

  • Completions:
    • one can now generate a bash completions script at compile time! (e75b6c7b, closes #376)
    • completions now include aliases to subcommands, including all subcommand options (0ab9f840, closes #556)
    • completions now continue completing even after first completion (18fc2e5b)
    • allows matching on possible values in options (89cc2026, closes #557)

Bug Fixes

  • AllowLeadingHyphen: fixes an issue where isn't ignored like it should be with this setting (96c24c9a, closes #558)

v2.8.0 (2016-06-30)

Features

  • Arg: adds new setting Arg::require_delimiter which requires val delimiter to parse multiple values (920b5595)

Bug Fixes

  • Declare term::Winsize as repr(C) (5d663d90)

Documentation

v2.7.1 (2016-06-29)

Bug Fixes

  • Options:
    • options with multiple values and using delimiters no longer parse additional values after a trailing space (cdc500bd)
    • using options with multiple values and with an = no longer parse args after the trailing space as values (290f61d0)

v2.7.0 (2016-06-28)

Documentation

  • fix typos (43b3d40b)
  • ArgGroup: vastly improves ArgGroup docs by adding better examples (9e5f4f5d, closes #534)

Features

  • ArgGroup: one can now specify groups which require AT LEAST one of the args (33689acc, closes #533)

Bug Fixes

  • App: using App::print_help now prints the same as would have been printed by --help or the like (e84cc018, closes #536)
  • Help:
    • prevents invoking help help and displaying incorrect help message (e3d2893f, closes #538)
    • subcommand help messages requested via help now correctly match --help (08ad1cff, closes #539)

Improvements

  • ArgGroup: Add multiple ArgGroups per Arg (902e182f, closes #426)
  • Usage Strings: [FLAGS] and [ARGS] are no longer blindly added to usage strings (9b2e45b1, closes #537)
  • arg_enum!: allows using meta items like repr(C) with arg_enum!s (edf9b233, closes #543)

v2.6.0 (2016-06-14)

Improvements

  • removes extra newline from help output (86e61d19)
  • allows printing version to any io::Write object (921f5f79)
  • removes extra newline when printing version (7e2e2cbb)
  • Aliases: improves readability of asliases in help messages (ca511de7, closes #526, #529)
  • Usage Strings: improves the default usage string when only a single positional arg is present (ec86f2da, closes #518)

Features

  • Help: allows wrapping at specified term width (Even on Windows!) (1761dc0d, closes #451)
  • Settings:
    • adds new setting to stop delimiting values with -- or TrailingVarArg (fc3e0f5a, closes #511)
    • one can now set an AppSetting which is propogated down through child subcommands (e2341835, closes #519)
  • Subcommands: adds support for visible aliases (7b10e7f8, closes #522)

Bug Fixes

  • fixes bug where args are printed out of order with templates (05abb534)
  • fixes bug where one can't override version or help flags (90d7d6a2, closes #514)
  • fixes issue where before_help wasn't printed (b3faff60)
  • Help: App::before_help and App::after_help now correctly wrap (1f4da767, closes #516)
  • Settings: fixes bug where new color settings couldn't be converted from strs (706a7c11)
  • Subcommands: subcommands with aliases now display help of the aliased subcommand (5354d14b, closes #521)
  • Windows: fixes a failing windows build (01e7dfd6)
  • YAML: adds missing YAML methods for App and Arg (e468faf3, closes #528)

v2.5.2 (2016-05-31)

Improvements

  • removes extra newline from help output (86e61d19)
  • allows printing version to any io::Write object (921f5f79)
  • removes extra newline when printing version (7e2e2cbb)

Bug Fixes

  • fixes bug where args are printed out of order with templates (3935431d)
  • fixes bug where one can't override version or help flags (90d7d6a2, closes #514)
  • fixes issue where before_help wasn't printed (b3faff60)

Documentation

  • inter-links all types and pages (3312893d, closes #505)
  • makes all publicly available types viewable in docs (52ca6505)

v2.5.1 (2016-05-11)

Bug Fixes

  • Subcommand Aliases: fixes lifetime issue when setting multiple aliases at once (ac42f6cf0)

v2.5.0 (2016-05-10)

Improvements

  • SubCommand Aliases: adds feature to yaml configs too (69592195)

Features

  • SubCommands: adds support for subcommand aliases (66b4dea6, closes #469)

v2.4.3 (2016-05-10)

Bug Fixes

  • Usage Strings:
    • now properly dedups args that are also in groups (3ca0947c, closes #498)
    • removes duplicate groups from usage strings (f574fb8a)

Improvements

  • Groups: formats positional args in groups in a better way (fef11154)
  • Help:
    • moves positionals to standard <> formatting (03dfe5ce)
    • default help subcommand string has been shortened (5b7fe8e4, closes #494)

v2.4.3 (2016-05-10)

  • Ghost Release

v2.4.3 (2016-05-10)

  • Ghost Release

v2.4.0 (2016-05-02)

Features

  • Help: adds support for displaying info before help message (29fbfa3b)
  • Required: adds allowing args that are required unless certain args are present (af1f7916)

Documentation

  • hides formatting from docs (cb708093)
  • required_unless: adds docs and examples for required_unless (ca727b52)

Bug Fixes

  • Required Args: fixes issue where missing required args are sometimes duplicatd in error messages (3beebd81, closes #492)

v2.3.0 (2016-04-18)

Improvements

  • macros.rs: Added write_nspaces macro (a new version of write_spaces) (9d757e86)
  • parser.rs:
    • Provide a way to create a usage string without the USAGE: title (a91d378b)
    • Make Parser's create_usage public allowing to have function outside the parser to generate the help (d51945f8)
    • Expose Parser's flags, opts and positionals argument as iterators (9b23e7ee)
  • src/args: Exposes argument display order by introducing a new Trait (1321630e)
  • srs/args: Added longest_filter to AnyArg trait (65b3f667)

Features

  • Authors Macro: adds a crate_authors macro (38fb59ab, closes #447)
  • HELP:
    • implements optional colored help messages (abc8f669, closes #483)
    • Add a Templated Help system. (81e121ed)

Bug Fixes

  • HELP: Adjust Help to semantic changes introduced in 6933b84 (8d23806b)

v2.2.6 (2016-04-11)

Bug Fixes

  • Arg Groups: fixes bug where arg name isn't printed properly (3019a685, closes #476)

v2.2.5 (2016-04-03)

Bug Fixes

  • Empty Values: fixes bug where empty values weren't stored (885d166f, closes #470)
  • Help Message: fixes bug where arg name is printed twice (71acf1d5, closes #472)

v2.2.4 (2016-03-30)

Bug Fixes

  • fixes compiling with debug cargo feature (d4b55450)
  • Empty Values: fixes bug where empty values weren't stored (885d166f, closes #470)

v2.2.3 (2016-03-28)

Bug Fixes

  • Help Subcommand: fixes issue where help and version flags weren't properly displayed (205b07bf, closes #466)

v2.2.2 (2016-03-27)

Bug Fixes

  • Help Message: fixes bug with wrapping in the middle of a unicode sequence (05365ddc, closes #456)
  • Usage Strings: fixes small bug where -- would appear needlessly in usage strings (6933b849, closes #461)

2.2.1 (2016-03-16)

Features

  • Help Message: wraps and aligns the help message of subcommands (813d75d0, closes #452)

Bug Fixes

  • Help Message: fixes a bug where small terminal sizes causing a loop (1d73b035, closes #453)

v2.2.0 (2016-03-15)

Features

  • Help Message: can auto wrap and aligning help text to term width (e36af026, closes #428)
  • Help Subcommand: adds support passing additional subcommands to help subcommand (2c12757b, closes #416)
  • Opts and Flags: adds support for custom ordering in help messages (9803b51e)
  • Settings: adds support for automatically deriving custom display order of args (ad86e433, closes #444)
  • Subcommands: adds support for custom ordering in help messages (7d2a2ed4, closes #442)

Bug Fixes

  • From Usage: fixes a bug where adding empty lines werent ignored (c5c58c86)

Documentation

  • Groups: explains required ArgGroups better (4ff0205b, closes #439)

v2.1.2 (2016-02-24)

Bug Fixes

  • Nightly: fixes failing nightly build (d752c170, closes #434)

v2.1.1 (2016-02-19)

Documentation

  • AppSettings: clarifies that AppSettings do not propagate (3c8db0e9, closes #429)
  • Arg Examples: adds better examples (1e79cccc)

Improvements

  • Help: adds setting for next line help by arg (066df748, closes #427)

v2.1.0 (2016-02-10)

Features

  • Defult Values: adds support for default values in args (73211952, closes #418)

Documentation

  • Default Values: adds better examples and notes for default values (9facd74f)

v2.0.6 (2016-02-09)

Improvements

  • Positional Arguments: now displays value name if appropriate (f0a99916, closes #420)

v2.0.5 (2016-02-05)

Bug Fixes

  • Multiple Values: fixes bug where number_of_values wasnt respected (72c387da)

v2.0.4 (2016-02-04)

Bug Fixes

  • adds support for building ArgGroups from standalone YAML (fcbc7e12)
  • Stop lonely hyphens from causing panic (85b11468, closes #410)
  • AppSettings: fixes bug where subcmds didn't receive parent ver (a62e4527)

v2.0.3 (2016-02-02)

Improvements

  • values: adds support for up to u64::max values per arg (c7abf7d7)
  • occurrences: Allow for more than 256 occurrences of an argument. (3731ddb3)

Features

  • AppSettings: adds HidePossibleValuesInHelp to skip writing those values (cdee7a0e)

Bug Fixes

  • value_t_or_exit: fixes typo which causes value_t_or_exit to return a Result (ee96baff)

v2.0.2 (2016-01-31)

Improvements

  • arg_enum: enum declared with arg_enum returns [&'static str; #] instead of Vec (9c4b8a1a)

Bug Fixes

  • clap_app! should be gated by unstable, not nightly feature (0c8b84af)
  • SubCommands: fixed where subcmds weren't recognized after mult args (c19c17a8, closes #405)
  • Usage Parser: fixes a bug where literal single quotes weren't allowed in help strings (0bcc7120, closes #406)

v2.0.1 (2016-01-30)

Bug Fixes

  • fixes cargo features to NOT require nightly with unstable features (dcbcc60c, closes #402)

v2.0.0 (2016-01-28)

Improvements

  • From Usage: vastly improves the usage parser (fa3a2f86, closes #350)

Features

  • adds support for external subcommands (177fe5cc, closes #372)
  • adds support values with a leading hyphen (e4d429b9, closes #385)
  • adds support for turning off the value delimiter (508db850, closes #352)
  • adds support changing the value delimiter (dafeae8a, closes #353)
  • adds support for comma separated values (e69da6af, closes #348)
  • adds support with options with optional values (4555736c, closes #367)
  • UTF-8: adds support for invalid utf8 in values (c5c59dec, closes #269)
  • v2: implementing the base of 2.x (a3536054)

Bug Fixes

  • fixes nightly build with new lints (17599195)
  • fixes Windows build for 2x release (674c9b48, closes #392)
  • fixes yaml build for 2x base (adceae64)

Documentation

  • updates examples for 2x release (1303b360, closes #394)
  • updates examples for 2x release (0a011f31, closes #394)
  • updates documentation for v2 release (8d51724e)
  • updating docs for 2x release (576d0e0e)
  • README.md:
    • updates readme for v2 release (acaba01a, closes #393)
    • fix typo and make documentation conspicuous (07b9f614)

BREAKING CHANGES

  • Fewer liftimes! Yay!
  • App<'a, 'b, 'c, 'd, 'e, 'f> => App<'a, 'b>
  • Arg<'a, 'b, 'c, 'd, 'e, 'f> => Arg<'a, 'b>
  • ArgMatches<'a, 'b> => ArgMatches<'a>
  • Simply Renamed
  • App::arg_group => App::group
  • App::arg_groups => App::groups
  • ArgGroup::add => ArgGroup::arg
  • ArgGroup::add_all => ArgGroup::args
  • ClapError => Error
  • struct field ClapError::error_type => Error::kind
  • ClapResult => Result
  • ClapErrorType => ErrorKind
  • Removed Deprecated Functions and Methods
  • App::subcommands_negate_reqs
  • App::subcommand_required
  • App::arg_required_else_help
  • App::global_version(bool)
  • App::versionless_subcommands
  • App::unified_help_messages
  • App::wait_on_error
  • App::subcommand_required_else_help
  • SubCommand::new
  • App::error_on_no_subcommand
  • Arg::new
  • Arg::mutually_excludes
  • Arg::mutually_excludes_all
  • Arg::mutually_overrides_with
  • simple_enum!
  • Renamed Error Variants
  • InvalidUnicode => InvalidUtf8
  • InvalidArgument => UnknownArgument
  • Usage Parser
  • Value names can now be specified inline, i.e. -o, --option <FILE> <FILE2> 'some option which takes two files'
  • There is now a priority of order to determine the name - This is perhaps the biggest breaking change. See the documentation for full details. Prior to this change, the value name took precedence. Ensure your args are using the proper names (i.e. typically the long or short and NOT the value name) throughout the code
  • ArgMatches::values_of returns an Values now which implements Iterator (should not break any code)
  • crate_version! returns &'static str instead of String
  • Using the clap_app! macro requires compiling with the unstable feature because the syntax could change slightly in the future

v1.5.5 (2016-01-04)

Bug Fixes

  • fixes an issue where invalid short args didn't cause an error (c9bf7e44)
  • prints the name in version and help instead of binary name (8f3817f6, closes #368)
  • fixes an intentional panic issue discovered via clippy (ea83a3d4)

v1.5.4 (2015-12-18)

Examples

  • 17_yaml: conditinonally compile 17_yaml example (575de089)

Improvements

Bug Fixes

  • errors: return correct error type in WrongNumValues error builder (5ba8ba9d)
  • ArgRequiredElseHelp setting now takes precedence over missing required args (faad83fb, closes #362)

v1.5.3 (2015-11-20)

Bug Fixes

  • Errors: fixes some instances when errors are missing a final newline (c4d2b171)

v1.5.2 (2015-11-14)

Bug Fixes

  • Errors: fixes a compiling bug when built on Windows or without the color feature (a35f7634)

v1.5.1 (2015-11-13)

Bug Fixes

  • Required Args: fixes a bug where required args are not correctly accounted for (f03b88a9, closes #343)

v1.5.0 (2015-11-13)

Bug Fixes

  • fixes a bug with required positional args in usage strings (c6858f78)

Documentation

  • FAQ: updates readme with slight changes to FAQ (a4ef0fab)

Improvements

  • massive errors overhaul (cdc29175)
  • ArgMatcher: huge refactor and deduplication of code (8988853f)
  • Errors: errors have been vastly improved (e59bc0c1)
  • Traits: refactoring some configuration into traits (5800cdec)

Performance

  • App:
    • more BTreeMap->Vec, Opts and SubCmds (bc4495b3)
    • changes flags BTreeMap->Vec (d357640f)
    • removed unneeded BTreeMap (78971fd6)
    • changes BTreeMap to VecMap in some instances (64b921d0)
    • removed excess clones (ec0089d4)

v1.4.7 (2015-11-03)

Documentation

  • Clarify behavior of Arg::multiple with options. (434f497a)
  • Fix typos and improve grammar. (c1f66b5d)

Bug Fixes

  • Error Status: fixes bug where --help and --version return non-zero exit code (89b51fdf)

v1.4.6 (2015-10-29)

Features

  • allows parsing without a binary name for daemons and interactive CLIs (aff89d57, closes #318)

Bug Fixes

  • Errors: tones down quoting in some error messages (34ce59ed, closes #309)
  • Help and Version: only builds help and version once (e3be87cf)
  • Option Args: fixes bug with args and multiple values (c9a9548a, closes #323)
  • POSIX Overrides: fixes bug where required args are overridden (40ed2b50)
  • Safe Matches: using 'safe' forms of the get_matches family no longer exit the process (c47025dc, closes #256)
  • Versionless SubCommands: fixes a bug where the -V flag was needlessly built (27df8b9d, closes #329)

Documentation

v1.4.5 (2015-10-06)

Bug Fixes

  • fixes crash on invalid arg error (c78ce128)

v1.4.4 (2015-10-06)

Documentation

  • clean up some formatting (b7df92d7)
  • move the crate-level docs to top of the lib.rs file (d7233bf1)
  • changes doc comments to rustdoc comments (34b601be)
  • fixes panic in 14_groups example (945b00a0, closes #295)
  • avoid suggesting star dependencies. (d33228f4)
  • Rustdoc: adds portions of the readme to main rustdoc page (6f9ee181, closes #293)

Bug Fixes

  • grammar error in some conflicting option errors (e73b07e1)
  • Unified Help: sorts both flags and options as a unified category (2a223dad)
  • Usage: fixes a bug where required args aren't filtered properly (72b453dc, closes #277)
  • Usage Strings: fixes a bug ordering of elements in usage strings (aaf0d6fe, closes #298)

Features

  • supports -aValue style options (0e3733e4)
  • Trailing VarArg: adds opt-in setting for final arg being vararg (27018b18, closes #278)

v1.4.3 (2015-09-30)

Features

  • allows accessing arg values by group name (c92a4b9e)

Documentation

  • use links to examples instead of plain text (bb4fe237)

Bug Fixes

  • Help Message: required args no longer double list in usage (1412e639, closes #277)
  • Possible Values: possible value validation is restored (f121ae74, closes #287)

v1.4.2 (2015-09-23)

Bug Fixes

  • Conflicts: fixes bug with conflicts not removing required args (e17fcec5, closes #271)

v1.4.1 (2015-09-22)

Examples

Features

  • Unicode: allows non-panicing on invalid unicode characters (c5bf7ddc)

Documentation

  • properly names Examples section for rustdoc (87ba5445)
  • fixes various typos and spelling (f85640f9)
  • Arg: unhides fields of the Arg struct (931aea88)

Bug Fixes

  • flush the buffer in App::print_version() (cbc42a37)
  • Macro benchmarks (13712da1)

v1.4.0 (2015-09-09)

Features

  • allows printing help message by library consumers (56b95f32)
  • allows defining hidden args and subcmds (2cab4d03, closes #231)
  • Builder macro to assist with App/Arg/Group/SubCommand building (443841b0)
  • Errors: allows consumers to write to stderr and exit on error (1e6403b6)

v1.3.2 (2015-09-08)

Documentation

  • fixed ErrorKind docs (dd057843)
  • ErrorKind: changed examples content (b9ca2616)

Bug Fixes

  • fixes a bug where the help subcommand wasn't overridable (94003db4)

Features

  • adds abiltiy not consume self when parsing matches and/or exit on help (94003db4)
  • App: Added ability for users to handle errors themselves (934e6fbb)

v1.3.1 (2015-09-04)

Examples

Performance

  • changes ArgGroup HashSets to Vec (3cb4a48e)
  • changes BTreeSet for Vec in some instances (baab2e3f)

v1.3.0 (2015-09-01)

Features

  • YAML: allows building a CLI from YAML files (86cf4c45)
  • ArgGroups: adds support for building ArgGroups from yaml (ecf88665)
  • Subcommands: adds support for subcommands from yaml (e415cf78)

Documentation

  • YAML: adds examples for using YAML to build a CLI (ab41d7f3)
  • Args from YAML: fixes doc examples (19b348a1)
  • Examples: adds better usage examples instead of having unused variables (8cbacd88)

Examples

Bug Fixes

  • Unified Help Messages: fixes a crash from this setting and no opts (169ffec1, closes #210)

v1.2.5 (2015-08-27)

Examples

Features

  • Args: allows opts and args to define a name for help and usage msgs (ad962ec4)

v1.2.4 (2015-08-26)

Bug Fixes

  • Possible Values: fixes a bug where suggestions arent made when using --long=value format (3d5e9a6c, closes #192)

v1.2.3 (2015-08-24)

Bug Fixes

  • App, Args: fixed subcommand reqs negation (b41afa8c, closes #188)

v1.2.2 (2015-08-23)

Bug Fixes

  • fixed confusing error message, also added test for it (fc7a31a7)
  • App: fixed requirmets overriding (9c135eb7)

v1.2.1 (2015-08-20)

Documentation

  • README.md: updates for new features (16cf9245)

Features

  • implements posix compatible conflicts for long args (8c2d48ac)
  • added overrides to support conflicts in POSIX compatible manner (0b916a00)
  • Args: allows defining POSIX compatible argument conflicts (d715646e)

Bug Fixes

  • fixed links in cargo and license buttons (6d9837ad)

Performance

  • Args and Apps: changes HashSet->Vec in some instances for increased performance (d0c3b379)

v1.2.0 (2015-08-15)

Bug Fixes

Documentation

  • updates docs for new features (03496547)
  • fixed docs for previous changes (ade36778)

Improvements

  • AppSettings: adds ability to add multiple settings at once (4a00e251)

Features

  • Replace application level settings with enum variants (618dc4e2)
  • Args: allows for custom argument value validations to be defined (84ae2ddb, closes #170)

v1.1.6 (2015-08-01)

Bug Fixes

  • fixes two bugs in App when printing newlines in help and subcommands required error (d63c0136)

v1.1.5 (2015-07-29)

Performance

  • removes some unneeded allocations (93e915df)

v1.1.4 (2015-07-20)

Improvements

  • Usage Strings displays a [--] when it may be helpful (86c3be85)

Bug Fixes

  • Macros fixes a typo in a macro generated error message (c9195c5f)
  • Type Errors fixes formatting of error output when failed type parsing (fe5d95c6)

v1.1.3 (2015-07-18)

Documentation

  • updates README.md to include lack of color support on Windows (52f81e17)

Bug Fixes

  • fixes formatting bug which prevented compiling on windows (9cb5dceb, closes #163)

v1.1.2 (2015-07-17)

Bug Fixes

  • fixes a bug when parsing multiple {n} newlines inside help strings (6d214b54)

v1.1.1 (2015-07-17)

Bug Fixes

  • fixes a logic bug and allows setting Arg::number_of_values() < 2 (42b6d1fc, closes #161)

v1.1.0 (2015-07-16)

Features

  • allows creating unified help messages, a la docopt or getopts (52bcd892, closes #158)
  • allows stating all subcommands should not have --version flags (336c476f, closes #156)
  • allows setting version number to auto-propagate through subcommands (bc66d3c6, closes #157)

Improvements

  • Help Strings properly aligns and handles newlines in long help strings (f9800a29, closes #145)

Performance

  • Help Messages big performance improvements when printing help messages (52bcd892)

Documentation

  • updates readme with new features (8232f7bb)
  • fix incorrect code example for App::subcommand_required (8889689d)

v1.0.3 (2015-07-11)

Improvements

Documentation

  • README.md updates example help message to new format (0aca29bd)

v1.0.2 (2015-07-09)

Improvements

  • Usage re-orders optional arguments and required to natural standard (dc7e1fce, closes #147)

v1.0.1 (2015-07-08)

Bug Fixes

  • allows empty values when using --long='' syntax (083f82d3, closes #151)

v1.0.0 (2015-07-08)

Documentation

  • README.md adds new features to what's new list (938f7f01)
  • README.md use with_name for subcommands (28b7e316)

Features

  • args can now be parsed from arbitrary locations, not just std::env::args() (75312528)

v1.0.0-beta (2015-06-30)

Features

  • allows waiting for user input on error (d0da3bdd, closes #140)
  • Help allows one to fully override the auto-generated help message (26d5ae3e, closes #141)

Documentation

  • adds "whats new" section to readme (ff149a29)

Improvements

  • removes deprecated functions in prep for 1.0 (274484df)

v0.11.0 (2015-06-17) - BREAKING CHANGE

Documentation

  • updates docs to new version flag defaults (ebf442eb)

Features

  • Help and Version default short for version is now -V but can be overridden (only breaks manual documentation) (BREAKING CHANGE eb1d9320)

v0.10.5 (2015-06-06)

Bug Fixes

  • Global Args global arguments propogate fully now (1f377960, closes #137)

v0.10.4 (2015-06-06)

Bug Fixes

  • Global Args global arguments propogate fully now (8f2c0160, closes #137)

v0.10.3 (2015-05-31)

Bug Fixes

  • Global Args fixes a bug where globals only transfer to one subcommand (a37842ee, closes #135)

v0.10.2 (2015-05-30)

Improvements

  • Binary Names allows users to override the system determined bin name (2191fe94, closes #134)

Documentation

  • adds contributing guidelines (6f76bd0a)

v0.10.1 (2015-05-26)

Features

  • can now specify that an app or subcommand should display help on no args or subcommands (29ca7b2f, closes #133)

v0.10.0 (2015-05-23)

Features

  • Global Args allows args that propagate down to child commands (2bcc6137, closes #131)

Improvements

  • Colors implements more structured colored output (d6c3ed54, closes #129)

Deprecations

  • SubCommand/App several methods and functions for stable release (28b73855)

Documentation

  • updates for deprecations and new features (743eefe8)

v0.9.2 (2015-05-20)

Bug Fixes

  • help allows parent requirements to be ignored with help and version (52218cc1, closes #124)

v0.9.1 (2015-05-18)

Bug Fixes

  • help fixes a bug where requirements are included as program name in help and version (08ba3f25)

v0.9.0 (2015-05-17)

Improvements

  • usage usage strings now include parent command requirements (dd8f21c7, closes #125)
  • args allows consumer of clap to decide if empty values are allowed or not (ab4ec609, closes #122)

Features

  • subcommands
    • allows optionally specifying that no subcommand is an error (7554f238, closes #126)
    • subcommands can optionally negate parent requirements (4a4229f5, closes #123)

v0.8.6 (2015-05-17)

Bug Fixes

  • args - can now be parsed as a value for an argument (bc12e78e, closes #121)

v0.8.5 (2015-05-15)

Bug Fixes

  • macros makes macro errors consistent with others (0c264a8c, closes #118)

Features

  • macros
    • arg_enum! and simple_enum! provide a Vec<&str> of variant names (30fa87ba, closes #119)
    • arg_enum! and simple_enum! auto-implement Display (d1219f0d, closes #120)

v0.8.4 (2015-05-12)

Bug Fixes

  • suggestions --help and --version now get suggestions (d2b3b1fa, closes #116)

v0.8.3 (2015-05-10)

Bug Fixes

  • usage groups unfold their members in usage strings (55d15582, closes #114)

Performance

  • usage removes unneeded allocations (fd53cd18)

v0.8.2 (2015-05-08)

Bug Fixes

  • usage strings positional arguments are presented in index order (eb0e374e, closes #112)

v0.8.1 (2015-05-06)

Bug Fixes

  • subcommands stops parsing multiple values when subcommands are found (fc79017e, closes #109)

Improvements

  • color reduces color in error messages (aab44cca, closes #110)
  • suggestions adds suggested arguments to usage strings (99447414)

v0.8.0 (2015-05-06)

Bug Fixes

  • did-you-mean for review (0535cfb0)
  • Positional positionals were ignored if they matched a subcmd, even after '--' (90e7b081)
  • help fixes bug where space between arg and help is too long (632fb115)

Features

  • from_usage adds ability to add value names or num of vals in usage string (3d581976, closes #98)
  • did-you-mean
  • Flags adds sugestions functionality (8745071c)
  • errors colorizes output red on error (f8b26b13)

Improvements

  • arg_enum allows ascii case insensitivity for enum variants (b249f965, closes #104)
  • clap-test simplified make test invocation (d17dcb29)

Documentation

  • README adds details about optional and new features (960389de)
  • clap fix typos caught by codespell (8891d929)
  • from_usage explains new usage strings with multiple values (05476fc6)

v0.7.6 (2015-05-05)

Improvements

  • Options adds number of values to options in help/usage (c1c993c4)

Features

  • from_usage adds ability to add value names or num of vals in usage string (ad55748c, closes #98)

Bug Fixes

  • MultipleValues properly distinguishes between multiple values and multiple occurrences (dd2a7564, closes #99)
  • help fixes tab alignment with multiple values (847001ff)

Documentation

  • from_usage explains new usage strings with multiple values (5a3a42df)

v0.7.5 (2015-05-04)

Bug Fixes

  • Options fixes bug where options with no value don't error out (a1fb94be)

v0.7.4 (2015-05-03)

Bug Fixes

  • Options fixes a bug where option arguments in succession get their values skipped (f66334d0)

v0.7.3 (2015-05-03)

Bug Fixes

  • RequiredValues fixes a bug where missing values are parsed as missing arguments (93c4a723)

Improvements

  • ErrorMessages improves error messages and corrections (a29c3983)
  • ArgGroups improves requirement and confliction support for groups (c236dc5f)

v0.7.2 (2015-05-03)

Bug Fixes

  • RequiredArgs fixes bug where required-by-default arguments are not listed in usage (12aea961, closes #96)

v0.7.1 (2015-05-01)

Bug Fixes

  • MultipleValues stops evaluating values if the max or exact number of values was reached (86d92c9f)

v0.7.0 (2015-04-30) - BREAKING CHANGE

Bug Fixes

  • from_usage removes bug where usage strings have no help text (ad4e5451, closes #83)

Features

  • MultipleValues
    • add support for minimum and maximum number of values (53f6b8c9)
    • adds support limited number and named values (ae09f05e)
    • implement shorthand for options with multiple values (6669f0a9)
  • arg allow other types besides Vec for multiple value settings (BREAKING CHANGE 0cc2f698, closes #87)
  • usage implement smart usage strings on errors (d77048ef, closes #88)

v0.6.9 (2015-04-29)

Bug Fixes

  • from_usage removes bug where usage strings have no help text (ad4e5451, closes #83)

0.6.8 (2015-04-27)

Bug Fixes

  • help change long help --long=long -> --long (1e25abfc)
  • RequiredArgs required by default args should no longer be required when their exclusions are present (4bb4c3cc)

Features

  • ArgGroups add ability to create arg groups (09eb4d98)

v0.6.7 (2015-04-22)

Bug Fixes

  • from_usage fix bug causing args to not be required (b76129e9)

Features

  • apps add ability to display additional help info after auto-gen'ed help msg (65cc259e)

v0.6.6 (2015-04-19)

Bug Fixes

  • from_usage tabs and spaces should be treated equally (4fd44181)

Features

  • macros.rs add macro to get version from Cargo.toml (c630969a)

v0.6.5 (2015-04-19)

Bug Fixes

  • macros.rs fix use statements for trait impls (86e4075e)

v0.6.4 (2015-04-17)

Features

  • macros add ability to create enums pub or priv with derives (2c499f80)

v0.6.3 (2015-04-16)

Features

  • macros add macro to create custom enums to use as types (fb672aff)

v0.6.2 (2015-04-14)

Features

  • macros
    • add ability to get multiple typed values or exit (0b87251f)
    • add ability to get a typed multiple values (e243fe38)
    • add convenience macro to get a typed value or exit (4b7cd3ea)
    • add convenience macro to get a typed value (8752700f)

v0.6.1 (2015-04-13)

Bug Fixes

  • from_usage trim all whitespace before parsing (91d29045)

v0.6.0 (2015-04-13)

Bug Fixes

  • tests fix failing doc tests (3710cd69)

Features

  • app add support for building args from usage strings (d5d48bcf)
  • args add ability to create basic arguments from a usage string (ab409a8f)

v0.5.14 (2015-04-10)

Bug Fixes

  • usage
    • remove unneeded space (51372789)
    • remove warning about unused variables (ba817b9d)

Features

  • usage add ability to get usage string for subcommands too (3636afc4)

v0.5.13 (2015-04-09)

Features

  • SubCommands add method to get name and subcommand matches together (64e53928)
  • ArgMatches add method to get default usage string (02462150)

v0.5.12 (2015-04-08)

Features

  • help sort arguments by name so as to not display a random order (f4b2bf57)

v0.5.11 (2015-04-08)

Bug Fixes

  • flags fix bug not allowing users to specify -v or -h (90e72cff)

v0.5.10 (2015-04-08)

Bug Fixes

  • help fix spacing when option argument has not long version (ca17fa49)

v0.5.9 (2015-04-08)

Bug Fixes

  • positional args all previous positional args become required when a latter one is required (c14c3f31, closes #50)
  • clap remove unstable features for Rust 1.0 (9abdb438)
  • args improve error messages for arguments with mutual exclusions (18dbcf37, closes #51)

v0.5.8 (2015-04-08)

Bug Fixes

  • option args fix bug in getting the wrong number of occurrences for options (82ad6ad7)
  • help fix formatting for option arguments with no long (e8691004)
  • flags add assertion to catch flags with specific value sets (a0a2a40f, closes #52)
  • args improve error messages for arguments with mutual exclusions (bff945fc, closes #51)
  • tests add missing .takes_value(true) to option2 (bdb0e88f)
  • positional args all previous positional args become required when a latter one is required (343d47dc, closes #50)

v0.5.7 (2015-04-08)

Bug Fixes

  • args fix bug in arguments who are required and mutually exclusive (6ceb88a5)

v0.5.6 (2015-04-08)

Bug Fixes

  • help fix formatting of help and usage (28691b52)

v0.5.5 (2015-04-08)

Bug Fixes

  • help fix formatting of help for flags and options (6ec10115)

v0.5.4 (2015-04-08)

Features

  • help add '...' to indicate multiple values supported (297ddba7)

v0.5.3 (2015-04-08)

Features

  • positionals
    • add assertions for positional args with multiple vals (b7fa72d4)
    • add support for multiple values (80784009)

v0.5.2 (2015-04-08)

Bug Fixes

  • apps allow use of hyphens in application and subcommand names (da549dcb)

v0.5.1 (2015-04-08)

Bug Fixes

  • args determine if the only arguments allowed are also required (0a09eb36)

v0.5.0 (2015-04-08)

Features

  • args add support for a specific set of allowed values on options or positional arguments (270eb889)

v0.4.18 (2015-04-08)

Bug Fixes

  • usage display required args in usage, even if only required by others (1b7316d4)

Features

  • subcommands properly list subcommands in help and usage (4ee02344)

v0.4.17 (2015-04-08)

Bug Fixes

  • tests remove cargo test from claptests makefile (1cf73817)

v0.4.16 (2015-04-08)

Bug Fixes

  • option fix bug with option occurrence values (9af52e93)
  • tests fix testing script bug and formatting (d8f03a55)

Features

  • arg allow lifetimes other than 'static in arguments (9e8c1fb9)