terminal

Documentation

Overview

Package terminal provides VT100 terminal codes and a windows implementation of that.

Index

• Constants
• Variables
• func EnableColorsStdout()
• func GetSize() (w, h int)
• func HideConsole()
• func IsTerminal(fd int) bool
• func ReadPassword(fd int) ([]byte, error)
• func Start()
• func Write(out []byte)
• func WriteString(s string)
• func WriteTerminalTitle(title string)

Constants

const (
	EraseLine         = "\x1b[2K"
	MoveToStartOfLine = "\x1b[1G"
	MoveUp            = "\x1b[1A"

	Reset      = "\x1b[0m"
	Bright     = "\x1b[1m"
	Dim        = "\x1b[2m"
	Underscore = "\x1b[4m"
	Blink      = "\x1b[5m"
	Reverse    = "\x1b[7m"
	Hidden     = "\x1b[8m"

	BlackFg   = "\x1b[30m"
	RedFg     = "\x1b[31m"
	GreenFg   = "\x1b[32m"
	YellowFg  = "\x1b[33m"
	BlueFg    = "\x1b[34m"
	MagentaFg = "\x1b[35m"
	CyanFg    = "\x1b[36m"
	WhiteFg   = "\x1b[37m"

	BlackBg   = "\x1b[40m"
	RedBg     = "\x1b[41m"
	GreenBg   = "\x1b[42m"
	YellowBg  = "\x1b[43m"
	BlueBg    = "\x1b[44m"
	MagentaBg = "\x1b[45m"
	CyanBg    = "\x1b[46m"
	WhiteBg   = "\x1b[47m"

	HiBlackFg   = "\x1b[90m"
	HiRedFg     = "\x1b[91m"
	HiGreenFg   = "\x1b[92m"
	HiYellowFg  = "\x1b[93m"
	HiBlueFg    = "\x1b[94m"
	HiMagentaFg = "\x1b[95m"
	HiCyanFg    = "\x1b[96m"
	HiWhiteFg   = "\x1b[97m"

	HiBlackBg   = "\x1b[100m"
	HiRedBg     = "\x1b[101m"
	HiGreenBg   = "\x1b[102m"
	HiYellowBg  = "\x1b[103m"
	HiBlueBg    = "\x1b[104m"
	HiMagentaBg = "\x1b[105m"
	HiCyanBg    = "\x1b[106m"
	HiWhiteBg   = "\x1b[107m"

	ChangeTitle = "\033]0;"
	BEL         = "\007"
)

VT100 codes

Variables

var Out io.Writer

Out is an io.Writer which can be used to write to the terminal e.g. for use with fmt.Fprintf(terminal.Out, "terminal fun: %d\n", n)

Functions

func EnableColorsStdout

func EnableColorsStdout()

EnableColorsStdout enable colors if possible. This enables virtual terminal processing on Windows 10 console, adding native support for VT100 escape codes. When this terminal package is used for output, the result is that the colorable library don't have to decode the escapes and explicitely write text with color formatting to the console using Windows API functions, but can simply relay everything to stdout.

func GetSize

func GetSize() (w, h int)

GetSize reads the dimensions of the current terminal or returns a sensible default

func HideConsole

func HideConsole()

HideConsole is only supported on windows

func IsTerminal

func IsTerminal(fd int) bool

IsTerminal returns whether the fd passed in is a terminal or not

func ReadPassword

func ReadPassword(fd int) ([]byte, error)

ReadPassword reads a line of input from a terminal without local echo. This is commonly used for inputting passwords and other sensitive data. The slice returned does not include the \n.

func Start

func Start()

Start the terminal - must be called before use

func Write

func Write(out []byte)

Write sends out to the VT100 terminal. It will initialise the terminal if this is the first call.

func WriteString

func WriteString(s string)

WriteString writes the string passed in to the terminal

func WriteTerminalTitle

func WriteTerminalTitle(title string)

WriteTerminalTitle writes a string to the terminal title