2 unstable releases

new 0.2.0 Nov 4, 2024
0.1.0 Aug 13, 2023

#3 in #specs


Used in usage_example_rust_clap

MIT license

125KB
3.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::stderr()).unwrap();
        return;
    }

    // Your CLI code here...
}

Dependencies

~9–36MB
~556K SLoC