seahorse

A minimal CLI framework written in Rust

Features

• Easy to use
• No dependencies
• Typed flags(Bool, String, Int, Float)

Documentation

Here

Usage

To use seahorse, add this to your Cargo.toml:

toml [dependencies] seahorse = "1.0.0"

Example

Run example

bash $ git clone https://github.com/ksk001100/seahorse $ cd seahorse $ cargo run --example single_app -- --help $ cargo run --example multiple_app -- --help

Quick Start

bash $ cargo new cli $ cd cli $ echo 'seahorse = "*"' >> Cargo.toml

```rust use seahorse::{App}; use std::env;

fn main() { let args: Vec = env::args().collect(); let app = App::new(env!("CARGOPKGNAME")) .author(env!("CARGOPKGAUTHORS")) .version(env!("CARGOPKGVERSION")) .usage("cli [args]") .action(|c| println("Hello, {:?}", c.args));

app.run(args);

} ```

bash $ cargo build --release $ ./target/release/cli --help $ ./target/release/cli John

Multiple command application

```rust use seahorse::{App, Context, Command}; use std::env;

fn main() { let args: Vec = env::args().collect(); let app = App::new(env!("CARGOPKGNAME")) .author(env!("CARGOPKGAUTHORS")) .version(env!("CARGOPKGVERSION")) .usage("cli [name]") .action(defaultaction) .command(addcommand()) .command(sub_command());

app.run(args);

}

fn default_action(c: &Context) { println!("Hello, {:?}", c.args); }

fn add_action(c: &Context) { let sum: i32 = c.args.iter().map(|n| n.parse::().unwrap()).sum(); println!("{}", sum); }

fn addcommand() -> Command { Command::new("add") .alias("a") .usage("cli add(a****) [nums...]") .action(addaction) }

fn sub_action(c: &Context) { let sum: i32 = c.args.iter().map(|n| n.parse::().unwrap() * -1).sum(); println!("{}", sum); }

fn subcommand() -> Command { Command::new("sub") .alias("s") .usage("cli sub(s) [nums...]") .action(subaction) } ```

```bash $ cli John Hello, ["John"]

$ cli add 32 10 43 85

$ cli sub 12 23 89 -124 ```

Branch processing by flag

```rust use seahorse::{App, Command, Context, Flag, FlagType, error::FlagError}; use std::env;

fn main() { let args: Vec = env::args().collect(); let app = App::new(env!("CARGOPKGNAME")) .author(env!("CARGOPKGAUTHORS")) .version(env!("CARGOPKGVERSION")) .usage("cli [name]") .action(defaultaction) .flag( Flag::new("bye", FlagType::Bool) .usage("cli [name] --bye(-b)") .alias("b"), ) .flag( Flag::new("age", FlagType::Int) .usage("cli [name] --age(-a)") .alias("a"), ) .command(calccommand());

app.run(args);

}

fn defaultaction(c: &Context) { if c.boolflag("bye") { println!("Bye, {:?}", c.args); } else { println!("Hello, {:?}", c.args); }

if let Ok(age) = c.int_flag("age") {
    println!("{:?} is {} years old", c.args, age);
}

}

fn calcaction(c: &Context) { match c.stringflag("operator") { Ok(op) => { let sum: i32 = match &*op { "add" => c.args.iter().map(|n| n.parse::().unwrap()).sum(), "sub" => c.args.iter().map(|n| n.parse::().unwrap() * -1).sum(), _ => panic!("undefined operator..."), };

        println!("{}", sum);
    }
    Err(e) => match e {
        FlagError::Undefiled => panic!("undefined operator..."), 
        FlagError::ArgumentError => panic!("argument error..."), 
        FlagError::NotFound => panic!("not found flag..."), 
        FlagError::ValueTypeError => panic!("value type mismatch..."), 
        FlagError::TypeError => panic!("flag type mismatch..."), 
    },
}

}

fn calccommand() -> Command { Command::new("calc") .alias("cl, c") .usage("cli calc(cl, c) [nums...]") .action(calcaction) .flag( Flag::new("operator", FlagType::String) .usage("cli calc [nums...] --operator(-op) [add | sub]") .alias("op"), ) } ```

```bash $ cli John Hello, ["John"]

$ cli John --bye Bye, ["John"]

$ cli John --age 10 Hello, ["John"] ["John"] is 10 years old

$ cli John -b -a=40 Bye, ["John"] ["John"] is 40 years old

$ cli calc --operator add 1 2 3 4 5 15

$ cli calc -op sub 10 6 3 2 -21 ```

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under MIT license

Code of Conduct

Contribution to the seahorse crate is organized under the terms of the Contributor Covenant, the maintainer of seahorse, @ksk001100, promises to intervene to uphold that code of conduct.