termlink

termlink

Clickable links in the terminal for Go

^*

Termlink is a Go package that allows you to create fully customizable clickable links in the terminal. It is the Go version of Sindre Sorhus' popular terminal-link library.

It includes multiple features including dynamic and fully customizable colored links in terminal.

🛠️ Install

Using go get:

go get github.com/savioxavier/termlink

🔗 Usage

• Basic regular link:

import (
	"fmt"

	"github.com/savioxavier/termlink"
)

func main() {
	fmt.Println(termlink.Link("Example", "https://example.com"))
}

• Customizable colored link:

import (
	"fmt"

	"github.com/savioxavier/termlink"
)

func main() {
	fmt.Println(termlink.ColorLink("Example", "https://example.com", "italic green"))
}

• You can also use this package in combination with another popular Go package fatih/color

import (
	"fmt"

	"github.com/fatih/color"
	"github.com/savioxavier/termlink"
)

func main() {
	// With fatih/color package
	color.Cyan(termlink.Link("Example link using the colors package", "https://example.com"))
}

Note: For unsupported terminals, the link will be printed in parentheses after the text (see below image)

🍵 Examples

More examples can be found in the examples/ directory.

🔮 Features

• termlink.Link(text, url, [shouldForce])

  • Creates a regular, clickable link in the terminal
  • For unsupported terminals, the link will be printed in parentheses after the text: Example Link (https://example.com).
  • The shouldForce is an optional boolean parameter which allows you to force the above unsupported terminal hyperlinks format text (url) to be printed, even in supported terminals

• termlink.ColorLink(text, url, color, [shouldForce])

  • Creates a clickable link in the terminal with custom color formatting
  • Examples of color options include:
    • Foreground only: green, red, blue, etc.
    • Background only: bgGreen, bgRed, bgBlue, etc.
    • Foreground and background: green bgRed, bgBlue red, etc.
    • With formatting: green bold, red bgGreen italic, italic blue bgGreen, etc.
  • The shouldForce is an optional boolean parameter which allows you to force the above unsupported terminal hyperlinks format text (url) to be printed, even in supported terminals

• termlink.SupportsHyperlinks():

  • Returns true if the terminal supports hyperlinks, false otherwise.

🧪 Tests

You can run unit tests locally by running the following command

go test -v

Tests can be found in termlink_test.go

❤️ Support

You can support further development of this project by giving it a 🌟 and help me make even better stuff in the future by buying me a ☕

Also, if you liked this repo, consider checking out my other projects, that would be real cool!

💫 Attributions and special thanks

• terminal-link - Sindre Sorhus' original package for providing inspiration for this package.
• go-supportscolor - A package for detecting terminal color support.

_{^{* The paperclip icon shown in the demo at the top of this README isn't included when you create the link, it's purely for decorative purposes only.}}