blob: f01ef92d697b3007ad5c8263a865826c2987a357 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
Detects whether the current terminal supports [hyperlinks in terminal
emulators](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).
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!
```rust
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.
|
