supports-hyperlinks
| Crates.io | supports-hyperlinks |
| lib.rs | supports-hyperlinks |
| version | 3.0.0 |
| source | src |
| created_at | 2021-09-11 04:04:13.152216 |
| updated_at | 2024-02-04 03:10:59.139684 |
| description | Detects whether a terminal supports rendering hyperlinks. |
| homepage | |
| repository | https://github.com/zkat/supports-hyperlinks |
| max_upload_size | |
| id | 449607 |
| size | 19,730 |
Kat Marchán (zkat)
documentation
https://docs.rs/supports-hyperlinks
README
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.