Skip to content
🚧 🚧 🚧 Under construction 🚧 🚧 🚧

Clap API Reference

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

SetterSupportedNotes
argsβœ…
groupsβœ…
subcommandsβœ…
no_binary_nameβœ…
ignore_errorsβœ…
args_override_selfβœ…
dont_delimit_trailing_valuesβœ…
colorβœ…
stylesβœ…
term_widthβœ…
max_term_widthβœ…
disable_version_flagβœ…
propagate_versionβœ…
next_line_helpβœ…
disable_help_flagβœ…
disable_help_subcommandβœ…
disable_colored_helpβœ…
help_expectedβœ…
hide_possible_valuesβœ…
infer_long_argsβœ…
infer_subcommandsβœ…
nameβœ…
bin_nameβœ…
display_nameβœ…
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βœ…
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βœ…
subcommand_precedence_over_argβœ…
subcommand_negates_reqsβœ…
multicallβœ…
subcommand_value_nameβœ…
subcommand_help_headingβœ…
SetterSupportedNotes
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βœ…
actionβœ…
value_parserβœ…
num_argsβœ…
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βœ…
ParserSupportedNotes
boolβœ…:e.g. :bool:
boolishβœ…e.g. :boolish:
falseyβœ…e.g. :falsey:
SetterSupportedNotes
idβœ…
argsβœ…
multipleβœ…
requiredβœ…
requiresβœ…
requires_allβœ…
conflicts_withβœ…
conflicts_with_allβœ…
SetterSupportedNotes
headerβœ…
errorβœ…
usageβœ…
literalβœ…
placeholderβœ…
validβœ…
invalidβœ…
contextβœ…since Clap 4.5.41
context_valueβœ…since Clap 4.5.41