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

#750 in Development tools

Download history 57/week @ 2024-11-17 27/week @ 2024-11-24 18/week @ 2024-12-01 298/week @ 2024-12-08 78/week @ 2024-12-15 9/week @ 2024-12-22 4/week @ 2024-12-29 142/week @ 2025-01-05 61/week @ 2025-01-12 18/week @ 2025-01-19 17/week @ 2025-01-26 43/week @ 2025-02-02 28/week @ 2025-02-09 292/week @ 2025-02-16 90/week @ 2025-02-23 21/week @ 2025-03-02

434 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
~556K SLoC