469 lines
14 KiB
Markdown
469 lines
14 KiB
Markdown
# CLI Color
|
|
|
|
|
|
[](https://github.com/gookit/color/actions)
|
|
[](https://app.codacy.com/app/inhere/color)
|
|
[](https://pkg.go.dev/github.com/gookit/color?tab=overview)
|
|
[](https://github.com/gookit/color)
|
|
[](https://travis-ci.org/gookit/color)
|
|
[](https://coveralls.io/github/gookit/color?branch=master)
|
|
[](https://goreportcard.com/report/github.com/gookit/color)
|
|
|
|
A command-line color library with true color support, universal API methods and Windows support.
|
|
|
|
> **[中文说明](README.zh-CN.md)**
|
|
|
|
Basic color preview:
|
|
|
|
|
|
|
|
Now, 256 colors and RGB colors have also been supported to work in Windows CMD and PowerShell:
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- Simple to use, zero dependencies
|
|
- Supports rich color output: 16-color (4-bit), 256-color (8-bit), true color (24-bit, RGB)
|
|
- 16-color output is the most commonly used and most widely supported, working on any Windows version
|
|
- Since `v1.2.4` **the 256-color (8-bit), true color (24-bit) support windows CMD and PowerShell**
|
|
- See [this gist](https://gist.github.com/XVilka/8346728) for information on true color support
|
|
- Generic API methods: `Print`, `Printf`, `Println`, `Sprint`, `Sprintf`
|
|
- Supports HTML tag-style color rendering, such as `<green>message</>`.
|
|
- In addition to using built-in tags, it also supports custom color attributes
|
|
- Custom color attributes support the use of 16 color names, 256 color values, rgb color values and hex color values
|
|
- Support working on Windows `cmd` and `powerShell` terminal
|
|
- Basic colors: `Bold`, `Black`, `White`, `Gray`, `Red`, `Green`, `Yellow`, `Blue`, `Magenta`, `Cyan`
|
|
- Additional styles: `Info`, `Note`, `Light`, `Error`, `Danger`, `Notice`, `Success`, `Comment`, `Primary`, `Warning`, `Question`, `Secondary`
|
|
- Support by set `NO_COLOR` for disable color or use `FORCE_COLOR` for force open color render.
|
|
- Support Rgb, 256, 16 color conversion
|
|
|
|
## GoDoc
|
|
|
|
- [godoc for gopkg](https://pkg.go.dev/gopkg.in/gookit/color.v1)
|
|
- [godoc for github](https://pkg.go.dev/github.com/gookit/color)
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go get github.com/gookit/color
|
|
```
|
|
|
|
## Quick start
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/gookit/color"
|
|
)
|
|
|
|
func main() {
|
|
// quick use package func
|
|
color.Redp("Simple to use color")
|
|
color.Redln("Simple to use color")
|
|
color.Greenp("Simple to use color\n")
|
|
color.Cyanln("Simple to use color")
|
|
color.Yellowln("Simple to use color")
|
|
|
|
// quick use like fmt.Print*
|
|
color.Red.Println("Simple to use color")
|
|
color.Green.Print("Simple to use color\n")
|
|
color.Cyan.Printf("Simple to use %s\n", "color")
|
|
color.Yellow.Printf("Simple to use %s\n", "color")
|
|
|
|
// use like func
|
|
red := color.FgRed.Render
|
|
green := color.FgGreen.Render
|
|
fmt.Printf("%s line %s library\n", red("Command"), green("color"))
|
|
|
|
// custom color
|
|
color.New(color.FgWhite, color.BgBlack).Println("custom color style")
|
|
|
|
// can also:
|
|
color.Style{color.FgCyan, color.OpBold}.Println("custom color style")
|
|
|
|
// internal theme/style:
|
|
color.Info.Tips("message")
|
|
color.Info.Prompt("message")
|
|
color.Info.Println("message")
|
|
color.Warn.Println("message")
|
|
color.Error.Println("message")
|
|
|
|
// use style tag
|
|
color.Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>\n")
|
|
// Custom label attr: Supports the use of 16 color names, 256 color values, rgb color values and hex color values
|
|
color.Println("<fg=11aa23>he</><bg=120,35,156>llo</>, <fg=167;bg=232>wel</><fg=red>come</>")
|
|
|
|
// apply a style tag
|
|
color.Tag("info").Println("info style text")
|
|
|
|
// prompt message
|
|
color.Info.Prompt("prompt style message")
|
|
color.Warn.Prompt("prompt style message")
|
|
|
|
// tips message
|
|
color.Info.Tips("tips style message")
|
|
color.Warn.Tips("tips style message")
|
|
}
|
|
```
|
|
|
|
Run demo: `go run ./_examples/demo.go`
|
|
|
|
|
|
|
|
## Basic/16 color
|
|
|
|
Supported on any Windows version. Provide generic API methods: `Print`, `Printf`, `Println`, `Sprint`, `Sprintf`
|
|
|
|
```go
|
|
color.Bold.Println("bold message")
|
|
color.Black.Println("bold message")
|
|
color.White.Println("bold message")
|
|
color.Gray.Println("bold message")
|
|
color.Red.Println("yellow message")
|
|
color.Blue.Println("yellow message")
|
|
color.Cyan.Println("yellow message")
|
|
color.Yellow.Println("yellow message")
|
|
color.Magenta.Println("yellow message")
|
|
|
|
// Only use foreground color
|
|
color.FgCyan.Printf("Simple to use %s\n", "color")
|
|
// Only use background color
|
|
color.BgRed.Printf("Simple to use %s\n", "color")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/color_16.go`
|
|
|
|
|
|
|
|
### Custom build color
|
|
|
|
```go
|
|
// Full custom: foreground, background, option
|
|
myStyle := color.New(color.FgWhite, color.BgBlack, color.OpBold)
|
|
myStyle.Println("custom color style")
|
|
|
|
// can also:
|
|
color.Style{color.FgCyan, color.OpBold}.Println("custom color style")
|
|
```
|
|
|
|
custom set console settings:
|
|
|
|
```go
|
|
// set console color
|
|
color.Set(color.FgCyan)
|
|
|
|
// print message
|
|
fmt.Print("message")
|
|
|
|
// reset console settings
|
|
color.Reset()
|
|
```
|
|
|
|
### Additional styles
|
|
|
|
provide generic API methods: `Print`, `Printf`, `Println`, `Sprint`, `Sprintf`
|
|
|
|
print message use defined style:
|
|
|
|
```go
|
|
color.Info.Println("Info message")
|
|
color.Note.Println("Note message")
|
|
color.Notice.Println("Notice message")
|
|
color.Error.Println("Error message")
|
|
color.Danger.Println("Danger message")
|
|
color.Warn.Println("Warn message")
|
|
color.Debug.Println("Debug message")
|
|
color.Primary.Println("Primary message")
|
|
color.Question.Println("Question message")
|
|
color.Secondary.Println("Secondary message")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/theme_basic.go`
|
|
|
|
|
|
|
|
**Tips style**
|
|
|
|
```go
|
|
color.Info.Tips("Info tips message")
|
|
color.Note.Tips("Note tips message")
|
|
color.Notice.Tips("Notice tips message")
|
|
color.Error.Tips("Error tips message")
|
|
color.Danger.Tips("Danger tips message")
|
|
color.Warn.Tips("Warn tips message")
|
|
color.Debug.Tips("Debug tips message")
|
|
color.Primary.Tips("Primary tips message")
|
|
color.Question.Tips("Question tips message")
|
|
color.Secondary.Tips("Secondary tips message")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/theme_tips.go`
|
|
|
|
|
|
|
|
**Prompt Style**
|
|
|
|
```go
|
|
color.Info.Prompt("Info prompt message")
|
|
color.Note.Prompt("Note prompt message")
|
|
color.Notice.Prompt("Notice prompt message")
|
|
color.Error.Prompt("Error prompt message")
|
|
color.Danger.Prompt("Danger prompt message")
|
|
color.Warn.Prompt("Warn prompt message")
|
|
color.Debug.Prompt("Debug prompt message")
|
|
color.Primary.Prompt("Primary prompt message")
|
|
color.Question.Prompt("Question prompt message")
|
|
color.Secondary.Prompt("Secondary prompt message")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/theme_prompt.go`
|
|
|
|
|
|
|
|
**Block Style**
|
|
|
|
```go
|
|
color.Info.Block("Info block message")
|
|
color.Note.Block("Note block message")
|
|
color.Notice.Block("Notice block message")
|
|
color.Error.Block("Error block message")
|
|
color.Danger.Block("Danger block message")
|
|
color.Warn.Block("Warn block message")
|
|
color.Debug.Block("Debug block message")
|
|
color.Primary.Block("Primary block message")
|
|
color.Question.Block("Question block message")
|
|
color.Secondary.Block("Secondary block message")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/theme_block.go`
|
|
|
|
|
|
|
|
## 256-color usage
|
|
|
|
> 256 colors support Windows CMD, PowerShell environment after `v1.2.4`
|
|
|
|
### Set the foreground or background color
|
|
|
|
- `color.C256(val uint8, isBg ...bool) Color256`
|
|
|
|
```go
|
|
c := color.C256(132) // fg color
|
|
c.Println("message")
|
|
c.Printf("format %s", "message")
|
|
|
|
c := color.C256(132, true) // bg color
|
|
c.Println("message")
|
|
c.Printf("format %s", "message")
|
|
```
|
|
|
|
### 256-color style
|
|
|
|
Can be used to set foreground and background colors at the same time.
|
|
|
|
- `S256(fgAndBg ...uint8) *Style256`
|
|
|
|
```go
|
|
s := color.S256(32, 203)
|
|
s.Println("message")
|
|
s.Printf("format %s", "message")
|
|
```
|
|
|
|
with options:
|
|
|
|
```go
|
|
s := color.S256(32, 203)
|
|
s.SetOpts(color.Opts{color.OpBold})
|
|
|
|
s.Println("style with options")
|
|
s.Printf("style with %s\n", "options")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/color_256.go`
|
|
|
|
|
|
|
|
## RGB/True color
|
|
|
|
> RGB colors support Windows `CMD`, `PowerShell` environment after `v1.2.4`
|
|
|
|
**Preview:**
|
|
|
|
> Run demo: `Run demo: go run ./_examples/color_rgb.go`
|
|
|
|
|
|
|
|
example:
|
|
|
|
```go
|
|
color.RGB(30, 144, 255).Println("message. use RGB number")
|
|
|
|
color.HEX("#1976D2").Println("blue-darken")
|
|
color.HEX("#D50000", true).Println("red-accent. use HEX style")
|
|
|
|
color.RGBStyleFromString("213,0,0").Println("red-accent. use RGB number")
|
|
color.HEXStyle("eee", "D50000").Println("deep-purple color")
|
|
```
|
|
|
|
### Set the foreground or background color
|
|
|
|
- `color.RGB(r, g, b uint8, isBg ...bool) RGBColor`
|
|
|
|
```go
|
|
c := color.RGB(30,144,255) // fg color
|
|
c.Println("message")
|
|
c.Printf("format %s", "message")
|
|
|
|
c := color.RGB(30,144,255, true) // bg color
|
|
c.Println("message")
|
|
c.Printf("format %s", "message")
|
|
```
|
|
|
|
Create a style from an hexadecimal color string:
|
|
|
|
- `color.HEX(hex string, isBg ...bool) RGBColor`
|
|
|
|
```go
|
|
c := color.HEX("ccc") // can also: "cccccc" "#cccccc"
|
|
c.Println("message")
|
|
c.Printf("format %s", "message")
|
|
|
|
c = color.HEX("aabbcc", true) // as bg color
|
|
c.Println("message")
|
|
c.Printf("format %s", "message")
|
|
```
|
|
|
|
### RGB color style
|
|
|
|
Can be used to set the foreground and background colors at the same time.
|
|
|
|
- `color.NewRGBStyle(fg RGBColor, bg ...RGBColor) *RGBStyle`
|
|
|
|
```go
|
|
s := color.NewRGBStyle(RGB(20, 144, 234), RGB(234, 78, 23))
|
|
s.Println("message")
|
|
s.Printf("format %s", "message")
|
|
```
|
|
|
|
Create a style from an hexadecimal color string:
|
|
|
|
- `color.HEXStyle(fg string, bg ...string) *RGBStyle`
|
|
|
|
```go
|
|
s := color.HEXStyle("11aa23", "eee")
|
|
s.Println("message")
|
|
s.Printf("format %s", "message")
|
|
```
|
|
|
|
with options:
|
|
|
|
```go
|
|
s := color.HEXStyle("11aa23", "eee")
|
|
s.SetOpts(color.Opts{color.OpBold})
|
|
|
|
s.Println("style with options")
|
|
s.Printf("style with %s\n", "options")
|
|
```
|
|
|
|
## HTML-like tag usage
|
|
|
|
**Supported** on Windows `cmd.exe` `PowerShell` .
|
|
|
|
```go
|
|
// use style tag
|
|
color.Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>")
|
|
color.Println("<suc>hello</>")
|
|
color.Println("<error>hello</>")
|
|
color.Println("<warning>hello</>")
|
|
|
|
// custom color attributes
|
|
color.Print("<fg=yellow;bg=black;op=underscore;>hello, welcome</>\n")
|
|
|
|
// Custom label attr: Supports the use of 16 color names, 256 color values, rgb color values and hex color values
|
|
color.Println("<fg=11aa23>he</><bg=120,35,156>llo</>, <fg=167;bg=232>wel</><fg=red>come</>")
|
|
```
|
|
|
|
- `color.Tag`
|
|
|
|
```go
|
|
// set a style tag
|
|
color.Tag("info").Print("info style text")
|
|
color.Tag("info").Printf("%s style text", "info")
|
|
color.Tag("info").Println("info style text")
|
|
```
|
|
|
|
Run demo: `go run ./_examples/color_tag.go`
|
|
|
|
|
|
|
|
## Color convert
|
|
|
|
Supports conversion between Rgb, 256, 16 colors, `Rgb <=> 256 <=> 16`
|
|
|
|
```go
|
|
basic := color.Red
|
|
basic.Println("basic color")
|
|
|
|
c256 := color.Red.C256()
|
|
c256.Println("256 color")
|
|
c256.C16().Println("basic color")
|
|
|
|
rgb := color.Red.RGB()
|
|
rgb.Println("rgb color")
|
|
rgb.C256().Println("256 color")
|
|
```
|
|
|
|
## Func refer
|
|
|
|
There are some useful functions reference
|
|
|
|
- `Disable()` disable color render
|
|
- `SetOutput(io.Writer)` custom set the colored text output writer
|
|
- `ForceOpenColor()` force open color render
|
|
- `Colors2code(colors ...Color) string` Convert colors to code. return like "32;45;3"
|
|
- `ClearCode(str string) string` Use for clear color codes
|
|
- `ClearTag(s string) string` clear all color html-tag for a string
|
|
- `IsConsole(w io.Writer)` Determine whether w is one of stderr, stdout, stdin
|
|
- `HexToRgb(hex string) (rgb []int)` Convert hex color string to RGB numbers
|
|
- `RgbToHex(rgb []int) string` Convert RGB to hex code
|
|
- More useful func please see https://pkg.go.dev/github.com/gookit/color
|
|
|
|
## Project use
|
|
|
|
Check out these projects, which use https://github.com/gookit/color :
|
|
|
|
- https://github.com/Delta456/box-cli-maker Make Highly Customized Boxes for your CLI
|
|
|
|
## Gookit packages
|
|
|
|
- [gookit/ini](https://github.com/gookit/ini) Go config management, use INI files
|
|
- [gookit/rux](https://github.com/gookit/rux) Simple and fast request router for golang HTTP
|
|
- [gookit/gcli](https://github.com/gookit/gcli) build CLI application, tool library, running CLI commands
|
|
- [gookit/slog](https://github.com/gookit/slog) Concise and extensible go log library
|
|
- [gookit/event](https://github.com/gookit/event) Lightweight event manager and dispatcher implements by Go
|
|
- [gookit/cache](https://github.com/gookit/cache) Generic cache use and cache manager for golang. support File, Memory, Redis, Memcached.
|
|
- [gookit/config](https://github.com/gookit/config) Go config management. support JSON, YAML, TOML, INI, HCL, ENV and Flags
|
|
- [gookit/color](https://github.com/gookit/color) A command-line color library with true color support, universal API methods and Windows support
|
|
- [gookit/filter](https://github.com/gookit/filter) Provide filtering, sanitizing, and conversion of golang data
|
|
- [gookit/validate](https://github.com/gookit/validate) Use for data validation and filtering. support Map, Struct, Form data
|
|
- [gookit/goutil](https://github.com/gookit/goutil) Some utils for the Go: string, array/slice, map, format, cli, env, filesystem, test and more
|
|
- More, please see https://github.com/gookit
|
|
|
|
## See also
|
|
|
|
- [inhere/console](https://github.com/inhere/php-console)
|
|
- [xo/terminfo](https://github.com/xo/terminfo)
|
|
- [beego/bee](https://github.com/beego/bee)
|
|
- [issue9/term](https://github.com/issue9/term)
|
|
- [ANSI escape code](https://en.wikipedia.org/wiki/ANSI_escape_code)
|
|
- [Standard ANSI color map](https://conemu.github.io/en/AnsiEscapeCodes.html#Standard_ANSI_color_map)
|
|
- [Terminal Colors](https://gist.github.com/XVilka/8346728)
|
|
|
|
## License
|
|
|
|
[MIT](/LICENSE)
|