Skip to content
Golang ultimate ANSI-colors that supports Printf/Sprintf methods
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore rid out off sync.Pool; little optimisations; improved benchmarks; add… Nov 8, 2016
.travis.yml fix LICENSE, improve .travis.yml Apr 19, 2018
AUTHORS.md Add Sevenate to the Authors list. Aug 3, 2019
CHANGELOG.md improve CHANGELOG, fix README to new release Apr 17, 2019
LICENSE fix LICENSE, improve .travis.yml Apr 19, 2018
README.md fix typo in readme Jan 2, 2020
aurora.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
aurora_black_standard.png remove v1 images, add v2 images Apr 17, 2019
aurora_colors_black.png remove v1 images, add v2 images Apr 17, 2019
aurora_colors_white.png remove v1 images, add v2 images Apr 17, 2019
aurora_formats.gif remove v1 images, add v2 images Apr 17, 2019
aurora_grayscale.png remove v1 images, add v2 images Apr 17, 2019
aurora_rarely_supported.png remove v1 images, add v2 images Apr 17, 2019
aurora_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
aurora_white_standard.png remove v1 images, add v2 images Apr 17, 2019
bench_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
color.go fix documetation for golint, split (Color).appendNos method to reduce… Apr 17, 2019
color_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
disable.png Init Nov 6, 2016
enable.png Init Nov 6, 2016
example_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
gopher_aurora.png Init Nov 6, 2016
printf.png Init Nov 6, 2016
simple.png Init Nov 6, 2016
sprintf.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
sprintf.png Init Nov 6, 2016
sprintf_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
value.go fix documetation for golint, split (Color).appendNos method to reduce… Apr 17, 2019
value_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019
wrap.go fix documetation for golint, split (Color).appendNos method to reduce… Apr 17, 2019
wrap_test.go add note to changelog, rewrite copyrithts headings Apr 17, 2019

README.md

Aurora

GoDoc WTFPL License Build Status Coverage Status GoReportCard Gitter

Ultimate ANSI colors for Golang. The package supports Printf/Sprintf etc.

aurora logo

TOC

Installation

Get

go get -u github.com/logrusorgru/aurora

Test

go test -cover github.com/logrusorgru/aurora

Usage

Simple

package main

import (
	"fmt"

	. "github.com/logrusorgru/aurora"
)

func main() {
	fmt.Println("Hello,", Magenta("Aurora"))
	fmt.Println(Bold(Cyan("Cya!")))
}

simple png

Printf

package main

import (
	"fmt"

	. "github.com/logrusorgru/aurora"
)

func main() {
	fmt.Printf("Got it %d times\n", Green(1240))
	fmt.Printf("PI is %+1.2e\n", Cyan(3.14))
}

printf png

aurora.Sprintf

package main

import (
	"fmt"

	. "github.com/logrusorgru/aurora"
)

func main() {
	fmt.Println(Sprintf(Magenta("Got it %d times"), Green(1240)))
}

sprintf png

Enable/Disable colors

package main

import (
	"fmt"
	"flag"

	"github.com/logrusorgru/aurora"
)

// colorizer
var au aurora.Aurora

var colors = flag.Bool("colors", false, "enable or disable colors")

func init() {
	flag.Parse()
	au = aurora.NewAurora(*colors)
}

func main() {
	// use colorizer
	fmt.Println(au.Green("Hello"))
}

Without flags: disable png

With -colors flag: enable png

Chains

The following samples are equal

x := BgMagenta(Bold(Red("x")))
x := Red("x").Bold().BgMagenta()

The second is more readable

Colorize

There is Colorize function that allows to choose some colors and format from a side

func getColors() Color {
	// some stuff that returns appropriate colors and format
}

// [...]

func main() {
	fmt.Println(Colorize("Greeting", getColors()))
}

Less complicated example

x := Colorize("Greeting", GreenFg|GrayBg|BoldFm)

Unlike other color functions and methods (such as Red/BgBlue etc) a Colorize clears previous colors

x := Red("x").Colorize(BgGreen) // will be with green background only

Grayscale

fmt.Println("  ",
	Gray(1-1, " 00-23 ").BgGray(24-1),
	Gray(4-1, " 03-19 ").BgGray(20-1),
	Gray(8-1, " 07-15 ").BgGray(16-1),
	Gray(12-1, " 11-11 ").BgGray(12-1),
	Gray(16-1, " 15-07 ").BgGray(8-1),
	Gray(20-1, " 19-03 ").BgGray(4-1),
	Gray(24-1, " 23-00 ").BgGray(1-1),
)

grayscale png

8-bit colors

Methods Index and BgIndex implements 8-bit colors.

Index/BgIndex Meaning Foreground Background
0- 7 standard colors 30- 37 40- 47
8- 15 bright colors 90- 97 100-107
16-231 216 colors 38;5;n 48;5;n
232-255 24 grayscale 38;5;n 48;5;n

Supported colors & formats

  • formats
    • bold (1)
    • faint (2)
    • doubly-underline (21)
    • fraktur (20)
    • italic (3)
    • underline (4)
    • slow blink (5)
    • rapid blink (6)
    • reverse video (7)
    • conceal (8)
    • crossed out (9)
    • framed (51)
    • encircled (52)
    • overlined (53)
  • background and foreground colors, including bright
    • black
    • red
    • green
    • yellow (brown)
    • blue
    • magenta
    • cyan
    • white
    • 24 grayscale colors
    • 216 8-bit colors

All colors

linux png
white png

Standard and bright colors

linux black standard png linux white standard png

Formats are likely supported

formats supported gif

Formats are likely unsupported

formats rarely supported png

Limitations

There is no way to represent %T and %p with colors using a standard approach

package main

import (
	"fmt"

	. "github.com/logrusorgru/aurora"
)

func main() {
	r := Red("red")
	var i int
	fmt.Printf("%T %p\n", r, Green(&i))
}

Output will be without colors

aurora.value %!p(aurora.value={0xc42000a310 768 0})

The obvious workaround is Red(fmt.Sprintf("%T", some))

Windows

The Aurora provides ANSI colors only, so there is no support for Windows. That said, there are workarounds available. Check out these comments to learn more:

TTY

The Aurora has no internal TTY detectors by design. Take a look this comment if you want turn on colors for a terminal only, and turn them off for a file.

Licensing

Copyright © 2016-2019 The Aurora Authors. This work is free. It comes without any warranty, to the extent permitted by applicable law. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the LICENSE file for more details.

You can’t perform that action at this time.