Struct Command 

pub struct Command { /* private fields */ }

A single registered subcommand.

Build with Command::new and configure via the builder methods before passing to [App::add_command].

Implementations

impl Command

pub fn new(name: impl Into<String>, handler: fn(&CommandContext)) -> Self

Creates a new command with the given name and handler function.

The handler receives a CommandContext containing the resolved flags and positional arguments for this invocation.

Examples found in repository

examples/taskr.rs (line 160)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn parent(name: impl Into<String>) -> Self

Examples found in repository

examples/taskr.rs (line 189)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn description(self, description: impl Into<String>) -> Self

Sets the short description shown in the app-level help listing.

Examples found in repository

examples/taskr.rs (line 161)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn usage(self, usage: impl Into<String>) -> Self

Sets the usage string shown when the user runs <cmd> --help.

Displayed as: <prog> <cmd> <usage>. For example, passing "<file> [--output <path>]" produces mytool convert <file> [--output <path>].

If omitted and the command has registered flags, a fallback of [options] is shown.

Examples found in repository

examples/taskr.rs (line 162)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn strict_flags(self, strict: bool) -> Self

Controls whether unknown flags cause a hard error or just a warning.

When true, passing an unrecognized flag prints an error and exits without calling the handler. When false (the default), a warning is printed and execution continues. Global flags are always considered known and never trigger this check.

Examples found in repository

examples/taskr.rs (line 168)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn flag(self, flag: Flag) -> Self

Registers a flag definition for this command.

Registered flags participate in alias resolution and appear in help text. Can be called multiple times to register multiple flags.

Examples found in repository

examples/taskr.rs (lines 163-167)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn subcommand(self, subcommand: Command) -> Self

Examples found in repository

examples/taskr.rs (lines 178-181)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

pub fn print_help_if_no_args(self, print: bool) -> Self

Examples found in repository

examples/taskr.rs (line 191)

fn main() {
    App::new("taskr")
        .name("Taskr")
        .description("A toy task manager. Demonstrates all vecli features.")
        .version("0.1.0")
        .main(entry)
        .flag(
            Flag::global("verbose")
                .alias("v")
                .description("Enable verbose output."),
        )
        .print_help_on_fail(true)
        .add_command(
            Command::new("add", add)
                .description("Add a new task.")
                .usage("<task> [--priority <level>]")
                .flag(
                    Flag::new("priority")
                        .alias("p")
                        .description("Task priority: low, medium, or high."),
                )
                .strict_flags(true),
        )
        .add_command(
            Command::new("list", list)
                .description("List pending tasks.")
                .flag(
                    Flag::new("all")
                        .alias("a")
                        .description("Include completed tasks."),
                )
                .subcommand(
                    Command::new("urgent", list_urgent)
                        .description("List only high-priority tasks."),
                ),
        )
        .add_command(
            Command::new("done", done)
                .description("Mark a task as done.")
                .usage("<task>"),
        )
        .add_command(
            Command::parent("config")
                .description("Manage taskr configuration.")
                .print_help_if_no_args(true)
                .subcommand(
                    Command::new("set", config_set)
                        .description("Set a config value.")
                        .usage("<key> <value>"),
                )
                .subcommand(Command::new("show", config_show).description("Show current config.")),
        )
        .add_command(Command::new("clear", clear).description("Clear all tasks."))
        .run();
}

Trait Implementations

impl Default for Command

fn default() -> Command

Returns the “default value” for a type.