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

#2 in #buf-writer

Download history 17/week @ 2025-01-20 22/week @ 2025-01-27 37/week @ 2025-02-03 60/week @ 2025-02-10 285/week @ 2025-02-17 67/week @ 2025-02-24 24/week @ 2025-03-03 25/week @ 2025-03-10 92/week @ 2025-03-17 113/week @ 2025-03-24 41/week @ 2025-03-31 88/week @ 2025-04-07 98/week @ 2025-04-14 137/week @ 2025-04-21 31/week @ 2025-04-28 23/week @ 2025-05-05

293 downloads per month
Used in 4 crates

MIT license

150KB
4K 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

~10–37MB
~553K SLoC