logo

Struct clap::builder::App

source · [−]
pub struct App<'help> { /* private fields */ }
Expand description

Deprecated, replaced with Command

Implementations

Basic API

Creates a new instance of an Command.

It is common, but not required, to use binary name as the name. This name will only be displayed to the user when they request to print version or help and usage information.

See also command! and crate_name!.

Examples
Command::new("My Program")

Adds an argument to the list of valid possibilities.

Examples
Command::new("myprog")
    // Adding a single "flag" argument with a short and help text, using Arg::new()
    .arg(
        Arg::new("debug")
           .short('d')
           .help("turns on debugging mode")
    )
    // Adding a single "option" argument with a short, a long, and help text using the less
    // verbose Arg::from()
    .arg(
        arg!(-c --config <CONFIG> "Optionally sets a config file to use")
    )

Adds multiple arguments to the list of valid possibilities.

Examples
Command::new("myprog")
    .args(&[
        arg!("[debug] -d 'turns on debugging info'"),
        Arg::new("input").help("the input file to use")
    ])

Allows one to mutate an Arg after it’s been added to a Command.

This can be useful for modifying the auto-generated help or version arguments.

Examples

let mut cmd = Command::new("foo")
    .arg(Arg::new("bar")
        .short('b'))
    .mut_arg("bar", |a| a.short('B'));

let res = cmd.try_get_matches_from_mut(vec!["foo", "-b"]);

// Since we changed `bar`'s short to "B" this should err as there
// is no `-b` anymore, only `-B`

assert!(res.is_err());

let res = cmd.try_get_matches_from_mut(vec!["foo", "-B"]);
assert!(res.is_ok());

Allows one to mutate a Command after it’s been added as a subcommand.

This can be useful for modifying auto-generated arguments of nested subcommands with Command::mut_arg.

Examples

let mut cmd = Command::new("foo")
        .subcommand(Command::new("bar"))
        .mut_subcommand("bar", |subcmd| subcmd.disable_help_flag(true));

let res = cmd.try_get_matches_from_mut(vec!["foo", "bar", "--help"]);

// Since we disabled the help flag on the "bar" subcommand, this should err.

assert!(res.is_err());

let res = cmd.try_get_matches_from_mut(vec!["foo", "bar"]);
assert!(res.is_ok());

Adds an ArgGroup to the application.

ArgGroups are a family of related arguments. By placing them in a logical group, you can build easier requirement and exclusion rules.

Example use cases:

  • Make an entire ArgGroup required, meaning that one (and only one) argument from that group must be present at runtime.
  • Name an ArgGroup as a conflict to another argument. Meaning any of the arguments that belong to that group will cause a failure if present with the conflicting argument.
  • Ensure exclusion between arguments.
  • Extract a value from a group instead of determining exactly which argument was used.
Examples

The following example demonstrates using an ArgGroup to ensure that one, and only one, of the arguments from the specified group is present at runtime.

Command::new("cmd")
    .arg(arg!("--set-ver [ver] 'set the version manually'"))
    .arg(arg!("--major 'auto increase major'"))
    .arg(arg!("--minor 'auto increase minor'"))
    .arg(arg!("--patch 'auto increase patch'"))
    .group(ArgGroup::new("vers")
         .args(&["set-ver", "major", "minor","patch"])
         .required(true))

Adds multiple ArgGroups to the Command at once.

Examples
Command::new("cmd")
    .arg(arg!("--set-ver [ver] 'set the version manually'"))
    .arg(arg!("--major         'auto increase major'"))
    .arg(arg!("--minor         'auto increase minor'"))
    .arg(arg!("--patch         'auto increase patch'"))
    .arg(arg!("-c [FILE]       'a config file'"))
    .arg(arg!("-i [IFACE]      'an interface'"))
    .groups(&[
        ArgGroup::new("vers")
            .args(&["set-ver", "major", "minor","patch"])
            .required(true),
        ArgGroup::new("input")
            .args(&["c", "i"])
    ])

Adds a subcommand to the list of valid possibilities.

Subcommands are effectively sub-Commands, because they can contain their own arguments, subcommands, version, usage, etc. They also function just like Commands, in that they get their own auto generated help, version, and usage.

A subcommand’s Command::name will be used for:

  • The argument the user passes in
  • Programmatically looking up the subcommand
Examples
Command::new("myprog")
    .subcommand(Command::new("config")
        .about("Controls configuration features")
        .arg(arg!("<config> 'Required configuration file to use'")))

Adds multiple subcommands to the list of valid possibilities.

Examples
.subcommands( vec![
       Command::new("config").about("Controls configuration functionality")
                                .arg(Arg::new("config_file")),
       Command::new("debug").about("Controls debug functionality")])

Catch problems earlier in the development cycle.

Most error states are handled as asserts under the assumption they are programming mistake and not something to handle at runtime. Rather than relying on tests (manual or automated) that exhaustively test your CLI to ensure the asserts are evaluated, this will run those asserts in a way convenient for running as a test.

Note:: This will not help with asserts in ArgMatches, those will need exhaustive testing of your CLI.

Examples
fn cmd() -> Command<'static> {
    Command::new("foo")
        .arg(
            Arg::new("bar").short('b').action(ArgAction::SetTrue)
        )
}

#[test]
fn verify_app() {
    cmd().debug_assert();
}

fn main() {
    let m = cmd().get_matches_from(vec!["foo", "-b"]);
    println!("{}", *m.get_one::<bool>("bar").expect("defaulted by clap"));
}

Custom error message for post-parsing validation

Examples
let mut cmd = Command::new("myprog");
let err = cmd.error(ErrorKind::InvalidValue, "Some failure case");

Parse env::args_os, exiting on failure.

Panics

If contradictory arguments or settings exist.

Examples
let matches = Command::new("myprog")
    // Args and options go here...
    .get_matches();

Parse env::args_os, exiting on failure.

Like App::get_matches but doesn’t consume the Command.

Panics

If contradictory arguments or settings exist.

Examples
let mut cmd = Command::new("myprog")
    // Args and options go here...
    ;
let matches = cmd.get_matches_mut();

Parse env::args_os, returning a clap::Result on failure.

NOTE: This method WILL NOT exit when --help or --version (or short versions) are used. It will return a clap::Error, where the kind is a ErrorKind::DisplayHelp or ErrorKind::DisplayVersion respectively. You must call Error::exit or perform a std::process::exit.

Panics

If contradictory arguments or settings exist.

