Crate supports_hyperlinks

Expand description

Detects whether the current terminal supports hyperlinks in terminal emulators.

It tries to detect and support all known terminals and terminal families that support this. If a declaration is wrong, missing, or could be improved, please send a PR!

§Example

The API is super simple!

use supports_hyperlinks::Stream;

if supports_hyperlinks::on(Stream::Stdout) {
    println!("This terminal supports hyperlinks on stdout");
} else {
    println!("No hyperlinks, please");
}

And that’s it!

§Forcing hyperlinks in tools that use `supports-hyperlinks`

You may set the FORCE_HYPERLINK environment variable to force supports-hyperlinks to return true for its checks. If the value is 0, this will force it to be false, instead.

§MSRV

The minimum supported Rust version is 1.70.0.

Enums§

Stream: possible stream sources

Functions§

on: Returns true if stream is a TTY, and the current terminal supports_hyperlinks.
supports_hyperlinks: Returns true if the current terminal, detected through various environment variables, is known to support hyperlink rendering.