Skip to content
Claptrap
Search
Ctrl
K
Cancel
github
x.com
Select version
Latest
0.1.0
0.2.0
0.3.0
Select theme
Dark
Light
Auto
Start Here
Getting Started
Installation
Guides
Using Claptrap
Reference
Reference Overview
CLI Reference
API Reference
Shell Reference
API Reference
Command
Arg
ArgGroup
ValueParser
PossibleValue
Command
about
after_help
after_long_help
alias
aliases
allow_external_subcommands
allow_missing_positional
arg_required_else_help
args
args_conflicts_with_subcommands
args_override_self
author
before_help
before_long_help
bin_name
color
disable_colored_help
disable_help_flag
disable_help_subcommand
disable_version_flag
display_name
display_order
dont_delimit_trailing_values
external_subcommand_value_parser
flatten_help
groups
help_expected
help_template
hide
hide_possible_values
ignore_errors
infer_long_args
infer_subcommands
long_about
long_flag
long_flag_alias
long_flag_aliases
long_version
max_term_width
multicall
name
next_display_order
next_help_heading
next_line_help
no_binary_name
override_help
override_usage
propagate_version
short_flag
short_flag_alias
short_flag_aliases
styles
subcommand_help_heading
subcommand_negates_reqs
subcommand_precedence_over_arg
subcommand_required
subcommand_value_name
subcommands
term_width
version
visible_alias
visible_aliases
visible_long_flag_alias
visible_long_flag_aliases
visible_short_flag_alias
visible_short_flag_aliases
Arg
action
alias
aliases
allow_hyphen_values
allow_negative_numbers
index
conflicts_with
conflicts_with_all
default_missing_value
default_missing_value_os
default_missing_values
default_missing_values_os
default_value
default_value_if
default_value_ifs
default_values
display_order
env
exclusive
global
group
groups
help
help_heading
hide
hide_default_value
hide_env
hide_env_values
hide_long_help
hide_possible_values
hide_short_help
id
ignore_case
last
long
long_help
next_line_help
num_args
overrides_with
overrides_with_all
raw
require_equals
required
required_if_eq
required_if_eq_all
required_if_eq_any
required_unless_present
required_unless_present_all
required_unless_present_any
requires
requires_if
requires_ifs
short
short_alias
short_aliases
trailing_var_arg
value_delimiter
value_hint
value_name
value_names
value_parser
value_terminator
visible_alias
visible_aliases
visible_short_alias
visible_short_aliases
ArgGroup
args
conflicts_with
conflicts_with_all
id
multiple
required
requires
requires_all
ValueParser
bool
boolish
f32
f64
falsey
i128
i16
i32
i64
i8
isize
string
u128
u16
u32
u64
u8
usize
PossibleValue
alias
aliases
help
hide
github
x.com
Select version
Latest
0.1.0
0.2.0
0.3.0
Select theme
Dark
Light
Auto
PossibleValue
API
Description
alias
Sets a hidden alias for this argument value.
aliases
Sets multiple hidden aliases for this argument value.
help
Sets the help description of the value.
hide
Hides this value from help and shell completions.