#console #terminal #cli

bin+lib termbg

Terminal background color detection

7 releases

0.3.0 May 28, 2021
0.2.4 May 20, 2021
0.2.0 Nov 10, 2020
0.1.0 Nov 9, 2020

#205 in Command-line interface

Download history 782/week @ 2021-07-05 567/week @ 2021-07-12 1080/week @ 2021-07-19 959/week @ 2021-07-26 658/week @ 2021-08-02 968/week @ 2021-08-09 1142/week @ 2021-08-16 1113/week @ 2021-08-23 799/week @ 2021-08-30 627/week @ 2021-09-06 1105/week @ 2021-09-13 560/week @ 2021-09-20 821/week @ 2021-09-27 595/week @ 2021-10-04 616/week @ 2021-10-11 633/week @ 2021-10-18

2,003 downloads per month
Used in 3 crates (2 directly)

MIT/Apache

15KB
307 lines

termbg

A Rust library for terminal background color detection. The detected color is provided by RGB or theme ( dark or light ).

Actions Status Crates.io Docs.rs

Verified terminals

If you check other terminals, please report through issue.

Unsupported terminals

"Windows Terminal" may be supported in a future release: https://github.com/microsoft/terminal/issues/3718.

Usage

[dependencies]
termbg = "0.3.0"

Example

fn main() {
    let timeout = std::time::Duration::from_millis(100);

    println!("Check terminal background color");
    let term = termbg::terminal();
    let rgb = termbg::rgb(timeout);
    let theme = termbg::theme(timeout);

    println!("  Term : {:?}", term);

    match rgb {
        Ok(rgb) => {
            println!("  Color: R={:x}, G={:x}, B={:x}", rgb.r, rgb.g, rgb.b);
        }
        Err(e) => {
            println!("  Color: detection failed {:?}", e);
        }
    }

    match theme {
        Ok(theme) => {
            println!("  Theme: {:?}", theme);
        }
        Err(e) => {
            println!("  Theme: detection failed {:?}", e);
        }
    }
}

Check program

This crate provides a simple program to check.

$ cargo run
Check terminal background color
  Term : Tmux
  Color: R=0, G=0, B=0
  Theme: Dark

Detecting mechanism

If the terminal is win32 console, WIN32API is used for detection. If the terminal is xterm compatible, "Xterm Control Sequences" is used.

The detected RGB is converted to YCbCr. If Y > 0.5, the theme is detected as "light", otherwise "dark".

Dependencies

~2–4MB
~85K SLoC