https://github.com/sindresorhus/terminal-link

Create clickable links in the terminal
https://github.com/sindresorhus/terminal-link

command-line hyperlink hyperlink-support nodejs npm-package terminal

Last synced: 8 days ago
JSON representation

Create clickable links in the terminal

• Host: GitHub
• URL: https://github.com/sindresorhus/terminal-link
• Owner: sindresorhus
• License: mit
• Created: 2018-04-04T17:28:48.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-02-17T05:53:13.000Z (over 1 year ago)
• Last Synced: 2024-04-13T21:25:38.984Z (about 1 month ago)
• Topics: command-line, hyperlink, hyperlink-support, nodejs, npm-package, terminal
• Language: JavaScript
• Size: 407 KB
• Stars: 609
• Watchers: 11
• Forks: 25
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Lists

• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-cli - terminal-link - Create clickable links in the terminal. (Output)
• awesome-nodejs-cn - terminal-link - 终端创建可点击链接. (目录 / 命令行工具)
• awesome-web-cn - terminal-link - 一个帮助你在终端创建可以点击的链接的库 (Uncategorized / Uncategorized)
• awesome - sindresorhus/terminal-link - Create clickable links in the terminal (JavaScript)
• awesome-nodejs - terminal-link - Create clickable links in the terminal.  (Repository / Command-line Utilities)
• awesome-nodejs-cn - terminal-link - 在终端中创建可点击的链接 (包 / 命令行工具)
• awesome-stars - terminal-link
• awesome-nodejs-cn - terminal-link - **star:609** 在终端中创建可单击链接 (包 / 命令行实用工具)
• awesome-nodejs-cn - terminal-link - 在终端中创建可点击的链接 (包 / 命令行工具)
• awesome-github-star - terminal-link
• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-node - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-node.js - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-stars - sindresorhus/terminal-link - Create clickable links in the terminal (JavaScript)
• awesome-things - terminal-link - print links in terminal! (CLI apps development / Shell)
• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-nodejs - terminal-link - Create clickable links in the terminal - ★ 130 (Command-line utilities)
• awesome-stars - terminal-link - Create clickable links in the terminal (JavaScript)
• awesome-tools - terminal-link - 在命令行输出链接 (打印)
• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)
• awesome-nodejs - terminal-link - Create clickable links in the terminal. (Packages / Command-line utilities)

README

        
# terminal-link

> Create clickable links in the terminal



## Install

```

$ npm install terminal-link

```

## Usage

```js

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.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)

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](https://github.com/sindresorhus/terminal-link-cli) - CLI for this module

- [ink-link](https://github.com/sindresorhus/ink-link) - Link component for Ink

- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right