Supported Clap APIs

The following tables list the status of clap’s Command, Arg and ArgGroup APIs in claptrap.

Command

Setter	Supported	Notes
`args`	✅
`groups`	✅
`subcommands`	✅
`no_binary_name`	n/a	always set, not exposed in the spec
`ignore_errors`	✅
`args_override_self`	✅
`dont_delimit_trailing_values`	✅	added but not working
`color`	✅	added but not working
`styles`	✅
`term_width`	✅
`max_term_width`	✅
`disable_version_flag`	✅
`propagate_version`	✅
`next_line_help`	✅
`disable_help_flag`	✅
`disable_help_subcommand`	✅
`disable_colored_help`	✅	added but not working
`help_expected`	✅
`hide_possible_values`	✅
`infer_long_args`	✅
`infer_subcommands`	✅
`name`	✅
`bin_name`	✅
`display_name`	✅	added but not working
`author`	✅
`about`	✅
`long_about`	✅
`after_help`	✅
`after_long_help`	✅
`before_help`	✅
`before_long_help`	✅
`version`	✅
`long_version`	✅
`override_usage`	✅
`override_help`	✅
`help_template`	✅
`flatten_help`	✅
`next_help_heading`	✅	added but not working
`next_display_order`	✅
`arg_required_else_help`	✅
`allow_missing_positional`	✅
`short_flag`	✅
`long_flag`	✅
`alias`	✅
`short_flag_alias`	✅
`long_flag_alias`	✅
`aliases`	✅
`short_flag_aliases`	✅
`long_flag_aliases`	✅
`visible_alias`	✅
`visible_short_flag_alias`	✅
`visible_long_flag_alias`	✅
`visible_aliases`	✅
`visible_short_flag_aliases`	✅
`visible_long_flag_aliases`	✅
`display_order`	✅
`hide`	✅
`subcommand_required`	✅
`allow_external_subcommands`	✅
`external_subcommand_value_parser`	✅
`args_conflicts_with_subcommands`	✅	added but not working
`subcommand_precedence_over_arg`	✅
`subcommand_negates_reqs`	✅	not tested
`multicall`	✅	not tested
`subcommand_value_name`	✅
`subcommand_help_heading`	✅

Arg

Setter	Supported	Notes
`id`	✅
`short`	✅
`long`	✅
`alias`	✅
`short_alias`	✅
`aliases`	✅
`short_aliases`	✅
`visible_alias`	✅
`visible_short_alias`	✅
`visible_aliases`	✅
`visible_short_aliases`	✅
`index`	✅
`trailing_var_arg`	✅
`last`	✅
`required`	✅
`requires`	✅
`exclusive`	✅
`global`	✅	not tested
`action`	✅
`value_parser`	✅
`num_args`	✅	integer or range syntax string
`value_name`	✅
`value_names`	✅
`value_hint`	✅
`ignore_case`	✅
`allow_hyphen_values`	✅
`allow_negative_numbers`	✅
`require_equals`	✅
`value_delimiter`	✅
`value_terminator`	✅
`raw`	✅
`default_value`	✅
`default_values`	✅
`default_missing_value`	✅
`default_missing_value_os`	✅
`default_missing_values`	✅
`default_missing_values_os`	✅
`env`	✅
`help`	✅
`long_help`	✅
`display_order`	✅
`help_heading`	✅
`next_line_help`	✅
`hide`	✅
`hide_possible_values`	✅
`hide_default_value`	✅
`hide_env`	✅
`hide_env_values`	✅
`hide_short_help`	✅
`hide_long_help`	✅
`group`	✅
`groups`	✅
`default_value_if`	✅
`default_value_ifs`	✅
`required_unless_present`	✅
`required_unless_present_all`	✅
`required_unless_present_any`	✅
`required_if_eq`	✅
`required_if_eq_any`	✅
`required_if_eq_all`	✅
`requires_if`	✅
`requires_ifs`	✅
`conflicts_with`	✅
`conflicts_with_all`	✅
`overrides_with`	✅
`overrides_with_all`	✅

Typed Value Parser

Parser	Supported	Notes
`bool`	✅	:e.g. `:bool:`
`boolish`	✅	e.g. `:boolish:`
`falsey`	✅	e.g. `:falsey:`

ArgGroup

Setter	Supported	Notes
`id`	✅
`args`	✅
`multiple`	✅
`required`	✅
`requires`	✅
`requires_all`	✅
`conflicts_with`	✅
`conflicts_with_all`	✅