Examples
let matches = Command::new("myprog")
    // Args and options go here...
    .try_get_matches()
    .unwrap_or_else(|e| e.exit());

Parse the specified arguments, exiting on failure.

NOTE: The first argument will be parsed as the binary name unless Command::no_binary_name is used.

Panics

If contradictory arguments or settings exist.

Examples
let arg_vec = vec!["my_prog", "some", "args", "to", "parse"];

let matches = Command::new("myprog")
    // Args and options go here...
    .get_matches_from(arg_vec);

Parse the specified arguments, returning a clap::Result on failure.

NOTE: This method WILL NOT exit when --help or --version (or short versions) are used. It will return a clap::Error, where the kind is a ErrorKind::DisplayHelp or ErrorKind::DisplayVersion respectively. You must call Error::exit or perform a std::process::exit yourself.

NOTE: The first argument will be parsed as the binary name unless Command::no_binary_name is used.

Panics

If contradictory arguments or settings exist.

Examples
let arg_vec = vec!["my_prog", "some", "args", "to", "parse"];

let matches = Command::new("myprog")
    // Args and options go here...
    .try_get_matches_from(arg_vec)
    .unwrap_or_else(|e| e.exit());

Parse the specified arguments, returning a clap::Result on failure.

Like App::try_get_matches_from but doesn’t consume the Command.

NOTE: This method WILL NOT exit when --help or --version (or short versions) are used. It will return a clap::Error, where the kind is a ErrorKind::DisplayHelp or ErrorKind::DisplayVersion respectively. You must call Error::exit or perform a std::process::exit yourself.

NOTE: The first argument will be parsed as the binary name unless Command::no_binary_name is used.

Panics

If contradictory arguments or settings exist.

Examples
let arg_vec = vec!["my_prog", "some", "args", "to", "parse"];

let mut cmd = Command::new("myprog");
    // Args and options go here...
let matches = cmd.try_get_matches_from_mut(arg_vec)
    .unwrap_or_else(|e| e.exit());

Prints the short help message (-h) to io::stdout().

See also Command::print_long_help.

Examples
let mut cmd = Command::new("myprog");
cmd.print_help();

Prints the long help message (--help) to io::stdout().

See also Command::print_help.

Examples
let mut cmd = Command::new("myprog");
cmd.print_long_help();

Writes the short help message (-h) to a io::Write object.

See also Command::write_long_help.

Examples
use std::io;
let mut cmd = Command::new("myprog");
let mut out = io::stdout();
cmd.write_help(&mut out).expect("failed to write to stdout");

Writes the long help message (--help) to a io::Write object.

See also Command::write_help.

Examples
use std::io;
let mut cmd = Command::new("myprog");
let mut out = io::stdout();
cmd.write_long_help(&mut out).expect("failed to write to stdout");

Version message rendered as if the user ran -V.

See also Command::render_long_version.

Coloring

This function does not try to color the message nor it inserts any ANSI escape codes.

Examples
use std::io;
let cmd = Command::new("myprog");
println!("{}", cmd.render_version());

Version message rendered as if the user ran --version.

See also Command::render_version.

Coloring

This function does not try to color the message nor it inserts any ANSI escape codes.

Examples
use std::io;
let cmd = Command::new("myprog");
println!("{}", cmd.render_long_version());

Usage statement

Examples
use std::io;
let mut cmd = Command::new("myprog");
println!("{}", cmd.render_usage());

Application-wide Settings

These settings will apply to the top-level command and all subcommands, by default. Some settings can be overridden in subcommands.

Specifies that the parser should not assume the first argument passed is the binary name.

This is normally the case when using a “daemon” style mode. For shells / REPLs, see Command::multicall.

Examples
let m = Command::new("myprog")
    .no_binary_name(true)
    .arg(arg!(<cmd> ... "commands to run"))
    .get_matches_from(vec!["command", "set"]);

let cmds: Vec<&str> = m.values_of("cmd").unwrap().collect();
assert_eq!(cmds, ["command", "set"]);

Try not to fail on parse errors, like missing option values.

Note: Make sure you apply it as global_setting if you want this setting to be propagated to subcommands and sub-subcommands!

NOTE: This choice is propagated to all child subcommands.

Examples
let cmd = Command::new("cmd")
  .ignore_errors(true)
  .arg(arg!(-c --config <FILE> "Sets a custom config file").required(false))
  .arg(arg!(-x --stuff <FILE> "Sets a custom stuff file").required(false))
  .arg(arg!(f: -f "Flag"));

let r = cmd.try_get_matches_from(vec!["cmd", "-c", "file", "-f", "-x"]);

assert!(r.is_ok(), "unexpected error: {:?}", r);
let m = r.unwrap();
assert_eq!(m.value_of("config"), Some("file"));
assert!(m.is_present("f"));
assert_eq!(m.value_of("stuff"), None);

Deprecated, replaced with ArgAction::Set

Disables the automatic delimiting of values after -- or when Command::trailing_var_arg was used.

NOTE: The same thing can be done manually by setting the final positional argument to Arg::use_value_delimiter(false). Using this setting is safer, because it’s easier to locate when making changes.

NOTE: This choice is propagated to all child subcommands.

Examples
Command::new("myprog")
    .dont_delimit_trailing_values(true)
    .get_matches();

Sets when to color output.

NOTE: This choice is propagated to all child subcommands.

NOTE: Default behaviour is ColorChoice::Auto.

Examples
Command::new("myprog")
    .color(ColorChoice::Never)
    .get_matches();

Sets the terminal width at which to wrap help messages.

Using 0 will ignore terminal widths and use source formatting.

Defaults to current terminal width when wrap_help feature flag is enabled. If the flag is disabled or it cannot be determined, the default is 100.

NOTE: This setting applies globally and not on a per-command basis.

Examples
Command::new("myprog")
    .term_width(80)

Sets the maximum terminal width at which to wrap help messages.

This only applies when setting the current terminal width. See Command::term_width for more details.

Using 0 will ignore terminal widths and use source formatting.

NOTE: This setting applies globally and not on a per-command basis.

Examples
Command::new("myprog")
    .max_term_width(100)

Disables -V and --version flag.

Examples
let res = Command::new("myprog")
    .disable_version_flag(true)
    .try_get_matches_from(vec![
        "myprog", "-V"
    ]);
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), ErrorKind::UnknownArgument);

Specifies to use the version of the current command for all subcommands.

Defaults to false; subcommands have independent version strings from their parents.

Note: Make sure you apply it as global_setting if you want this setting to be propagated to subcommands and sub-subcommands!

