You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
![]() |
5 years ago | |
---|---|---|
.. | ||
node_modules | 5 years ago | |
index.d.ts | 5 years ago | |
index.js | 5 years ago | |
license | 5 years ago | |
package.json | 5 years ago | |
readme.md | 5 years ago |
readme.md
terminal-link 
Create clickable links in the terminal

Install
$ npm install terminal-link
Usage
const terminalLink = require('terminal-link');
const link = terminalLink('My Website', 'https://sindresorhus.com');
console.log(link);
API
terminalLink(text, url, [options])
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
Override the default fallback. The function receives the text
and url
as parameters and is expected to return a string.
terminalLink.isSupported
Type: boolean
Check whether the terminal support 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
License
MIT © Sindre Sorhus