Skip to content

wiktor-k/clap_allgen

Repository files navigation

Clap All-Gen

CI Crates.io

The complete clap generation utility to give your command-line application users a more polished experience right out of the box.

To create all shell completions use the following command:

use clap_allgen::render_shell_completions;

#[derive(Debug, clap::Parser)]
enum Commands {
  First,
  Second,
  Third,
}

render_shell_completions::<Commands>("/tmp/shell-completions").expect("generation to work");

To generate man pages for your commands use:

use clap_allgen::render_manpages;

#[derive(Debug, clap::Parser)]
enum Commands {
  First,
  Second,
  Third,
}

render_manpages::<Commands>("/tmp/man-pages").expect("generation to work");

License

This project is licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.