terminal

package

v0.5.5 Latest Latest Go to latest Published: Jan 6, 2026 License: MIT Imports: 4 Imported by: 0

Details

Package terminal provides terminal-related utilities.

View Source

const DefaultWidth = 50

DefaultWidth is the default terminal width when detection fails.

View Source

var GetSize = term.GetSize

GetSize returns the terminal width and height for the given file descriptor. This is a variable to allow mocking in tests.

View Source

var IsTTY = isatty.IsTerminal

IsTTY checks if the file descriptor is a TTY. This is a variable to allow mocking in tests.

func GetWidth() int

GetWidth returns the terminal width for stdout. Returns DefaultWidth if detection fails or stdout is not a terminal.

func GetWidthFromWriter(w io.Writer) int

GetWidthFromWriter returns the terminal width for the given writer. Returns DefaultWidth if detection fails or writer is not a terminal.

func IsTerminal() bool

IsTerminal returns true if stdout is a terminal.

func IsTerminalWriter(w io.Writer) bool

IsTerminalWriter returns true if the given writer is a terminal.

type Fder interface {
	Fd() uintptr
}

Fder is an interface for types that have a file descriptor.