sindresorhus / terminal-link

Create clickable links in the terminal

terminal-link

Create clickable links in the terminal

Install

$ npm install terminal-link

Usage

import terminalLink from 'terminal-link';

const link = terminalLink('My Website', 'https://sindresorhus.com');
console.log(link);

API

terminalLink(text, url, options?)

Create a link for use in stdout.

Supported terminals.

For unsupported terminals, the link will be printed in parens after the text: My website (https://sindresorhus.com).

text

Type: string

Text to linkify.

url

Type: string

URL to link to.

options

Type: object

fallback

Type: Function | boolean

Override the default fallback. The function receives the text and url as parameters and is expected to return a string.

If set to false, the fallback will be disabled when a terminal is unsupported.

terminalLink.isSupported

Type: boolean

Check whether the terminal's stdout supports links.

Prefer just using the default fallback or the fallback option whenever possible.

terminalLink.stderr(text, url, options?)

Create a link for use in stderr.

Same arguments as terminalLink().

terminalLink.stderr.isSupported

Type: boolean

Check whether the terminal's stderr supports links.

Prefer just using the default fallback or the fallback option whenever possible.

Related

• terminal-link-cli - CLI for this module
• ink-link - Link component for Ink
• chalk - Terminal string styling done right

terminal-link's Issues

I have error with dependencies "supports-hyperlinks"

why terminal-link is ESM, but supports-hyperlinks is commonjs ?
when i use terminal-link with ts-node xxx.ts, i get an error:

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: xxxxx/node_modules/terminal-link/index.js

done

Doesn't work with Terminator (Ubuntu)

While it does with the default gnome terminal, it doesn't work with Terminator.

VSCode links include the terminating paren ")"

Feature: support click and then call function

I hope that I can click the linked words and run a shell command

Add TypeScript definition

This is my typescript

declare function terminalLink(
  text: string,
  url: string,
  options?: { fallback: (text: string, url: string) => string }
): string;

declare module "terminal-link" {
  export = terminalLink;
}

3.0 doesn't support cjs

Providing a cjs build would be nice for those of use not able to use esm. In my case other tooling (qunit) is incompatible even though my lowest supported node version (12.x) is compatible with this.

Whats wrong ???

    const searches = await client.ft.search("idx:user",`@username:(${username})`,{ LIMIT : { size:perpage,from : offset } })

    if (searches.total === 0){

        console.log(`${chalk.bgRedBright(" NOTHING ")} founded`);

        process.exit(0)

        return;

    }

    for (const search of searches.documents){

        const item = search.value

        console.log(item);

        table.push([item.title,terminalLink("URL",item.url),Math.ceil(item.visit_duration / 1000),item.typed_count,item.hidden]);

    }

I am using cli-table and terminal link because of require I am using version 2.1.1

done's work with webstorm's terminal

Clickable links including "zero width space" in URL

I've already reported this issue on the Netlify CLI repo netlify/cli#4311

I'm using VSCode and am working on a project that uses the Netlify CLI. They print out the URLs to the serverless functions as they're loaded. These URLs include a "zero width space" (U+200B).

◈ Loaded function api (​http://localhost:8888/.netlify/functions/api​).
◈ Loaded function render (​http://localhost:8888/.netlify/functions/render​).

Clicking those links in the VSCode terminal includes the zero width space, producing URLs that look like

http://localhost:8888/.netlify/functions/api%E2%80%8B

I know there is a fallback that adds the character for unsupported terminals. VSCode isn't specifically on the support list, but it can also use lots of different terminals so it may be listed as one of them. Even if none are supported, VSCode's terminal seems to make any URL-like string clickable, for example:

I'm curious if it would be safe for me to write a PR for the Netlify CLI that turns it off or returns a normal space?

Stderr support

---

IssueHunt Summary

tom-sherman has been rewarded.

Backers (Total: $40.00)

• issuehunt ($40.00)

Submitted pull Requests

• #5 Stderr support

---

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

---

IssueHunt has been backed by the following sponsors. Become a sponsor