4 releases (2 stable)

2.0.3 Jan 10, 2025
1.0.0 Dec 9, 2024
0.2.0 Nov 4, 2024
0.1.0 Aug 13, 2023

#4 in #buf-writer

Download history 63/week @ 2025-08-28 116/week @ 2025-09-04 206/week @ 2025-09-11 160/week @ 2025-09-18 173/week @ 2025-09-25 274/week @ 2025-10-02 105/week @ 2025-10-09 135/week @ 2025-10-16 127/week @ 2025-10-23 116/week @ 2025-10-30 136/week @ 2025-11-06 122/week @ 2025-11-13 135/week @ 2025-11-20 103/week @ 2025-11-27 109/week @ 2025-12-04 56/week @ 2025-12-11

435 downloads per month
Used in 8 crates

MIT license

255KB
6.5K SLoC

clap_usage

Generates usage spec for CLIs written with clap.

Usage

use clap::{arg, Command, ValueHint};
use clap_usage::generate;
use std::io::BufWriter;

fn build_cli() -> Command {
    Command::new("example")
        .arg(arg!(--file <FILE> "some input file").value_hint(ValueHint::AnyPath))
        .arg(arg!(--usage))
}

fn main() {
    let matches = build_cli().get_matches();

    if matches.get_flag("usage") {
        let mut cmd = build_cli();
        eprintln!("Generating usage spec...");
        clap_usage::generate(&mut cmd, "example", &mut std::io::stdout()).unwrap();
        return;
    }

    // Your CLI code here...
}

Dependencies

~11–41MB
~562K SLoC