tty

Documentation

Overview

Package tty provides utilities for TTY (terminal) detection. This package uses golang.org/x/term for TTY detection, which aligns with modern Go best practices and the spinner library v1.23.1+ implementation.

Index

• func IsInteractiveTerminal() bool
• func IsRunningInContainer() bool
• func IsStderrTerminal() bool
• func IsStdoutTerminal() bool
• func StderrTerminalWidth() (int, bool)

Functions

func IsInteractiveTerminal

func IsInteractiveTerminal() bool

IsInteractiveTerminal returns true if the process is running in an interactive terminal context: stderr is a terminal and the process is not running inside a container.

func IsRunningInContainer

func IsRunningInContainer() bool

IsRunningInContainer detects if the current process is running inside a container. Note: This package cannot use the logger package to avoid import cycles, since logger imports tty for terminal detection.

func IsStderrTerminal

func IsStderrTerminal() bool

IsStderrTerminal returns true if stderr is connected to a terminal.

func IsStdoutTerminal

func IsStdoutTerminal() bool

IsStdoutTerminal returns true if stdout is connected to a terminal.

func StderrTerminalWidth

func StderrTerminalWidth() (int, bool)

StderrTerminalWidth returns the width of the terminal connected to stderr and true if successful. Returns 0 and false if stderr is not a terminal or the width cannot be determined.