#unix-shell #shell #command-line #unix-command #unix #words #quote

no-std shell-words

Process command line according to parsing rules of UNIX shell

3 releases (stable)

Uses old Rust 2015

1.1.0 Feb 6, 2022
1.0.0 May 6, 2020
0.1.0 Mar 9, 2018

#9 in Unix APIs

Download history 131308/week @ 2023-12-23 195497/week @ 2023-12-30 223782/week @ 2024-01-06 229777/week @ 2024-01-13 276485/week @ 2024-01-20 283790/week @ 2024-01-27 297665/week @ 2024-02-03 270813/week @ 2024-02-10 273518/week @ 2024-02-17 284934/week @ 2024-02-24 300394/week @ 2024-03-02 296852/week @ 2024-03-09 292654/week @ 2024-03-16 287574/week @ 2024-03-23 319018/week @ 2024-03-30 256611/week @ 2024-04-06

1,201,884 downloads per month
Used in 1,788 crates (295 directly)

MIT/Apache

19KB
361 lines

shell-words

Process command line according to parsing rules of Unix shell.

Usage

Add this to Cargo.toml:

[dependencies]
shell-words = "1.0.0"

Add this to your crate:

extern crate shell_words;

Examples

Split

Compiling C source code into an executable as in default build rule found in GNU Make:

extern crate shell_words;

use std::env::var;
use std::process::Command;

fn main() {
    let cc = var("CC").unwrap_or_else(|_| "cc".to_owned());

    let cflags = var("CFLAGS").unwrap_or_else(|_| String::new());
    let cflags = shell_words::split(&cflags).expect("failed to parse CFLAGS");

    let cppflags = var("CPPFLAGS").unwrap_or_else(|_| String::new());
    let cppflags = shell_words::split(&cppflags).expect("failed to parse CPPFLAGS");

    Command::new(cc)
        .args(cflags)
        .args(cppflags)
        .args(&["-c", "a.c", "-o", "a.out"])
        .spawn()
        .expect("failed to start subprocess")
        .wait()
        .expect("failed to wait for subprocess");
}

Join

Logging executed commands in format that can be readily copied and pasted to a shell:

extern crate shell_words;

fn main() {
    let argv = &["python", "-c", "print('Hello world!')"];

    println!("Executing: {}", shell_words::join(argv));

    std::process::Command::new(&argv[0])
        .args(&argv[1..])
        .spawn()
        .expect("failed to start subprocess")
        .wait()
        .expect("failed to wait for subprocess");
}

Bugs

Please report any issues at https://github.com/tmiasko/shell-words/issues.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No runtime deps

Features