terminal

Documentation

Index

• func ClearLine()
• func EnterAltScreen()
• func ExitAltScreen()
• func NewVerboseWriter(lineHeight int) io.WriteCloser
• func WithAltScreen(fn func() error, header ...string) error

Functions

func ClearLine

func ClearLine()

ClearLine clears the previous line of the terminal

func EnterAltScreen

func EnterAltScreen()

EnterAltScreen switches to the alternate screen buffer. This preserves the main terminal content which can be restored by calling ExitAltScreen.

func ExitAltScreen

func ExitAltScreen()

ExitAltScreen switches back to the main screen buffer, restoring the previous terminal content.

func NewVerboseWriter

func NewVerboseWriter(lineHeight int) io.WriteCloser

NewVerboseWriter creates a new verbose writer. A verbose writer pipes the input received to the stdout while tailing the specified lines. Calling `Close` when done is recommended to clear the last uncleared output.

func WithAltScreen

func WithAltScreen(fn func() error, header ...string) error

WithAltScreen runs the provided function in the alternate screen buffer. The main terminal content is preserved and restored after the function completes. Handles Ctrl-C to ensure the terminal is restored even on interrupt.

If header lines are provided, they are joined with newlines and displayed as a fixed header at the top of the screen. The command output scrolls below the header. The number of header lines is computed automatically based on newlines and terminal width.