Skip to content

clap-rs/clap-verbosity-flag

Repository files navigation

clap-verbosity-flag for log / tracing

Documentation License crates.io

Easily add --verbose and --quiet flags to CLIs using Clap.

Examples

$ cargo add clap-verbosity-flag
use clap::Parser;

#[derive(Debug, Parser)]
struct Cli {
    #[command(flatten)]
    verbosity: clap_verbosity_flag::Verbosity,
}

fn main() {
    let args = Cli::parse();
    env_logger::Builder::new()
        .filter_level(args.verbosity.into())
        .init();
    // Your code here
}

For tracing support, use the tracing feature:

$ cargo add clap-verbosity-flag --no-default-features --features tracing
use clap::Parser;

#[derive(Debug, Parser)]
struct Cli {
    #[command(flatten)]
    verbosity: clap_verbosity_flag::Verbosity,
}

fn main() {
    let args = Cli::parse();
    tracing_subscriber::fmt()
        .with_max_level(args.verbosity)
        .init();
    // Your code here
}

The default verbosity level will cause log / tracing to only report errors. The flags can be specified multiple times to increase or decrease the verbosity level. See the Documentation for info on how to change the default verbosity level.

  • silence output: -q / --quiet
  • show warnings: -v / --verbose
  • show info: -vv / --verbose --verbose
  • show debug: -vvv / --verbose --verbose --verbose
  • show trace: -vvvv / --verbose --verbose --verbose --verbose

License

Licensed under either of

at your option.

Contribution

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

About

Easily add a --verbose flag to CLIs using Clap

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Contributors 19

Languages