tty

Documentation

Overview

Package tty provides methods for working with TTY

Index

• func GetHeight() int
• func GetSize() (int, int)
• func GetWidth() int
• func IsFakeTTY() bool
• func IsSystemd() bool
• func IsTMUX() (bool, error)
• func IsTTY() bool

Examples

• GetHeight
• GetSize
• GetWidth
• IsSystemd
• IsTMUX
• IsTTY

Functions

func GetHeight

func GetHeight() int

GetHeight returns window height

Example

height := GetHeight()

if height == -1 {
	fmt.Println("Can't detect window size")
	return
}

fmt.Printf("Window height: %d\n", height)

func GetSize

func GetSize() (int, int)

GetSize returns window width and height

Example

width, height := GetSize()

if width == -1 && height == -1 {
	fmt.Println("Can't detect window size")
	return
}

fmt.Printf("Window size: %d x %d\n", width, height)

func GetWidth

func GetWidth() int

GetWidth returns window width

Example

width := GetWidth()

if width == -1 {
	fmt.Println("Can't detect window size")
	return
}

fmt.Printf("Window width: %d\n", width)

func IsFakeTTY

func IsFakeTTY() bool

IsFakeTTY returns true is fake TTY is used

func IsSystemd

func IsSystemd() bool

IsSystemd returns true if process started by systemd

Example

if IsSystemd() {
	fmt.Println("This process started by systemd")
}

func IsTMUX

func IsTMUX() (bool, error)

IsTMUX returns true if we are currently working in tmux

Example

isTmux, err := IsTMUX()

if err != nil {
	panic(err.Error())
}

if isTmux {
	fmt.Println("App works in tmux")
} else {
	fmt.Println("App works in bare terminal")
}

func IsTTY

func IsTTY() bool

IsTTY returns true if current output device is TTY

Example

if IsTTY() {
	fmt.Println("Output is TTY")
} else {
	fmt.Println("Output is not TTY")
}