Variants

Auto

Enables colored output only when the output is going to a terminal or TTY.

NOTE: This is the default behavior of clap.

Examples

# #[cfg(feature = "color")] {
# use clap_builder as clap;
# use clap::{Command, ColorChoice};
Command::new("myprog")
    .color(ColorChoice::Auto)
    .get_matches();
# }

Always

Enables colored output regardless of whether or not the output is going to a terminal/TTY.

Examples

# #[cfg(feature = "color")] {
# use clap_builder as clap;
# use clap::{Command, ColorChoice};
Command::new("myprog")
    .color(ColorChoice::Always)
    .get_matches();
# }

Never

Disables colored output no matter if the output is going to a terminal/TTY, or not.

Examples

# #[cfg(feature = "color")] {
# use clap_builder as clap;
# use clap::{Command, ColorChoice};
Command::new("myprog")
    .color(ColorChoice::Never)
    .get_matches();
# }