link

The link function creates a clickable hyperlink in terminal emulators that support the OSC 8 escape sequence. The link text is displayed in the terminal and opens the URL when clicked.

Signature

function link(text: string, url: string): string

Parameters

• text: The display text shown in the terminal.
• url: The URL that opens when the link is clicked.

Return Value

Returns a string containing OSC 8 escape sequences that render as a clickable hyperlink in supported terminals.

Usage

import betterConsole, { link } from "ts-better-console";

// Create a clickable link in the terminal
betterConsole.log(link("Visit GitHub", "https://github.com"));

// Combine with styled text
betterConsole.log("Check out", link("the docs", "https://example.com/docs"));