{"_id":"terminal-link","_rev":"4103614","name":"terminal-link","description":"Create clickable links in the terminal","dist-tags":{"latest":"5.0.0"},"maintainers":[{"name":"sindresorhus","email":""}],"time":{"modified":"2026-01-11T18:47:02.000Z","created":"2018-04-04T17:35:34.482Z","5.0.0":"2025-09-08T11:27:04.420Z","4.0.0":"2025-03-25T19:11:42.128Z","3.0.0":"2021-04-18T05:36:17.063Z","2.1.1":"2019-12-18T21:39:26.256Z","2.1.0":"2019-12-18T16:52:05.428Z","2.0.0":"2019-09-01T05:07:03.772Z","1.3.0":"2019-04-06T11:22:04.902Z","1.2.0":"2018-12-22T23:42:22.711Z","1.1.0":"2018-04-20T09:27:47.364Z","1.0.0":"2018-04-04T17:35:34.482Z"},"users":{},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"versions":{"5.0.0":{"name":"terminal-link","version":"5.0.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"type":"module","exports":{"types":"./index.d.ts","default":"./index.js"},"sideEffects":false,"engines":{"node":">=20"},"scripts":{"test":"xo && ava && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^7.0.0","supports-hyperlinks":"^4.1.0"},"devDependencies":{"ava":"^6.4.1","tsd":"^0.33.0","xo":"^1.2.2"},"ava":{"serial":true},"_id":"terminal-link@5.0.0","gitHead":"975358c3b5bb99d0f9ac07ff51f692883358f6ab","types":"./index.d.ts","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_nodeVersion":"22.12.0","_npmVersion":"10.9.2","dist":{"shasum":"f0447c8940418ab49b9b9bbc47a4ad2fa8ba81e7","size":2680,"noattachment":false,"key":"/terminal-link/-/terminal-link-5.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-5.0.0.tgz"},"_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"directories":{},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/terminal-link_5.0.0_1757330824218_0.1426954733534147"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-09-08T11:27:04.420Z","publish_time":1757330824420,"_source_registry_name":"default","_cnpm_publish_time":1757330824420},"4.0.0":{"name":"terminal-link","version":"4.0.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"type":"module","exports":{"types":"./index.d.ts","default":"./index.js"},"sideEffects":false,"engines":{"node":">=18"},"scripts":{"//test":"xo && ava && tsd","test":"xo && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^7.0.0","supports-hyperlinks":"^3.2.0"},"devDependencies":{"ava":"^6.2.0","tsd":"^0.31.2","xo":"^0.60.0"},"ava":{"serial":true},"_id":"terminal-link@4.0.0","gitHead":"1fa2892d27f388ea1cf9a2c934470fc94dda2115","types":"./index.d.ts","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_nodeVersion":"23.6.1","_npmVersion":"10.9.2","dist":{"shasum":"5f3e50329420fad97d07d624f7df1851d82963f1","size":2501,"noattachment":false,"key":"/terminal-link/-/terminal-link-4.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-4.0.0.tgz"},"_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"directories":{},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/terminal-link_4.0.0_1742929901949_0.011846698217919283"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-03-25T19:11:42.128Z","publish_time":1742929902128,"_source_registry_name":"default","_cnpm_publish_time":1742929902128},"3.0.0":{"name":"terminal-link","version":"3.0.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"type":"module","exports":"./index.js","engines":{"node":">=12"},"scripts":{"//test":"xo && ava && tsd","test":"xo && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^5.0.0","supports-hyperlinks":"^2.2.0"},"devDependencies":{"ava":"^3.15.0","tsd":"^0.14.0","xo":"^0.38.2"},"ava":{"serial":true},"gitHead":"a925ecd9f2e6975505d801b5e352a05a9ff5921a","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@3.0.0","_nodeVersion":"12.22.1","_npmVersion":"6.14.10","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"91c82a66b52fc1684123297ce384429faf72ac5c","size":2497,"noattachment":false,"key":"/terminal-link/-/terminal-link-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-3.0.0.tgz"},"directories":{},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_3.0.0_1618724176904_0.2766692629835277"},"_hasShrinkwrap":false,"publish_time":1618724177063,"_cnpm_publish_time":1618724177063},"2.1.1":{"name":"terminal-link","version":"2.1.1","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=8"},"scripts":{"test":"xo && ava && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^4.2.1","supports-hyperlinks":"^2.0.0"},"devDependencies":{"ava":"^2.3.0","clear-module":"^4.0.0","tsd":"^0.11.0","xo":"^0.25.3"},"gitHead":"647308d3dc4a67f13eb9b1546d82a508fffa5902","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@2.1.1","_nodeVersion":"10.17.0","_npmVersion":"6.11.3","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"14a64a27ab3c0df933ea546fba55f2d078edc994","size":2539,"noattachment":false,"key":"/terminal-link/-/terminal-link-2.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-2.1.1.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_2.1.1_1576705166069_0.11704365550308271"},"_hasShrinkwrap":false,"publish_time":1576705166256,"_cnpm_publish_time":1576705166256},"2.1.0":{"name":"terminal-link","version":"2.1.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=8"},"scripts":{"test":"xo && ava && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^4.2.1","supports-hyperlinks":"^2.0.0"},"devDependencies":{"ava":"^2.3.0","clear-module":"^4.0.0","tsd":"^0.11.0","xo":"^0.25.3"},"gitHead":"0ae83a20f62a9661b4a8be2e4ad8c8e66c3e602f","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@2.1.0","_nodeVersion":"10.17.0","_npmVersion":"6.13.4","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"19eb4742599d667d3c00f77bde6a74a25bebdc5e","size":2532,"noattachment":false,"key":"/terminal-link/-/terminal-link-2.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-2.1.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_2.1.0_1576687925304_0.5159822599894412"},"_hasShrinkwrap":false,"publish_time":1576687925428,"_cnpm_publish_time":1576687925428},"2.0.0":{"name":"terminal-link","version":"2.0.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=8"},"scripts":{"test":"xo && ava && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^4.2.1","supports-hyperlinks":"^2.0.0"},"devDependencies":{"ava":"^2.3.0","clear-module":"^4.0.0","tsd":"^0.7.4","xo":"^0.24.0"},"gitHead":"10072b83148a3168257a8f5a880d10b876a7b87d","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@2.0.0","_nodeVersion":"10.16.0","_npmVersion":"6.10.3","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"daa5d9893d57d3a09f981e1a45be37daba3f0ce6","size":2374,"noattachment":false,"key":"/terminal-link/-/terminal-link-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-2.0.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_2.0.0_1567314423651_0.5049925957040202"},"_hasShrinkwrap":false,"publish_time":1567314423772,"_cnpm_publish_time":1567314423772},"1.3.0":{"name":"terminal-link","version":"1.3.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=6"},"scripts":{"test":"xo && ava && tsd"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^3.2.0","supports-hyperlinks":"^1.0.1"},"devDependencies":{"ava":"^1.4.1","clear-module":"^3.1.0","tsd":"^0.7.2","xo":"^0.24.0"},"gitHead":"b4d0553c060ee329fa82caf5984bdc6e672b0f48","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@1.3.0","_npmVersion":"6.4.1","_nodeVersion":"10.15.1","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"3e9a308289e13340053aaf40e8f1a06d1335646e","size":2247,"noattachment":false,"key":"/terminal-link/-/terminal-link-1.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-1.3.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_1.3.0_1554549724800_0.610908596384627"},"_hasShrinkwrap":false,"publish_time":1554549724902,"_cnpm_publish_time":1554549724902},"1.2.0":{"name":"terminal-link","version":"1.2.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=6"},"scripts":{"test":"xo && ava && tsd-check"},"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^3.1.0","supports-hyperlinks":"^1.0.1"},"devDependencies":{"ava":"^1.0.1","clear-module":"^3.0.0","tsd-check":"^0.2.1","xo":"^0.23.0"},"gitHead":"543f19078365d2c1c5f4af8e831247f72a8c9cb0","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@1.2.0","_npmVersion":"6.4.1","_nodeVersion":"10.13.0","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"ed1ac495da75a8c3eadc8a5db985226e451edffd","size":2132,"noattachment":false,"key":"/terminal-link/-/terminal-link-1.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-1.2.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_1.2.0_1545522142607_0.7064849736088123"},"_hasShrinkwrap":false,"publish_time":1545522142711,"_cnpm_publish_time":1545522142711},"1.1.0":{"name":"terminal-link","version":"1.1.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=6"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^3.1.0","supports-hyperlinks":"^1.0.1"},"devDependencies":{"ava":"*","clear-module":"^2.1.0","xo":"*"},"gitHead":"a67125cef86d5fe60a5e6a8bf7a43c03795884a4","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@1.1.0","_npmVersion":"5.6.0","_nodeVersion":"8.10.0","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"8573e830db810baa62ce67859c1f102e88fa4318","size":1953,"noattachment":false,"key":"/terminal-link/-/terminal-link-1.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-1.1.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_1.1.0_1524216467232_0.07764757997577831"},"_hasShrinkwrap":false,"publish_time":1524216467364,"_cnpm_publish_time":1524216467364},"1.0.0":{"name":"terminal-link","version":"1.0.0","description":"Create clickable links in the terminal","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/terminal-link.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=6"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["link","hyperlink","url","ansi","escape","terminal","term","console","command-line"],"dependencies":{"ansi-escapes":"^3.1.0","supports-hyperlinks":"^1.0.1"},"devDependencies":{"ava":"*","clear-module":"^2.1.0","xo":"*"},"gitHead":"59bf01d54c968967341fa80683a6dab6cd9e8c23","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"homepage":"https://github.com/sindresorhus/terminal-link#readme","_id":"terminal-link@1.0.0","_npmVersion":"5.6.0","_nodeVersion":"8.10.0","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"f067ee2b2d58ba2f31b077705af1c3557f9bc336","size":1879,"noattachment":false,"key":"/terminal-link/-/terminal-link-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/terminal-link/download/terminal-link-1.0.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-link_1.0.0_1522863334415_0.8974874446848509"},"_hasShrinkwrap":false,"publish_time":1522863334482,"_cnpm_publish_time":1522863334482}},"readme":"# terminal-link\n\n> Create clickable links in the terminal\n\n<img src=\"screenshot.gif\" width=\"301\" height=\"148\">\n\n## Install\n\n```sh\nnpm install terminal-link\n```\n\n## Usage\n\n```js\nimport terminalLink from 'terminal-link';\n\nconst link = terminalLink('My Website', 'https://sindresorhus.com');\nconsole.log(link);\n```\n\n## API\n\n### terminalLink(text, url, options?)\n\nCreate a link for use in stdout.\n\n[Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)\n\nFor unsupported terminals, by default the link will be printed as plain text with a space separator: `My website https://sindresorhus.com`.\n\n#### text\n\nType: `string`\n\nText to linkify.\n\n#### url\n\nType: `string`\n\nURL to link to.\n\n#### options\n\nType: `object`\n\n##### fallback\n\nType: `function | boolean`\n\nOverride the default fallback. The function receives the `text` and `url` as parameters and is expected to return a string.\n\nIf set to `false`, the `text` will be returned as-is when a terminal is unsupported.\n\n### terminalLink.isSupported\n\nType: `boolean`\n\nCheck whether the terminal's stdout supports links.\n\nPrefer just using the default fallback or the `fallback` option whenever possible.\n\n### terminalLink.stderr(text, url, options?)\n\nCreate a link for use in stderr.\n\nSame arguments as `terminalLink()`.\n\n### terminalLink.stderr.isSupported\n\nType: `boolean`\n\nCheck whether the terminal's stderr supports links.\n\nPrefer just using the default fallback or the `fallback` option whenever possible.\n\n## Related\n\n- [terminal-link-cli](https://github.com/sindresorhus/terminal-link-cli) - CLI for this module\n- [ink-link](https://github.com/sindresorhus/ink-link) - Link component for Ink\n- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right\n","_attachments":{},"homepage":"https://github.com/sindresorhus/terminal-link#readme","bugs":{"url":"https://github.com/sindresorhus/terminal-link/issues"},"license":"MIT"}