https://github.com/zkat/supports-hyperlinks

Detect whether the current terminal supports rendering hyperlinks
https://github.com/zkat/supports-hyperlinks

Last synced: 9 months ago
JSON representation

Detect whether the current terminal supports rendering hyperlinks

• Host: GitHub
• URL: https://github.com/zkat/supports-hyperlinks
• Owner: zkat
• License: other
• Created: 2021-09-11T04:00:44.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-26T09:12:37.000Z (about 1 year ago)
• Last Synced: 2025-03-29T02:04:23.700Z (9 months ago)
• Language: Rust
• Size: 42 KB
• Stars: 27
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
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.

## MSRV

The minimum supported Rust version is 1.70.0.