21 releases (6 breaking)

0.6.3 Jul 1, 2020
0.6.0 Jun 29, 2020

#326 in Cargo plugins

39 downloads per month

MIT license

44KB
1K SLoC

Command-line application framework.

Usage

The command line parser will search for the following pattern:

$ myapp <COMMAND> <FLAGS> <PARAMS> -- <TAIL>

A simple command-line application could look something like this:

use rawcmd::{Context, Command, Flag, Intent};

fn main() {
    match Command::with_name("foo")
        .with_description("Command 1")
        .with_flag(
            Flag::with_name("flag1")
                .with_alias("f1")
                .with_description("Flag 1")
        )
        .with_param(
            Param::with_name("param1")
                .with_description("Param 1")
        )
        .with_subcommand(
            Command::with_name("bar")
                .with_description("Command 1:1")
                .with_flag(
                    Flag::with_name("flag2")
                        .with_alias("f2")
                        .with_description("Flag 2")
                )
                .with_resolver(|_intent, &mut _context| Ok(2))
        )
        .with_resolver(|_intent, &mut _context| Ok(3))
        .with_handler(|_error, _intent, &mut _context| Ok(4))
        .run(
            &mut Context::default(),
        )
    {
        Ok(code) => {
            println!("Success: {:?}", code);
            std::process::exit(0);
        },
        Err(error) => {
            println!("Error: {:?}", error);
            std::process::exit(1);
        },
    }
}

You can use your own custom context object as well:

...
.run<MyContext>(
    MyContext::default()
)

No runtime deps