Command-line library for writing rust style shell scripts

Common rust command-line macros and utilities, to write shell-script like tasks easily in rust programming language. Available at crates.io.

run_cmd! --> CmdResult

let name = "rust";
run_cmd!("echo hello, {}", name);

// pipe commands are also supported
run_cmd!("du -ah . | sort -hr | head -n 10");

// also work without string quote
run_cmd!(du -ah . | sort -hr | head -n 10);

// or a group of commands
// if any command fails, just return Err(...)
if run_cmd! {
    use keyword, file;

    cat ${file} | grep ${keyword};
    echo "bad cmd";
    ls -l /nofile;
    date;
}.is_err() {
    warn!("Run group command failed");
}

run_fun! --> FunResult

let version = run_fun!("rustc --version")?;
info!("Your rust version is {}", version);

// with pipes
let n = run_fun!("echo the quick brown fox jumped over the lazy dog | wc -w")?;
info!("There are {} words in above sentence", n);

Run pipe commands in the builder style

parameters could be passed much clearer in this style

Process::new("du -ah .")
    .pipe("sort -hr")
    .pipe("head -n 5")
    .wait::<CmdResult>()?;
// the same run_cmd! macro
run_cmd!("du -ah . | sort -hr | head -n 10")?;

Process::new("ls")
    .pipe("wc -l")
    .current_dir("/src/rust-shell-script/")
    .wait::<CmdResult>()?;

Builtin commands

pwd

pwd: print current working directory

cd

cd: set procecess current directory

run_cmd! {
    cd /tmp;
    ls | wc -l;
};
run_cmd!("pwd");

output will be "/tmp"

lcd

lcd: set group commands current directory

run_cmd! {
    lcd /tmp;
    ls | wc -l;
};
run_cmd!("pwd");

output will be the old current directory

Easy Reporting

info!("Running command xxx ...");
warn!("Running command failed");
err!("Copying failed");
die!("Command exit unexpectedly: {}", reason);

output:

INFO: Running command xxx ...
WARN: Running command failed
ERROR: Copying file failed
FATAL: Command exit unexpectedly: disk is full

Complete Example

use cmd_lib::{info, warn, run_cmd, run_fun, CmdResult, FunResult};

fn foo() -> CmdResult {
    let dir = "/var/tmp";
    let f = "nofile";

    run_cmd! {
        use dir, f;
        cd ${dir};
        sleep 3;
        ls ${f};
    }
}

fn get_year() -> FunResult {
    run_fun!("date +%Y")
}

fn main() -> CmdResult {
    run_cmd!(lcd /tmp; ls | wc -l;)?;
    run_cmd!("pwd")?;

    let name = "rust";
    run_cmd!("echo hello, {}", name)?;

    let result = run_fun!("du -ah . | sort -hr | head -n 5")?;
    info!("Top 5 directories:\n{}", result);

    if foo().is_err() {
        warn!("Failed to run foo()");
    }

    if get_year()? == "2019" {
        info!("You are in year 2019");
    } else {
        info!("Which year are you in ?");
    }

    Ok(())
}

output:

INFO: Set local current_dir: "/tmp"
INFO: Running "ls | wc -l (cd: /tmp)" ...
42
INFO: Running "pwd" ...
/home/tao/src/rust-shell-script/rust_cmd_lib
INFO: Running "echo hello, rust" ...
hello, rust
INFO: Running "du -ah . | sort -hr | head -n 5" ...
INFO: Top 5 directories:
488M	.
485M	./target
286M	./target/debug
170M	./target/debug/incremental
163M	./target/package
INFO: Set env current_dir: "/var/tmp"
INFO: Running "sleep 3" ...
INFO: Running "ls nofile" ...
ls: cannot access 'nofile': No such file or directory
WARN: Failed to run foo()
INFO: Running "date +%Y" ...
INFO: You are in year 2019

See rust-shell-script, which can compile rust-shell-script scripting language directly into rust code.

yxdunc / rust_cmd_lib