Crate clap_verbosity

Available on crate feature serde only.

Control log level with a --verbose flag for your CLI

This crate adds a --verbose flag to your CLI. Most of its code came from clap_verbosity_flag and as such, it is largely a superset and a drop-in replacement of that crate.

Examples

To get --quiet and --verbose flags through your entire program, just flatten Verbosity:

#[command(flatten)]
verbose: Verbosity,

You can then use this to configure your logger:

let cli = Cli::parse();
env_logger::Builder::new()
    .filter_level(cli.verbose.log_level_filter())
    .init();

By default, this will only report errors.

• -q silences output
• -v show warnings
• -vv show info
• -vvv show debug
• -vvvv show trace

You can also customize the default logging level:

use clap_verbosity::{Verbosity, InfoLevel};

/// The CLI
#[derive(Debug, Parser)]
struct Cli {
    #[command(flatten)]
    verbose: Verbosity<InfoLevel>,
}

Or implement LogLevel yourself for more control.

Modules

serde_support

Structs

ErrorLevel

InfoLevel

Verbosity

WarnLevel

Enums

Level

An enum representing the available verbosity levels of the logger.

LevelFilter

An enum representing the available verbosity level filters of the logger.

Traits

LogLevel

Functions

level_enum

Converts an i8 to an Optionlog::Level.

level_value

Converts an Optionlog::Level to an i8.