duct 0.8.2

a library for creating shell pipelines

duct.rs Travis build AppVeyor build crates.io docs.rs

A cross-platform library for running child processes and building pipelines.

duct wants to make shelling out in Rust as easy and flexible as it is in Bash. It takes care of gotchas and inconsistencies in the way different platforms shell out. And it's a cross-language library; the original implementation is in Python, with an identical API.

Example

duct tries to be as concise as possible, so that you don't wish you were back writing shell scripts. At the same time, it's explicit about what happens to output, and strict about error codes in child processes.

#[macro_use]
extern crate duct;

use duct::{cmd, sh};

fn main() {
    // Read the name of the current git branch. If git exits with an error
    // code here (because we're not in a git repo, for example), `read` will
    // return an error too. `sh` commands run under the real system shell,
    // /bin/sh on Unix or cmd.exe on Windows.
    let current_branch = sh("git symbolic-ref --short HEAD").read().unwrap();

    // Log the current branch, with git taking over the terminal as usual.
    // `cmd!` commands are spawned directly, without going through the
    // shell, so there aren't any escaping issues with variable arguments.
    cmd!("git", "log", current_branch).run().unwrap();

    // More complicated expressions become trees. Here's a pipeline with two
    // child processes on the left, just because we can. In Bash this would
    // be: stdout=$((echo -n part one "" && echo part two) | sed s/p/sm/g)
    let part_one = &["-n", "part", "one", ""];
    let stdout = cmd("echo", part_one)
        .then(sh("echo part two"))
        .pipe(cmd!("sed", "s/p/sm/g"))
        .read()
        .unwrap();
    assert_eq!("smart one smart two", stdout);
}

duct uses os_pipe internally, and the docs for that one include a big example that takes a dozen lines of code to read both stdout and stderr from a child process. duct can do that in one line:

use duct::sh;

// This works on Windows too!
let output = sh("echo foo && echo bar >&2").stderr_to_stdout().read().unwrap();

assert!(output.split_whitespace().eq(vec!["foo", "bar"]));