NOTE: This choice is propagated to all child subcommands.

Examples
Command::new("myprog")
    .version("v1.1")
    .propagate_version(true)
    .subcommand(Command::new("test"))
    .get_matches();
// running `$ myprog test --version` will display
// "myprog-test v1.1"

Places the help string for all arguments and subcommands on the line after them.

NOTE: This choice is propagated to all child subcommands.

Examples
Command::new("myprog")
    .next_line_help(true)
    .get_matches();

Disables -h and --help flag.

NOTE: This choice is propagated to all child subcommands.

Examples
let res = Command::new("myprog")
    .disable_help_flag(true)
    .try_get_matches_from(vec![
        "myprog", "-h"
    ]);
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), ErrorKind::UnknownArgument);

Disables the help subcommand.

Examples
let res = Command::new("myprog")
    .disable_help_subcommand(true)
    // Normally, creating a subcommand causes a `help` subcommand to automatically
    // be generated as well
    .subcommand(Command::new("test"))
    .try_get_matches_from(vec![
        "myprog", "help"
    ]);
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), ErrorKind::UnknownArgument);

Disables colorized help messages.

NOTE: This choice is propagated to all child subcommands.

Examples
Command::new("myprog")
    .disable_colored_help(true)
    .get_matches();

Panic if help descriptions are omitted.

NOTE: When deriving Parser, you could instead check this at compile-time with #![deny(missing_docs)]

NOTE: This choice is propagated to all child subcommands.

Examples
Command::new("myprog")
    .help_expected(true)
    .arg(
        Arg::new("foo").help("It does foo stuff")
        // As required via `help_expected`, a help message was supplied
     )
Panics
Command::new("myapp")
    .help_expected(true)
    .arg(
        Arg::new("foo")
        // Someone forgot to put .about("...") here
        // Since the setting `help_expected` is activated, this will lead to
        // a panic (if you are in debug mode)
    )

Disables the automatic collapsing of positional args into [ARGS] inside the usage string.

NOTE: This choice is propagated to all child subcommands.

Examples
Command::new("myprog")
    .dont_collapse_args_in_usage(true)
    .get_matches();

Tells clap not to print possible values when displaying help information.

This can be useful if there are many values, or they are explained elsewhere.

To set this per argument, see Arg::hide_possible_values.

NOTE: This choice is propagated to all child subcommands.

Allow partial matches of long arguments or their aliases.

For example, to match an argument named --test, one could use --t, --te, --tes, and --test.

NOTE: The match must not be ambiguous at all in order to succeed. i.e. to match --te to --test there could not also be another argument or alias --temp because both start with --te

NOTE: This choice is propagated to all child subcommands.

Allow partial matches of subcommand names and their aliases.

For example, to match a subcommand named test, one could use t, te, tes, and test.

NOTE: The match must not be ambiguous at all in order to succeed. i.e. to match te to test there could not also be a subcommand or alias temp because both start with te

CAUTION: This setting can interfere with positional/free arguments, take care when designing CLIs which allow inferred subcommands and have potential positional/free arguments whose values could start with the same characters as subcommands. If this is the case, it’s recommended to use settings such as Command::args_conflicts_with_subcommands in conjunction with this setting.

NOTE: This choice is propagated to all child subcommands.

Examples
let m = Command::new("prog")
    .infer_subcommands(true)
    .subcommand(Command::new("test"))
    .get_matches_from(vec![
        "prog", "te"
    ]);
assert_eq!(m.subcommand_name(), Some("test"));

Command-specific Settings

These apply only to the current command and are not inherited by subcommands.

(Re)Sets the program’s name.

See Command::new for more details.

Examples
ⓘ
let yaml = load_yaml!("cmd.yaml");
let cmd = Command::from(yaml)
    .name(crate_name!());

// continued logic goes here, such as `cmd.get_matches()` etc.

Overrides the runtime-determined name of the binary for help and error messages.

This should only be used when absolutely necessary, such as when the binary name for your application is misleading, or perhaps not how the user should invoke your program.

Pro-tip: When building things such as third party cargo subcommands, this setting should be used!

NOTE: This does not change or set the name of the binary file on disk. It only changes what clap thinks the name is for the purposes of error or help messages.

Examples
Command::new("My Program")
     .bin_name("my_binary")

Overrides the runtime-determined display name of the program for help and error messages.

Examples
Command::new("My Program")
     .display_name("my_program")

Sets the author(s) for the help message.

Pro-tip: Use claps convenience macro crate_authors! to automatically set your application’s author(s) to the same thing as your crate at compile time.

Examples
Command::new("myprog")
     .author("Me, me@mymain.com")

Sets the program’s description for the short help (-h).

If Command::long_about is not specified, this message will be displayed for --help.

NOTE: Only Command::about (short format) is used in completion script generation in order to be concise.

See also crate_description!.

Examples
Command::new("myprog")
    .about("Does really amazing things for great people")

Sets the program’s description for the long help (--help).

If Command::about is not specified, this message will be displayed for -h.

NOTE: Only Command::about (short format) is used in completion script generation in order to be concise.

