clap_usage

Crates.ioclap_usage
lib.rsclap_usage
version2.0.3
created_at2023-08-13 01:34:23.071157+00
updated_at2025-01-10 23:40:11.628579+00
descriptionLibrary for working with usage specs
homepagehttps://usage.jdx.dev
repositoryhttps://github.com/jdx/usage
max_upload_size
id943090
size41,533
(jdx)

documentation

https://usage.jdx.dev

README

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...
}
Commit count: 438

cargo fmt