List of all items

Structs

• argument::Argument
• argument::ArgumentBuilder
• command::Command
• command::CommandBuilder
• completion::BashComplete
• completion::CompletionArgs
• completion::CompletionOption
• completion::FishComplete
• completion::ZshComplete
• context::Context
• context::ContextBuilder
• decorators::PassDecorator
• error::ErrorContext
• formatting::HelpFormatter
• group::CommandCollection
• group::CommandCollectionBuilder
• group::Group
• group::GroupBuilder
• option::ClickOption
• option::OptionBuilder
• parameter::DeprecationInfo
• parameter::ParameterConfig
• parser::OptionParser
• termui::ProgressBar
• termui::ProgressBarIter
• testing::CliRunner
• testing::EchoingStdin
• testing::InvokeResult
• testing::IsolatedFilesystem
• types::BoolType
• types::Choice
• types::CompletionItem
• types::DateTimeType
• types::FileType
• types::FloatRange
• types::FloatType
• types::IntRange
• types::IntType
• types::LazyFile
• types::PathType
• types::StringType
• types::TupleType
• types::UnprocessedType
• types::UuidType

Enums

• ParameterSource
• error::ClickError
• error::ParamType
• parameter::Nargs
• parser::OptionAction
• parser::ParsedValue
• termui::Color
• types::FileMode
• types::TupleValue

Traits

• argument::AnyTypeConverter
• completion::ShellComplete
• group::CommandLike
• parameter::Parameter
• types::TypeConverter

Macros

• assert_failure
• assert_output_contains
• assert_success
• echo

Attribute Macros

• command
• group

Derive Macros

• Command
• Group

Functions

• complete::directories
• complete::env_vars
• complete::items
• complete::items_with_help
• completion::detect_shell
• completion::get_completion_class
• completion::get_completions
• completion::list_shells
• completion::make_completion_option
• completion::shell_complete
• context::get_current_context
• context::pop_context
• context::push_context
• decorators::make_pass_decorator
• formatting::detect_terminal_width
• formatting::get_terminal_width
• formatting::make_rule
• formatting::split_into_lines
• formatting::truncate_text
• formatting::wrap_text
• option::parse_option_name
• option::split_option_names
• parser::split_opt
• run
• run_with_completion
• termui::clear
• termui::confirm
• termui::echo
• termui::echo_via_pager
• termui::edit_text
• termui::get_terminal_size
• termui::getchar
• termui::isatty
• termui::launch
• termui::pause
• termui::progressbar
• termui::prompt
• termui::secho
• termui::stderr_isatty
• termui::stdin_isatty
• termui::stdout_isatty
• termui::strip_ansi_codes
• termui::style
• testing::make_test_context
• try_run
• utils::expand_args
• utils::expand_path
• utils::format_filename
• utils::get_app_dir
• utils::get_binary_stdin
• utils::get_binary_stdout
• utils::get_extension
• utils::get_os_args
• utils::get_os_args_skip_program
• utils::get_terminal_width
• utils::get_text_stderr
• utils::get_text_stdout
• utils::home_dir
• utils::is_tty
• utils::join_with_conjunction
• utils::make_safe_filename
• utils::pluralize
• utils::safecall
• utils::should_strip_ansi
• utils::split_arg_string
• utils::strip_extension

Type Aliases

• argument::ShellCompleteCallback
• command::CommandCallback
• context::BoxedValue
• context::HelpRenderer
• error::Result
• group::ResultCallback
• option::ShellCompleteCallback
• parameter::ParameterCallback
• parser::ParseResult
• types::BoxedTypeConverter

Constants

• parser::NARGS_OPTIONAL
• termui::BLACK
• termui::BLUE
• termui::BRIGHT_BLACK
• termui::BRIGHT_BLUE
• termui::BRIGHT_CYAN
• termui::BRIGHT_GREEN
• termui::BRIGHT_MAGENTA
• termui::BRIGHT_RED
• termui::BRIGHT_WHITE
• termui::BRIGHT_YELLOW
• termui::CYAN
• termui::GREEN
• termui::MAGENTA
• termui::RED
• termui::RESET
• termui::WHITE
• termui::YELLOW
• types::BOOL
• types::FLOAT
• types::INT
• types::STRING
• types::UNPROCESSED
• types::UUID