termenv

The output.Profile property returns the detected color capabilities of the terminal. termenv automatically degrades colors to the best matching available profile if the terminal has limited support:

TrueColor (24-bit RGB) => ANSI256 => ANSI (16 colors) => Ascii (no ANSI support).

Available profiles:

• termenv.Ascii: No ANSI support detected.
• termenv.ANSI: 16 color ANSI support.
• termenv.ANSI256: Extended 256 color ANSI support.
• termenv.TrueColor: RGB/TrueColor support.

To respect environment variables like NO_COLOR and CLICOLOR_FORCE, use termenv.EnvColorProfile instead of the standard detection.

While Unix systems support ANSI styling by default, Windows requires you to explicitly enable Virtual Terminal Processing. Use termenv.EnableVirtualTerminalProcessing to ensure your terminal application can process ANSI sequences. This method is safe to call on non-Windows systems or when the output is not a terminal (e.g., during testing).

    restoreConsole, err := termenv.EnableVirtualTerminalProcessing(termenv.DefaultOutput())
    if err != nil {
        panic(err)
    }
    defer restoreConsole()

You can change the terminal's background color by sending an ANSI escape sequence containing the desired hex color code. The format is \033]11;#RRGGBB\007.

echo -ne "\033]11;#00ff00\007"

To request the terminal to report the current cursor position, send the ANSI escape sequence \033[6n.

echo -ne "\033[6n"

To enable bracketed paste mode (which wraps pasted text in 200~ and 201~ codes to distinguish it from manual typing), send the sequence \033[?2004h.

echo -ne "\033[?2004h" && sleep 10

You can set the terminal window title by sending the sequence \033]2;TITLE\007.

echo -ne "\033]2;Test\007" && sleep 10

To use termenv in your Go project, install it using go get:

go get github.com/muesli/termenv

To start using termenv, create a new output instance targeting a writer (usually os.Stdout). This instance provides the API for styling, positioning, and terminal control.

output := termenv.NewOutput(os.Stdout)

You can change the terminal's cursor color by sending an ANSI escape sequence containing the desired hex color code. The format is \033]12;#RRGGBB\007.

echo -ne "\033]12;#ff0000\007"

You can change the terminal's foreground color by sending an ANSI escape sequence containing the desired hex color code. The format is \033]10;#RRGGBB\007.

echo -ne "\033]10;#0000ff\007"