Struct CommandBuilder 

pub struct CommandBuilder { /* private fields */ }

Builder for creating Command instances.

Use Command::new to create a builder, then chain methods to configure the command, and finally call build to create the command.

Implementations

impl CommandBuilder

pub fn new(name: &str) -> Self

Create a new command builder with the given name.

pub fn callback<F>(self, f: F) -> Self

where F: Fn(&Context) -> Result<(), ClickError> + Send + Sync + 'static,

Set the callback function for this command.

The callback receives a reference to the Context and should return Ok(()) on success or a ClickError on failure.

pub fn option(self, opt: ClickOption) -> Self

Add an option to this command.

pub fn argument(self, arg: Argument) -> Self

Add an argument to this command.

pub fn help(self, help: &str) -> Self

Set the help text for this command.

pub fn epilog(self, epilog: &str) -> Self

Set the epilog (text shown after help).

pub fn short_help(self, short_help: &str) -> Self

Set the short help text for command listings.

pub fn options_metavar(self, metavar: &str) -> Self

Set the options metavar (default: “[OPTIONS]”).

pub fn add_help_option(self, add: bool) -> Self

Set whether to add a –help option (default: true).

pub fn help_option(self, opt: ClickOption) -> Self

Override the automatically generated help option.

This lets you customize the help option names (e.g. -h, --help) and its help text while keeping it eager.

Setting a custom help option implicitly enables add_help_option.

pub fn no_args_is_help(self, value: bool) -> Self

Set whether to show help if no args provided (default: false).

pub fn hidden(self) -> Self

Hide this command from help output.

pub fn deprecated(self, message: &str) -> Self

Mark this command as deprecated.

Pass an empty string for a generic deprecation message, or a custom message for more details.

pub fn allow_extra_args(self, allow: bool) -> Self

Set whether extra arguments are allowed.

pub fn allow_interspersed_args(self, allow: bool) -> Self

Set whether interspersed arguments are allowed.

pub fn ignore_unknown_options(self, ignore: bool) -> Self

Set whether unknown options should be ignored.

pub fn build(self) -> Command

Build the command.