package core:encoding/ansi
Source

⌘K
Ctrl+K
or
/

    Overview

    package ansi implements constant references to many widely-supported ANSI escape codes, primarily used in terminal emulators for enhanced graphics, such as colors, text styling, and animated displays.

    For example, you can print out a line of cyan text like this:

    fmt.println(ansi.CSI + ansi.FG_CYAN + ansi.SGR + "Hellope!" + ansi.CSI + ansi.RESET + ansi.SGR)

    Multiple SGR (Select Graphic Rendition) codes can be joined by semicolons:

    fmt.println(ansi.CSI + ansi.BOLD + ";" + ansi.FG_BLUE + ansi.SGR + "Hellope!" + ansi.CSI + ansi.RESET + ansi.SGR)

    If your terminal supports 24-bit true color mode, you can also do this:

    fmt.println(ansi.CSI + ansi.FG_COLOR_24_BIT + ";0;255;255" + ansi.SGR + "Hellope!" + ansi.CSI + ansi.RESET + ansi.SGR)

    For more information, see: https://en.wikipedia.org/wiki/ANSI_escape_code https://www.vt100.net/docs/vt102-ug/chapter5.html https://invisible-island.net/xterm/ctlseqs/ctlseqs.html

    Types

    This section is empty.

    Constants

    AUX_OFF ¶
    Source

    AUX_OFF: string : "4i"
     

    AUX Port Off

    AUX_ON ¶
    Source

    AUX_ON: string : "5i"
     

    AUX Port On

    BEL ¶
    Source

    BEL: string : "\a"
     

    Bell

    BG_BLACK ¶
    Source

    BG_BLACK: string : "40"

    BG_BLUE ¶
    Source

    BG_BLUE: string : "44"

    BG_BRIGHT_BLACK ¶
    Source

    BG_BRIGHT_BLACK: string : "100"
     

    Also known as grey.

    BG_BRIGHT_BLUE ¶
    Source

    BG_BRIGHT_BLUE: string : "104"

    BG_BRIGHT_CYAN ¶
    Source

    BG_BRIGHT_CYAN: string : "106"

    BG_BRIGHT_GREEN ¶
    Source

    BG_BRIGHT_GREEN: string : "102"

    BG_BRIGHT_MAGENTA ¶
    Source

    BG_BRIGHT_MAGENTA: string : "105"

    BG_BRIGHT_RED ¶
    Source

    BG_BRIGHT_RED: string : "101"

    BG_BRIGHT_WHITE ¶
    Source

    BG_BRIGHT_WHITE: string : "107"

    BG_BRIGHT_YELLOW ¶
    Source

    BG_BRIGHT_YELLOW: string : "103"

    BG_COLOR ¶
    Source

    BG_COLOR: string : "48"

    BG_COLOR_24_BIT ¶
    Source

    BG_COLOR_24_BIT: string : "48;2"
     

    Followed by ";r;g;b" where r,g,b are in 0..=255

    BG_COLOR_8_BIT ¶
    Source

    BG_COLOR_8_BIT: string : "48;5"
     

    Followed by ";n" where n is in 0..=255

    BG_CYAN ¶
    Source

    BG_CYAN: string : "46"

    BG_DEFAULT ¶
    Source

    BG_DEFAULT: string : "49"

    BG_GREEN ¶
    Source

    BG_GREEN: string : "42"

    BG_MAGENTA ¶
    Source

    BG_MAGENTA: string : "45"

    BG_RED ¶
    Source

    BG_RED: string : "41"

    BG_WHITE ¶
    Source

    BG_WHITE: string : "47"

    BG_YELLOW ¶
    Source

    BG_YELLOW: string : "43"
    BLINK_RAPID: string : "6"
     

    Not widely supported.

    BLINK_SLOW: string : "5"

    BOLD ¶
    Source

    BOLD: string : "1"

    BS ¶
    Source

    BS: string : "\b"
     

    Backspace

    CHA ¶
    Source

    CHA: string : "G"
     

    Cursor Horizontal Absolute

    CLIPBOARD ¶
    Source

    CLIPBOARD: string : "52"
     

    Followed by ";c;<Base64-encoded string>" ST.

    CNL ¶
    Source

    CNL: string : "E"
     

    Cursor Next Line

    CPL ¶
    Source

    CPL: string : "F"
     

    Cursor Previous Line

    CSI ¶
    Source

    CSI: string : ESC + "["
     

    Control Sequence Introducer

    CUB ¶
    Source

    CUB: string : "D"
     

    Cursor Back

    CUD ¶
    Source

    CUD: string : "B"
     

    Cursor Down

    CUF ¶
    Source

    CUF: string : "C"
     

    Cursor Forward

    CUP ¶
    Source

    CUP: string : "H"
     

    Cursor Position

    CUU ¶
    Source

    CUU: string : "A"
     

    Cursor Up

    DECAWM_OFF ¶
    Source

    DECAWM_OFF: string : "?7l"
     

    Auto Wrap Mode (Disabled)

    DECAWM_ON ¶
    Source

    DECAWM_ON: string : "?7h"
     

    Auto Wrap Mode (Enabled)

    DECRC ¶
    Source

    DECRC: string : ESC + "8"
     

    DEC Restore Cursor

    DECSC ¶
    Source

    DECSC: string : ESC + "7"
     

    DEC Save Cursor

    DECTCEM_HIDE ¶
    Source

    DECTCEM_HIDE: string : "?25l"
     

    Text Cursor Enable Mode (Invisible)

    DECTCEM_SHOW ¶
    Source

    DECTCEM_SHOW: string : "?25h"
     

    Text Cursor Enable Mode (Visible)

    DSR ¶
    Source

    DSR: string : "6n"
     

    Device Status Report

    ED ¶
    Source

    ED: string : "J"
     

    Erase in Display

    EL ¶
    Source

    EL: string : "K"
     

    Erase in Line

    ENCIRCLED ¶
    Source

    ENCIRCLED: string : "52"

    ESC ¶
    Source

    ESC: string : "\e"
     

    Escape

    FAINT ¶
    Source

    FAINT: string : "2"

    FG_BLACK ¶
    Source

    FG_BLACK: string : "30"

    FG_BLUE ¶
    Source

    FG_BLUE: string : "34"

    FG_BRIGHT_BLACK ¶
    Source

    FG_BRIGHT_BLACK: string : "90"
     

    Also known as grey.

    FG_BRIGHT_BLUE ¶
    Source

    FG_BRIGHT_BLUE: string : "94"

    FG_BRIGHT_CYAN ¶
    Source

    FG_BRIGHT_CYAN: string : "96"

    FG_BRIGHT_GREEN ¶
    Source

    FG_BRIGHT_GREEN: string : "92"

    FG_BRIGHT_MAGENTA ¶
    Source

    FG_BRIGHT_MAGENTA: string : "95"

    FG_BRIGHT_RED ¶
    Source

    FG_BRIGHT_RED: string : "91"

    FG_BRIGHT_WHITE ¶
    Source

    FG_BRIGHT_WHITE: string : "97"

    FG_BRIGHT_YELLOW ¶
    Source

    FG_BRIGHT_YELLOW: string : "93"

    FG_COLOR ¶
    Source

    FG_COLOR: string : "38"

    FG_COLOR_24_BIT ¶
    Source

    FG_COLOR_24_BIT: string : "38;2"
     

    Followed by ";r;g;b" where r,g,b are in 0..=255

    FG_COLOR_8_BIT ¶
    Source

    FG_COLOR_8_BIT: string : "38;5"
     

    Followed by ";n" where n is in 0..=255

    FG_CYAN ¶
    Source

    FG_CYAN: string : "36"

    FG_DEFAULT ¶
    Source

    FG_DEFAULT: string : "39"

    FG_GREEN ¶
    Source

    FG_GREEN: string : "32"

    FG_MAGENTA ¶
    Source

    FG_MAGENTA: string : "35"

    FG_RED ¶
    Source

    FG_RED: string : "31"

    FG_WHITE ¶
    Source

    FG_WHITE: string : "37"

    FG_YELLOW ¶
    Source

    FG_YELLOW: string : "33"

    FONT_ALT1 ¶
    Source

    FONT_ALT1: string : "11"

    FONT_ALT2 ¶
    Source

    FONT_ALT2: string : "12"

    FONT_ALT3 ¶
    Source

    FONT_ALT3: string : "13"

    FONT_ALT4 ¶
    Source

    FONT_ALT4: string : "14"

    FONT_ALT5 ¶
    Source

    FONT_ALT5: string : "15"

    FONT_ALT6 ¶
    Source

    FONT_ALT6: string : "16"

    FONT_ALT7 ¶
    Source

    FONT_ALT7: string : "17"

    FONT_ALT8 ¶
    Source

    FONT_ALT8: string : "18"

    FONT_ALT9 ¶
    Source

    FONT_ALT9: string : "19"

    FONT_FRAKTUR ¶
    Source

    FONT_FRAKTUR: string : "20"
     

    Rarely supported.

    FONT_PRIMARY ¶
    Source

    FONT_PRIMARY: string : "10"

    FRAMED ¶
    Source

    FRAMED: string : "51"

    HIDE ¶
    Source

    HIDE: string : "8"
     

    Not widely supported.

    HVP ¶
    Source

    HVP: string : "f"
     

    Horizontal Vertical Position

    HYPERLINK: string : "8"
     

    Followed by ";[params];<URI>" ST. Closed by OSC HYPERLINK ";;" ST.

    INVERT ¶
    Source

    INVERT: string : "7"
     

    Also known as reverse video.

    ITALIC ¶
    Source

    ITALIC: string : "3"
     

    Not widely supported.

    NO_BLINK: string : "25"

    NO_BOLD_FAINT ¶
    Source

    NO_BOLD_FAINT: string : "22"

    NO_FRAME_ENCIRCLE ¶
    Source

    NO_FRAME_ENCIRCLE: string : "54"

    NO_HIDE ¶
    Source

    NO_HIDE: string : "28"

    NO_ITALIC_BLACKLETTER ¶
    Source

    NO_ITALIC_BLACKLETTER: string : "23"

    NO_OVERLINE ¶
    Source

    NO_OVERLINE: string : "55"

    NO_PROPORTIONAL_SPACING ¶
    Source

    NO_PROPORTIONAL_SPACING: string : "50"

    NO_REVERSE ¶
    Source

    NO_REVERSE: string : "27"

    NO_STRIKE ¶
    Source

    NO_STRIKE: string : "29"

    NO_UNDERLINE ¶
    Source

    NO_UNDERLINE: string : "24"

    OSC ¶
    Source

    OSC: string : ESC + "]"
     

    Operating System Command

    OVERLINED ¶
    Source

    OVERLINED: string : "53"

    PROPORTIONAL_SPACING ¶
    Source

    PROPORTIONAL_SPACING: string : "26"

    RCP ¶
    Source

    RCP: string : "u"
     

    Restore Saved Cursor Position

    RESET ¶
    Source

    RESET: string : "0"

    SCP ¶
    Source

    SCP: string : "s"
     

    Save Current Cursor Position

    SD ¶
    Source

    SD: string : "T"
     

    Scroll Down

    SGR ¶
    Source

    SGR: string : "m"
     

    Select Graphic Rendition

    ST ¶
    Source

    ST: string : ESC + "\\"
     

    String Terminator

    STRIKE ¶
    Source

    STRIKE: string : "9"

    SU ¶
    Source

    SU: string : "S"
     

    Scroll Up

    UNDERLINE ¶
    Source

    UNDERLINE: string : "4"

    UNDERLINE_DOUBLE ¶
    Source

    UNDERLINE_DOUBLE: string : "21"
     

    May be interpreted as "disable bold."

    WINDOW_TITLE ¶
    Source

    WINDOW_TITLE: string : "2"
     

    Followed by ";<text>" ST.

    Variables

    This section is empty.

    Procedures

    This section is empty.

    Procedure Groups

    This section is empty.

    Source Files

    Generation Information

    Generated with odin version dev-2025-03 (vendor "odin") Windows_amd64 @ 2025-03-25 21:11:15.173309900 +0000 UTC