mpldr / go-ansi

Write pretty terminal output the easy way.

go-ansi

import "mpldr.codes/ansi"

Write pretty terminal output the easy way.

Want your text green? ansi.Green("I am Shrek")

Want it black on a red ground? ansi.RedBG(ansi.Black("You can just combine them"))

Moving around is as simple as Specifying a direction ansi.Up()

ANSI Support¹

• movement
• line operations (clearing lines)
• fore- and background colour
• formatting (bold, italic, strikethrough, …)
• stripping ANSI-Codes
• links (even to files)
• notifications

¹) support depends on the terminal emulator used and configuration

User Choice

This library implements the (informal) NO_COLOR standard. This disables all colour-related ANSI-Codes but does not restrict any other function (like cursor movement or formatting). If this behavior is unwanted please stay on version 1.3.0 or below.

Bugs Reports & Feature Requests

Bug Reports and Feature Requests can be sent to the issue tracker or via email to ~poldi1405/[e-mail] (possible without creating an account on Sourcehut).

Patches

Want to improve it yourself? Awesome! Please send your patches to ~poldi1405/[e-mail] (see submitted patches here).

For an easy quickstart, just run these commands:

$ git config format.subjectPrefix "PATCH go-ansi"
$ git config sendemail.to "~poldi1405/[e-mail]"

Please sign-off your Commits to confirm the DCO.

License

This library is licensed under the MIT License which can be found here.