Examples
Command::new("myprog")
    .long_about(
"Does really amazing things to great people. Now let's talk a little
 more in depth about how this subcommand really works. It may take about
 a few lines of text, but that's ok!")

Free-form help text for after auto-generated short help (-h).

This is often used to describe how to use the arguments, caveats to be noted, or license and contact information.

If Command::after_long_help is not specified, this message will be displayed for --help.

Examples
Command::new("myprog")
    .after_help("Does really amazing things for great people... but be careful with -R!")

Free-form help text for after auto-generated long help (--help).

This is often used to describe how to use the arguments, caveats to be noted, or license and contact information.

If Command::after_help is not specified, this message will be displayed for -h.

Examples
Command::new("myprog")
    .after_long_help("Does really amazing things to great people... but be careful with -R, \
                     like, for real, be careful with this!")

Free-form help text for before auto-generated short help (-h).

This is often used for header, copyright, or license information.

If Command::before_long_help is not specified, this message will be displayed for --help.

Examples
Command::new("myprog")
    .before_help("Some info I'd like to appear before the help info")

Free-form help text for before auto-generated long help (--help).

This is often used for header, copyright, or license information.

If Command::before_help is not specified, this message will be displayed for -h.

Examples
Command::new("myprog")
    .before_long_help("Some verbose and long info I'd like to appear before the help info")

Sets the version for the short version (-V) and help messages.

If Command::long_version is not specified, this message will be displayed for --version.

Pro-tip: Use claps convenience macro crate_version! to automatically set your application’s version to the same thing as your crate at compile time.

Examples
Command::new("myprog")
    .version("v0.1.24")

Sets the version for the long version (--version) and help messages.

If Command::version is not specified, this message will be displayed for -V.

Pro-tip: Use claps convenience macro crate_version! to automatically set your application’s version to the same thing as your crate at compile time.

Examples
Command::new("myprog")
    .long_version(
"v0.1.24
 commit: abcdef89726d
 revision: 123
 release: 2
 binary: myprog")

Overrides the clap generated usage string for help and error messages.

NOTE: Using this setting disables claps “context-aware” usage strings. After this setting is set, this will be the only usage string displayed to the user!

NOTE: Multiple usage lines may be present in the usage argument, but some rules need to be followed to ensure the usage lines are formatted correctly by the default help formatter:

  • Do not indent the first usage line.
  • Indent all subsequent usage lines with four spaces.
  • The last line must not end with a newline.
Examples
Command::new("myprog")
    .override_usage("myapp [-clDas] <some_file>")

Or for multiple usage lines:

Command::new("myprog")
    .override_usage(
        "myapp -X [-a] [-b] <file>\n    \
         myapp -Y [-c] <file1> <file2>\n    \
         myapp -Z [-d|-e]"
    )

Overrides the clap generated help message (both -h and --help).

This should only be used when the auto-generated message does not suffice.

NOTE: This only replaces the help message for the current command, meaning if you are using subcommands, those help messages will still be auto-generated unless you specify a Command::override_help for them as well.

Examples
Command::new("myapp")
    .override_help("myapp v1.0\n\
           Does awesome things\n\
           (C) me@mail.com\n\n\

           USAGE: myapp <opts> <command>\n\n\

           Options:\n\
           -h, --help       Display this message\n\
           -V, --version    Display version info\n\
           -s <stuff>       Do something with stuff\n\
           -v               Be verbose\n\n\

           Commands:\n\
           help             Print this message\n\
           work             Do some work")

Sets the help template to be used, overriding the default format.

NOTE: The template system is by design very simple. Therefore, the tags have to be written in the lowercase and without spacing.

Tags are given inside curly brackets.

Valid tags are:

  • {name} - Display name for the (sub-)command.
  • {bin} - Binary name.
  • {version} - Version number.
  • {author} - Author information.
  • {author-with-newline} - Author followed by \n.
  • {author-section} - Author preceded and followed by \n.
  • {about} - General description (from Command::about or Command::long_about).
  • {about-with-newline} - About followed by \n.
  • {about-section} - About preceded and followed by ‘\n’.
  • {usage-heading} - Automatically generated usage heading.
  • {usage} - Automatically generated or given usage string.
  • {all-args} - Help for all arguments (options, flags, positional arguments, and subcommands) including titles.
  • {options} - Help for options.
  • {positionals} - Help for positional arguments.
  • {subcommands} - Help for subcommands.
  • {after-help} - Help from App::after_help or Command::after_long_help.
  • {before-help} - Help from App::before_help or Command::before_long_help.
Examples
Command::new("myprog")
    .version("1.0")
    .help_template("{bin} ({version}) - {usage}")

Apply a setting for the current command or subcommand.

See Command::global_setting to apply a setting to this command and all subcommands.

See AppSettings for a full list of possibilities and examples.

Examples
Command::new("myprog")
    .setting(AppSettings::SubcommandRequired)
    .setting(AppSettings::AllowLeadingHyphen)

or

Command::new("myprog")
    .setting(AppSettings::SubcommandRequired | AppSettings::AllowLeadingHyphen)

Remove a setting for the current command or subcommand.

See AppSettings for a full list of possibilities and examples.

Examples
Command::new("myprog")
    .unset_setting(AppSettings::SubcommandRequired)
    .setting(AppSettings::AllowLeadingHyphen)

or

Command::new("myprog")
    .unset_setting(AppSettings::SubcommandRequired | AppSettings::AllowLeadingHyphen)

Apply a setting for the current command and all subcommands.

See Command::setting to apply a setting only to this command.

See AppSettings for a full list of possibilities and examples.

Examples
Command::new("myprog")
    .global_setting(AppSettings::AllowNegativeNumbers)

Remove a setting and stop propagating down to subcommands.

See AppSettings for a full list of possibilities and examples.

Examples
Command::new("myprog")
    .unset_global_setting(AppSettings::AllowNegativeNumbers)

Deprecated, replaced with Command::next_help_heading

Set the default section heading for future args.

This will be used for any arg that hasn’t had Arg::help_heading called.

This is useful if the default OPTIONS or ARGS headings are not specific enough for one’s use case.

For subcommands, see Command::subcommand_help_heading

Change the starting value for assigning future display orders for ags.

This will be used for any arg that hasn’t had Arg::display_order called.

Exit gracefully if no arguments are present (e.g. $ myprog).

NOTE: subcommands count as arguments

Examples
Command::new("myprog")
    .arg_required_else_help(true);

Specifies that leading hyphens are allowed in all argument values (e.g. -10).

Otherwise they will be parsed as another flag or option. See also Command::allow_negative_numbers.

NOTE: Use this setting with caution as it silences certain circumstances which would otherwise be an error (such as accidentally forgetting to specify a value for leading option). It is preferred to set this on a per argument basis, via Arg::allow_hyphen_values.

Examples
// Imagine you needed to represent negative numbers as well, such as -10
let m = Command::new("nums")
    .allow_hyphen_values(true)
    .arg(Arg::new("neg"))
    .get_matches_from(vec![
        "nums", "-20"
    ]);

assert_eq!(m.value_of("neg"), Some("-20"));

Allows negative numbers to pass as values.

This is similar to Command::allow_hyphen_values except that it only allows numbers, all other undefined leading hyphens will fail to parse.

Examples
let res = Command::new("myprog")
    .allow_negative_numbers(true)
    .arg(Arg::new("num"))
    .try_get_matches_from(vec![
        "myprog", "-20"
    ]);
assert!(res.is_ok());
let m = res.unwrap();
assert_eq!(m.value_of("num").unwrap(), "-20");

Specifies that the final positional argument is a “VarArg” and that clap should not attempt to parse any further args.

The values of the trailing positional argument will contain all args from itself on.

NOTE: The final positional argument must have Arg::multiple_values(true) or the usage string equivalent.

Examples
let m = Command::new("myprog")
    .trailing_var_arg(true)
    .arg(arg!(<cmd> ... "commands to run"))
    .get_matches_from(vec!["myprog", "arg1", "-r", "val1"]);

let trail: Vec<&str> = m.values_of("cmd").unwrap().collect();
assert_eq!(trail, ["arg1", "-r", "val1"]);

Allows one to implement two styles of CLIs where positionals can be used out of order.

The first example is a CLI where the second to last positional argument is optional, but the final positional argument is required. Such as $ prog [optional] <required> where one of the two following usages is allowed:

  • $ prog [optional] <required>
  • $ prog <required>

This would otherwise not be allowed. This is useful when [optional] has a default value.

Note: when using this style of “missing positionals” the final positional must be required if -- will not be used to skip to the final positional argument.

Note: This style also only allows a single positional argument to be “skipped” without the use of --. To skip more than one, see the second example.

The second example is when one wants to skip multiple optional positional arguments, and use of the -- operator is OK (but not required if all arguments will be specified anyways).

For example, imagine a CLI which has three positional arguments [foo] [bar] [baz]... where baz accepts multiple values (similar to man ARGS... style training arguments).

With this setting the following invocations are posisble:

  • $ prog foo bar baz1 baz2 baz3
  • $ prog foo -- baz1 baz2 baz3
  • $ prog -- baz1 baz2 baz3
Examples

Style number one from above:

// Assume there is an external subcommand named "subcmd"
let m = Command::new("myprog")
    .allow_missing_positional(true)
    .arg(Arg::new("arg1"))
    .arg(Arg::new("arg2")
        .required(true))
    .get_matches_from(vec![
        "prog", "other"
    ]);

assert_eq!(m.value_of("arg1"), None);
assert_eq!(m.value_of("arg2"), Some("other"));

Now the same example, but using a default value for the first optional positional argument

// Assume there is an external subcommand named "subcmd"
let m = Command::new("myprog")
    .allow_missing_positional(true)
    .arg(Arg::new("arg1")
        .default_value("something"))
    .arg(Arg::new("arg2")
        .required(true))
    .get_matches_from(vec![
        "prog", "other"
    ]);

assert_eq!(m.value_of("arg1"), Some("something"));
assert_eq!(m.value_of("arg2"), Some("other"));

Style number two from above:

// Assume there is an external subcommand named "subcmd"
let m = Command::new("myprog")
    .allow_missing_positional(true)
    .arg(Arg::new("foo"))
    .arg(Arg::new("bar"))
    .arg(Arg::new("baz").takes_value(true).multiple_values(true))
    .get_matches_from(vec![
        "prog", "foo", "bar", "baz1", "baz2", "baz3"
    ]);

assert_eq!(m.value_of("foo"), Some("foo"));
assert_eq!(m.value_of("bar"), Some("bar"));
assert_eq!(m.values_of("baz").unwrap().collect::<Vec<_>>(), &["baz1", "baz2", "baz3"]);

Now nofice if we don’t specify foo or baz but use the -- operator.

// Assume there is an external subcommand named "subcmd"
let m = Command::new("myprog")
    .allow_missing_positional(true)
    .arg(Arg::new("foo"))
    .arg(Arg::new("bar"))
    .arg(Arg::new("baz").takes_value(true).multiple_values(true))
    .get_matches_from(vec![
        "prog", "--", "baz1", "baz2", "baz3"
    ]);

assert_eq!(m.value_of("foo"), None);
assert_eq!(m.value_of("bar"), None);
assert_eq!(m.values_of("baz").unwrap().collect::<Vec<_>>(), &["baz1", "baz2", "baz3"]);

Subcommand-specific Settings

Sets the short version of the subcommand flag without the preceding -.

Allows the subcommand to be used as if it were an Arg::short.

Examples
let matches = Command::new("pacman")
    .subcommand(
        Command::new("sync").short_flag('S').arg(
            Arg::new("search")
                .short('s')
                .long("search")
                .action(ArgAction::SetTrue)
                .help("search remote repositories for matching strings"),
        ),
    )
    .get_matches_from(vec!["pacman", "-Ss"]);

assert_eq!(matches.subcommand_name().unwrap(), "sync");
let sync_matches = matches.subcommand_matches("sync").unwrap();
assert!(*sync_matches.get_one::<bool>("search").expect("defaulted by clap"));

Sets the long version of the subcommand flag without the preceding --.

Allows the subcommand to be used as if it were an Arg::long.

NOTE: Any leading - characters will be stripped.

Examples

To set long_flag use a word containing valid UTF-8 codepoints. If you supply a double leading -- such as --sync they will be stripped. Hyphens in the middle of the word; however, will not be stripped (i.e. sync-file is allowed).

let matches = Command::new("pacman")
    .subcommand(
        Command::new("sync").long_flag("sync").arg(
            Arg::new("search")
                .short('s')
                .long("search")
                .action(ArgAction::SetTrue)
                .help("search remote repositories for matching strings"),
        ),
    )
    .get_matches_from(vec!["pacman", "--sync", "--search"]);

assert_eq!(matches.subcommand_name().unwrap(), "sync");
let sync_matches = matches.subcommand_matches("sync").unwrap();
assert!(*sync_matches.get_one::<bool>("search").expect("defaulted by clap"));

Sets a hidden alias to this subcommand.

This allows the subcommand to be accessed via either the original name, or this given alias. This is more efficient and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all aliased variants.

NOTE: Aliases defined with this method are hidden from the help message. If you’re looking for aliases that will be displayed in the help message, see Command::visible_alias.

NOTE: When using aliases and checking for the existence of a particular subcommand within an ArgMatches struct, one only needs to search for the original name and not all aliases.

Examples
let m = Command::new("myprog")
    .subcommand(Command::new("test")
        .alias("do-stuff"))
    .get_matches_from(vec!["myprog", "do-stuff"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add an alias, which functions as “hidden” short flag subcommand

This will automatically dispatch as if this subcommand was used. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all variants.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").short_flag('t')
                .short_flag_alias('d'))
            .get_matches_from(vec!["myprog", "-d"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add an alias, which functions as a “hidden” long flag subcommand.

This will automatically dispatch as if this subcommand was used. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all variants.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").long_flag("test")
                .long_flag_alias("testing"))
            .get_matches_from(vec!["myprog", "--testing"]);
assert_eq!(m.subcommand_name(), Some("test"));

Sets multiple hidden aliases to this subcommand.

This allows the subcommand to be accessed via either the original name or any of the given aliases. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command and not all aliased variants.

NOTE: Aliases defined with this method are hidden from the help message. If looking for aliases that will be displayed in the help message, see Command::visible_aliases.

NOTE: When using aliases and checking for the existence of a particular subcommand within an ArgMatches struct, one only needs to search for the original name and not all aliases.

Examples
let m = Command::new("myprog")
    .subcommand(Command::new("test")
        .aliases(&["do-stuff", "do-tests", "tests"]))
        .arg(Arg::new("input")
            .help("the file to add")
            .required(false))
    .get_matches_from(vec!["myprog", "do-tests"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add aliases, which function as “hidden” short flag subcommands.

These will automatically dispatch as if this subcommand was used. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all variants.

Examples
let m = Command::new("myprog")
    .subcommand(Command::new("test").short_flag('t')
        .short_flag_aliases(&['a', 'b', 'c']))
        .arg(Arg::new("input")
            .help("the file to add")
            .required(false))
    .get_matches_from(vec!["myprog", "-a"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add aliases, which function as “hidden” long flag subcommands.

These will automatically dispatch as if this subcommand was used. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all variants.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").long_flag("test")
                .long_flag_aliases(&["testing", "testall", "test_all"]))
                .arg(Arg::new("input")
                            .help("the file to add")
                            .required(false))
            .get_matches_from(vec!["myprog", "--testing"]);
assert_eq!(m.subcommand_name(), Some("test"));

Sets a visible alias to this subcommand.

This allows the subcommand to be accessed via either the original name or the given alias. This is more efficient and easier than creating hidden subcommands as one only needs to check for the existence of this command and not all aliased variants.

NOTE: The alias defined with this method is visible from the help message and displayed as if it were just another regular subcommand. If looking for an alias that will not be displayed in the help message, see Command::alias.

NOTE: When using aliases and checking for the existence of a particular subcommand within an ArgMatches struct, one only needs to search for the original name and not all aliases.

Examples
let m = Command::new("myprog")
    .subcommand(Command::new("test")
        .visible_alias("do-stuff"))
    .get_matches_from(vec!["myprog", "do-stuff"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add an alias, which functions as “visible” short flag subcommand

This will automatically dispatch as if this subcommand was used. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all variants.

See also Command::short_flag_alias.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").short_flag('t')
                .visible_short_flag_alias('d'))
            .get_matches_from(vec!["myprog", "-d"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add an alias, which functions as a “visible” long flag subcommand.

This will automatically dispatch as if this subcommand was used. This is more efficient, and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command, and not all variants.

See also Command::long_flag_alias.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").long_flag("test")
                .visible_long_flag_alias("testing"))
            .get_matches_from(vec!["myprog", "--testing"]);
assert_eq!(m.subcommand_name(), Some("test"));

Sets multiple visible aliases to this subcommand.

This allows the subcommand to be accessed via either the original name or any of the given aliases. This is more efficient and easier than creating multiple hidden subcommands as one only needs to check for the existence of this command and not all aliased variants.

NOTE: The alias defined with this method is visible from the help message and displayed as if it were just another regular subcommand. If looking for an alias that will not be displayed in the help message, see Command::alias.

NOTE: When using aliases, and checking for the existence of a particular subcommand within an ArgMatches struct, one only needs to search for the original name and not all aliases.

Examples
let m = Command::new("myprog")
    .subcommand(Command::new("test")
        .visible_aliases(&["do-stuff", "tests"]))
    .get_matches_from(vec!["myprog", "do-stuff"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add aliases, which function as visible short flag subcommands.

See Command::short_flag_aliases.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").short_flag('b')
                .visible_short_flag_aliases(&['t']))
            .get_matches_from(vec!["myprog", "-t"]);
assert_eq!(m.subcommand_name(), Some("test"));

Add aliases, which function as visible long flag subcommands.

See Command::long_flag_aliases.

Examples
let m = Command::new("myprog")
            .subcommand(Command::new("test").long_flag("test")
                .visible_long_flag_aliases(&["testing", "testall", "test_all"]))
            .get_matches_from(vec!["myprog", "--testing"]);
assert_eq!(m.subcommand_name(), Some("test"));

Set the placement of this subcommand within the help.

Subcommands with a lower value will be displayed first in the help message. Subcommands with duplicate display orders will be displayed in alphabetical order.

This is helpful when one would like to emphasize frequently used subcommands, or prioritize those towards the top of the list.

NOTE: The default is 999 for all subcommands.

Examples
let m = Command::new("cust-ord")
    .subcommand(Command::new("alpha") // typically subcommands are grouped
                                               // alphabetically by name. Subcommands
                                               // without a display_order have a value of
                                               // 999 and are displayed alphabetically with
                                               // all other 999 subcommands
        .about("Some help and text"))
    .subcommand(Command::new("beta")
        .display_order(1)   // In order to force this subcommand to appear *first*
                            // all we have to do is give it a value lower than 999.
                            // Any other subcommands with a value of 1 will be displayed
                            // alphabetically with this one...then 2 values, then 3, etc.
        .about("I should be first!"))
    .get_matches_from(vec![
        "cust-ord", "--help"
    ]);

The above example displays the following help message

cust-ord

USAGE:
    cust-ord [OPTIONS]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    beta    I should be first!
    alpha   Some help and text

Specifies that this subcommand should be hidden from help messages

Examples
Command::new("myprog")
    .subcommand(
        Command::new("test").hide(true)
    )

If no subcommand is present at runtime, error and exit gracefully.

Examples
let err = Command::new("myprog")
    .subcommand_required(true)
    .subcommand(Command::new("test"))
    .try_get_matches_from(vec![
        "myprog",
    ]);
assert!(err.is_err());
assert_eq!(err.unwrap_err().kind(), ErrorKind::MissingSubcommand);

Assume unexpected positional arguments are a subcommand.

Arguments will be stored in the "" argument in the ArgMatches

NOTE: Use this setting with caution, as a truly unexpected argument (i.e. one that is NOT an external subcommand) will not cause an error and instead be treated as a potential subcommand. One should check for such cases manually and inform the user appropriately.

NOTE: A built-in subcommand will be parsed as an external subcommand when escaped with --.

Examples
// Assume there is an external subcommand named "subcmd"
let m = Command::new("myprog")
    .allow_external_subcommands(true)
    .get_matches_from(vec![
        "myprog", "subcmd", "--option", "value", "-fff", "--flag"
    ]);

// All trailing arguments will be stored under the subcommand's sub-matches using an empty
// string argument name
match m.subcommand() {
    Some((external, ext_m)) => {
         let ext_args: Vec<&str> = ext_m.values_of("").unwrap().collect();
         assert_eq!(external, "subcmd");
         assert_eq!(ext_args, ["--option", "value", "-fff", "--flag"]);
    },
    _ => {},
}

Specifies that external subcommands that are invalid UTF-8 should not be treated as an error.

NOTE: Using external subcommand argument values with invalid UTF-8 requires using ArgMatches::values_of_os or ArgMatches::values_of_lossy for those particular arguments which may contain invalid UTF-8 values

NOTE: Setting this requires Command::allow_external_subcommands

Platform Specific

Non Windows systems only

Examples
// Assume there is an external subcommand named "subcmd"
let m = Command::new("myprog")
   .allow_invalid_utf8_for_external_subcommands(true)
   .allow_external_subcommands(true)
   .get_matches_from(vec![
       "myprog", "subcmd", "--option", "value", "-fff", "--flag"
   ]);

// All trailing arguments will be stored under the subcommand's sub-matches using an empty
// string argument name
match m.subcommand() {
   Some((external, ext_m)) => {
        let ext_args: Vec<&std::ffi::OsStr> = ext_m.values_of_os("").unwrap().collect();
        assert_eq!(external, "subcmd");
        assert_eq!(ext_args, ["--option", "value", "-fff", "--flag"]);
   },
   _ => {},
}

Specifies that use of an argument prevents the use of subcommands.

By default clap allows arguments between subcommands such as <cmd> [cmd_args] <subcmd> [subcmd_args] <subsubcmd> [subsubcmd_args].

This setting disables that functionality and says that arguments can only follow the final subcommand. For instance using this setting makes only the following invocations possible:

  • <cmd> <subcmd> <subsubcmd> [subsubcmd_args]
  • <cmd> <subcmd> [subcmd_args]
  • <cmd> [cmd_args]
Examples
Command::new("myprog")
    .args_conflicts_with_subcommands(true);

Prevent subcommands from being consumed as an arguments value.

By default, if an option taking multiple values is followed by a subcommand, the subcommand will be parsed as another value.

cmd --foo val1 val2 subcommand
          --------- ----------
            values   another value

This setting instructs the parser to stop when encountering a subcommand instead of greedily consuming arguments.

cmd --foo val1 val2 subcommand
          --------- ----------
            values   subcommand

Note: Make sure you apply it as global_setting if you want this setting to be propagated to subcommands and sub-subcommands!

Examples
let cmd = Command::new("cmd").subcommand(Command::new("sub")).arg(
    Arg::new("arg")
        .long("arg")
        .multiple_values(true)
        .takes_value(true),
);

let matches = cmd
    .clone()
    .try_get_matches_from(&["cmd", "--arg", "1", "2", "3", "sub"])
    .unwrap();
assert_eq!(
    matches.values_of("arg").unwrap().collect::<Vec<_>>(),
    &["1", "2", "3", "sub"]
);
assert!(matches.subcommand_matches("sub").is_none());

let matches = cmd
    .subcommand_precedence_over_arg(true)
    .try_get_matches_from(&["cmd", "--arg", "1", "2", "3", "sub"])
    .unwrap();
assert_eq!(
    matches.values_of("arg").unwrap().collect::<Vec<_>>(),
    &["1", "2", "3"]
);
assert!(matches.subcommand_matches("sub").is_some());

Allows subcommands to override all requirements of the parent command.

For example, if you had a subcommand or top level application with a required argument that is only required as long as there is no subcommand present, using this setting would allow you to set those arguments to Arg::required(true) and yet receive no error so long as the user uses a valid subcommand instead.

NOTE: This defaults to false (using subcommand does not negate requirements)

Examples

This first example shows that it is an error to not use a required argument

let err = Command::new("myprog")
    .subcommand_negates_reqs(true)
    .arg(Arg::new("opt").required(true))
    .subcommand(Command::new("test"))
    .try_get_matches_from(vec![
        "myprog"
    ]);
assert!(err.is_err());
assert_eq!(err.unwrap_err().kind(), ErrorKind::MissingRequiredArgument);

This next example shows that it is no longer error to not use a required argument if a valid subcommand is used.

let noerr = Command::new("myprog")
    .subcommand_negates_reqs(true)
    .arg(Arg::new("opt").required(true))
    .subcommand(Command::new("test"))
    .try_get_matches_from(vec![
        "myprog", "test"
    ]);
assert!(noerr.is_ok());

Multiple-personality program dispatched on the binary name (argv[0])

A “multicall” executable is a single executable that contains a variety of applets, and decides which applet to run based on the name of the file. The executable can be called from different names by creating hard links or symbolic links to it.

This is desirable for:

  • Easy distribution, a single binary that can install hardlinks to access the different personalities.
  • Minimal binary size by sharing common code (e.g. standard library, clap)
  • Custom shells or REPLs where there isn’t a single top-level command

Setting multicall will cause

  • argv[0] to be stripped to the base name and parsed as the first argument, as if Command::no_binary_name was set.
  • Help and errors to report subcommands as if they were the top-level command

When the subcommand is not present, there are several strategies you may employ, depending on your needs:

  • Let the error percolate up normally
  • Print a specialized error message using the Error::context
  • Print the help but this might be ambiguous
  • Disable multicall and re-parse it
  • Disable multicall and re-parse it with a specific subcommand

When detecting the error condition, the ErrorKind isn’t sufficient as a sub-subcommand might report the same error. Enable allow_external_subcommands if you want to specifically get the unrecognized binary name.

NOTE: Multicall can’t be used with no_binary_name since they interpret the command name in incompatible ways.

NOTE: The multicall command cannot have arguments.

NOTE: Applets are slightly semantically different from subcommands, so it’s recommended to use Command::subcommand_help_heading and Command::subcommand_value_name to change the descriptive text as above.

Examples

hostname is an example of a multicall executable. Both hostname and dnsdomainname are provided by the same executable and which behaviour to use is based on the executable file name.

This is desirable when the executable has a primary purpose but there is related functionality that would be convenient to provide and implement it to be in the same executable.

The name of the cmd is essentially unused and may be the same as the name of a subcommand.

The names of the immediate subcommands of the Command are matched against the basename of the first argument, which is conventionally the path of the executable.

This does not allow the subcommand to be passed as the first non-path argument.

let mut cmd = Command::new("hostname")
    .multicall(true)
    .subcommand(Command::new("hostname"))
    .subcommand(Command::new("dnsdomainname"));
let m = cmd.try_get_matches_from_mut(&["/usr/bin/hostname", "dnsdomainname"]);
assert!(m.is_err());
assert_eq!(m.unwrap_err().kind(), ErrorKind::UnknownArgument);
let m = cmd.get_matches_from(&["/usr/bin/dnsdomainname"]);
assert_eq!(m.subcommand_name(), Some("dnsdomainname"));

Busybox is another common example of a multicall executable with a subcommmand for each applet that can be run directly, e.g. with the cat applet being run by running busybox cat, or with cat as a link to the busybox binary.

This is desirable when the launcher program has additional options or it is useful to run the applet without installing a symlink e.g. to test the applet without installing it or there may already be a command of that name installed.

To make an applet usable as both a multicall link and a subcommand the subcommands must be defined both in the top-level Command and as subcommands of the “main” applet.

fn applet_commands() -> [Command<'static>; 2] {
    [Command::new("true"), Command::new("false")]
}
let mut cmd = Command::new("busybox")
    .multicall(true)
    .subcommand(
        Command::new("busybox")
            .subcommand_value_name("APPLET")
            .subcommand_help_heading("APPLETS")
            .subcommands(applet_commands()),
    )
    .subcommands(applet_commands());
// When called from the executable's canonical name
// its applets can be matched as subcommands.
let m = cmd.try_get_matches_from_mut(&["/usr/bin/busybox", "true"]).unwrap();
assert_eq!(m.subcommand_name(), Some("busybox"));
assert_eq!(m.subcommand().unwrap().1.subcommand_name(), Some("true"));
// When called from a link named after an applet that applet is matched.
let m = cmd.get_matches_from(&["/usr/bin/true"]);
assert_eq!(m.subcommand_name(), Some("true"));

Sets the value name used for subcommands when printing usage and help.

By default, this is “SUBCOMMAND”.

See also Command::subcommand_help_heading

Examples
Command::new("myprog")
    .subcommand(Command::new("sub1"))
    .print_help()

will produce

myprog

USAGE:
    myprog [SUBCOMMAND]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help    Print this message or the help of the given subcommand(s)
    sub1

but usage of subcommand_value_name

Command::new("myprog")
    .subcommand(Command::new("sub1"))
    .subcommand_value_name("THING")
    .print_help()

will produce

myprog

USAGE:
    myprog [THING]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help    Print this message or the help of the given subcommand(s)
    sub1

Sets the help heading used for subcommands when printing usage and help.

By default, this is “SUBCOMMANDS”.

See also Command::subcommand_value_name

Examples
Command::new("myprog")
    .subcommand(Command::new("sub1"))
    .print_help()

will produce

myprog

USAGE:
    myprog [SUBCOMMAND]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help    Print this message or the help of the given subcommand(s)
    sub1

but usage of subcommand_help_heading

Command::new("myprog")
    .subcommand(Command::new("sub1"))
    .subcommand_help_heading("THINGS")
    .print_help()

will produce

myprog

USAGE:
    myprog [SUBCOMMAND]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

THINGS:
    help    Print this message or the help of the given subcommand(s)
    sub1

Reflection

Get the name of the binary.

Get the name of the binary.

Set binary name. Uses &mut self instead of self.

Get the name of the cmd.

Get the version of the cmd.

Get the long version of the cmd.

Get the authors of the cmd.

Get the short flag of the subcommand.

Get the long flag of the subcommand.

Get the help message specified via Command::about.

Get the help message specified via Command::long_about.

Deprecated, replaced with Command::get_next_help_heading

Get the custom section heading specified via Command::help_heading.

Iterate through the visible aliases for this subcommand.

Iterate through the visible short aliases for this subcommand.

Iterate through the visible long aliases for this subcommand.

Iterate through the set of all the aliases for this subcommand, both visible and hidden.

Iterate through the set of all the short aliases for this subcommand, both visible and hidden.

Iterate through the set of all the long aliases for this subcommand, both visible and hidden.

Check if the given AppSettings variant is currently set on the Command.

This checks both local and global settings.

Should we color the output?

Iterate through the set of subcommands, getting a reference to each.

Iterate through the set of subcommands, getting a mutable reference to each.

Returns true if this Command has subcommands.

Returns the help heading for listing subcommands.

Deprecated, replaced with App::get_subcommand_help_heading

Returns the subcommand value name.

Returns the help heading for listing subcommands.

Returns the help heading for listing subcommands.

Returns the help heading for listing subcommands.

Returns the help heading for listing subcommands.

Find subcommand such that its name or one of aliases equals name.

This does not recurse through subcommands of subcommands.

Find subcommand such that its name or one of aliases equals name, returning a mutable reference to the subcommand.

This does not recurse through subcommands of subcommands.

Iterate through the set of groups.

Iterate through the set of arguments.

Iterate through the positionals arguments.

Iterate through the options.

Get a list of all arguments the given argument conflicts with.

If the provided argument is declared as global, the conflicts will be determined based on the propagation rules of global arguments.

Panics

If the given arg contains a conflict with an argument that is unknown to this Command.

Report whether Command::no_binary_name is set

Report whether Command::dont_delimit_trailing_values is set

Report whether Command::disable_version_flag is set

Report whether Command::propagate_version is set

Report whether Command::next_line_help is set

Report whether Command::disable_help_flag is set

Report whether Command::disable_help_subcommand is set

Report whether Command::disable_colored_help is set

Report whether Command::dont_collapse_args_in_usage is set

Report whether Command::arg_required_else_help is set

Report whether Command::allow_negative_numbers is set

Report whether Command::trailing_var_arg is set

Report whether Command::allow_missing_positional is set

Report whether Command::hide is set

Report whether Command::subcommand_required is set

Report whether Command::allow_external_subcommands is set

Report whether Command::allow_invalid_utf8_for_external_subcommands is set

Configured parser for values passed to an external subcommand

Example
let cmd = clap::Command::new("raw")
    .allow_external_subcommands(true)
    .allow_invalid_utf8_for_external_subcommands(true);
let value_parser = cmd.get_external_subcommand_value_parser();
println!("{:?}", value_parser);

Report whether Command::args_conflicts_with_subcommands is set

Report whether Command::subcommand_precedence_over_arg is set

Report whether Command::subcommand_negates_reqs is set

Report whether Command::multicall is set

This impl block contains no items.

Deprecated

Prepare for introspecting on all included Commands

Call this on the top-level Command when done building and before reading state for cases like completions, custom help output, etc.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Compare self to key and return true if they are equal.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.