6 stable releases
3.0.0 | Feb 4, 2024 |
---|---|
2.1.0 | Apr 18, 2023 |
2.0.0 | Mar 13, 2023 |
1.2.0 | Sep 16, 2021 |
#73 in Command-line interface
457,222 downloads per month
Used in 177 crates
(15 directly)
9KB
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.