Skip to content

cmd2.colors

cmd2.colors

Provides a convenient StrEnum for Rich color names.

Color

Bases: StrEnum

An enumeration of all color names supported by the Rich library.

Using this enum allows for autocompletion and prevents typos when referencing color names. The members can be used for both foreground and background colors.

Aside from DEFAULT, these colors come from the rich.color.ANSI_COLOR_NAMES dictionary.

Note: The terminal color settings determines the appearance of the follow 16 colors.

BLACK BRIGHT_WHITE
BLUE BRIGHT_YELLOW
BRIGHT_BLACK CYAN
BRIGHT_BLUE GREEN
BRIGHT_CYAN MAGENTA
BRIGHT_GREEN RED
BRIGHT_MAGENTA WHITE
BRIGHT_RED YELLOW

DEFAULT class-attribute instance-attribute

DEFAULT = 'default'

Represents the terminal's default foreground or background color.

AQUAMARINE1 class-attribute instance-attribute

AQUAMARINE1 = 'aquamarine1'

AQUAMARINE3 class-attribute instance-attribute

AQUAMARINE3 = 'aquamarine3'

BLACK class-attribute instance-attribute

BLACK = 'black'

BLUE class-attribute instance-attribute

BLUE = 'blue'

BLUE1 class-attribute instance-attribute

BLUE1 = 'blue1'

BLUE3 class-attribute instance-attribute

BLUE3 = 'blue3'

BLUE_VIOLET class-attribute instance-attribute

BLUE_VIOLET = 'blue_violet'

BRIGHT_BLACK class-attribute instance-attribute

BRIGHT_BLACK = 'bright_black'

BRIGHT_BLUE class-attribute instance-attribute

BRIGHT_BLUE = 'bright_blue'

BRIGHT_CYAN class-attribute instance-attribute

BRIGHT_CYAN = 'bright_cyan'

BRIGHT_GREEN class-attribute instance-attribute

BRIGHT_GREEN = 'bright_green'

BRIGHT_MAGENTA class-attribute instance-attribute

BRIGHT_MAGENTA = 'bright_magenta'

BRIGHT_RED class-attribute instance-attribute

BRIGHT_RED = 'bright_red'

BRIGHT_WHITE class-attribute instance-attribute

BRIGHT_WHITE = 'bright_white'

BRIGHT_YELLOW class-attribute instance-attribute

BRIGHT_YELLOW = 'bright_yellow'

CADET_BLUE class-attribute instance-attribute

CADET_BLUE = 'cadet_blue'

CHARTREUSE1 class-attribute instance-attribute

CHARTREUSE1 = 'chartreuse1'

CHARTREUSE2 class-attribute instance-attribute

CHARTREUSE2 = 'chartreuse2'

CHARTREUSE3 class-attribute instance-attribute

CHARTREUSE3 = 'chartreuse3'

CHARTREUSE4 class-attribute instance-attribute

CHARTREUSE4 = 'chartreuse4'

CORNFLOWER_BLUE class-attribute instance-attribute

CORNFLOWER_BLUE = 'cornflower_blue'

CORNSILK1 class-attribute instance-attribute

CORNSILK1 = 'cornsilk1'

CYAN class-attribute instance-attribute

CYAN = 'cyan'

CYAN1 class-attribute instance-attribute

CYAN1 = 'cyan1'

CYAN2 class-attribute instance-attribute

CYAN2 = 'cyan2'

CYAN3 class-attribute instance-attribute

CYAN3 = 'cyan3'

DARK_BLUE class-attribute instance-attribute

DARK_BLUE = 'dark_blue'

DARK_CYAN class-attribute instance-attribute

DARK_CYAN = 'dark_cyan'

DARK_GOLDENROD class-attribute instance-attribute

DARK_GOLDENROD = 'dark_goldenrod'

DARK_GREEN class-attribute instance-attribute

DARK_GREEN = 'dark_green'

DARK_KHAKI class-attribute instance-attribute

DARK_KHAKI = 'dark_khaki'

DARK_MAGENTA class-attribute instance-attribute

DARK_MAGENTA = 'dark_magenta'

DARK_OLIVE_GREEN1 class-attribute instance-attribute

DARK_OLIVE_GREEN1 = 'dark_olive_green1'

DARK_OLIVE_GREEN2 class-attribute instance-attribute

DARK_OLIVE_GREEN2 = 'dark_olive_green2'

DARK_OLIVE_GREEN3 class-attribute instance-attribute

DARK_OLIVE_GREEN3 = 'dark_olive_green3'

DARK_ORANGE class-attribute instance-attribute

DARK_ORANGE = 'dark_orange'

DARK_ORANGE3 class-attribute instance-attribute

DARK_ORANGE3 = 'dark_orange3'

DARK_RED class-attribute instance-attribute

DARK_RED = 'dark_red'

DARK_SEA_GREEN class-attribute instance-attribute

DARK_SEA_GREEN = 'dark_sea_green'

DARK_SEA_GREEN1 class-attribute instance-attribute

DARK_SEA_GREEN1 = 'dark_sea_green1'

DARK_SEA_GREEN2 class-attribute instance-attribute

DARK_SEA_GREEN2 = 'dark_sea_green2'

DARK_SEA_GREEN3 class-attribute instance-attribute

DARK_SEA_GREEN3 = 'dark_sea_green3'

DARK_SEA_GREEN4 class-attribute instance-attribute

DARK_SEA_GREEN4 = 'dark_sea_green4'

DARK_SLATE_GRAY1 class-attribute instance-attribute

DARK_SLATE_GRAY1 = 'dark_slate_gray1'

DARK_SLATE_GRAY2 class-attribute instance-attribute

DARK_SLATE_GRAY2 = 'dark_slate_gray2'

DARK_SLATE_GRAY3 class-attribute instance-attribute

DARK_SLATE_GRAY3 = 'dark_slate_gray3'

DARK_TURQUOISE class-attribute instance-attribute

DARK_TURQUOISE = 'dark_turquoise'

DARK_VIOLET class-attribute instance-attribute

DARK_VIOLET = 'dark_violet'

DEEP_PINK1 class-attribute instance-attribute

DEEP_PINK1 = 'deep_pink1'

DEEP_PINK2 class-attribute instance-attribute

DEEP_PINK2 = 'deep_pink2'

DEEP_PINK3 class-attribute instance-attribute

DEEP_PINK3 = 'deep_pink3'

DEEP_PINK4 class-attribute instance-attribute

DEEP_PINK4 = 'deep_pink4'

DEEP_SKY_BLUE1 class-attribute instance-attribute

DEEP_SKY_BLUE1 = 'deep_sky_blue1'

DEEP_SKY_BLUE2 class-attribute instance-attribute

DEEP_SKY_BLUE2 = 'deep_sky_blue2'

DEEP_SKY_BLUE3 class-attribute instance-attribute

DEEP_SKY_BLUE3 = 'deep_sky_blue3'

DEEP_SKY_BLUE4 class-attribute instance-attribute

DEEP_SKY_BLUE4 = 'deep_sky_blue4'

DODGER_BLUE1 class-attribute instance-attribute

DODGER_BLUE1 = 'dodger_blue1'

DODGER_BLUE2 class-attribute instance-attribute

DODGER_BLUE2 = 'dodger_blue2'

DODGER_BLUE3 class-attribute instance-attribute

DODGER_BLUE3 = 'dodger_blue3'

GOLD1 class-attribute instance-attribute

GOLD1 = 'gold1'

GOLD3 class-attribute instance-attribute

GOLD3 = 'gold3'

GRAY0 class-attribute instance-attribute

GRAY0 = 'gray0'

GRAY3 class-attribute instance-attribute

GRAY3 = 'gray3'

GRAY7 class-attribute instance-attribute

GRAY7 = 'gray7'

GRAY11 class-attribute instance-attribute

GRAY11 = 'gray11'

GRAY15 class-attribute instance-attribute

GRAY15 = 'gray15'

GRAY19 class-attribute instance-attribute

GRAY19 = 'gray19'

GRAY23 class-attribute instance-attribute

GRAY23 = 'gray23'

GRAY27 class-attribute instance-attribute

GRAY27 = 'gray27'

GRAY30 class-attribute instance-attribute

GRAY30 = 'gray30'

GRAY35 class-attribute instance-attribute

GRAY35 = 'gray35'

GRAY37 class-attribute instance-attribute

GRAY37 = 'gray37'

GRAY39 class-attribute instance-attribute

GRAY39 = 'gray39'

GRAY42 class-attribute instance-attribute

GRAY42 = 'gray42'

GRAY46 class-attribute instance-attribute

GRAY46 = 'gray46'

GRAY50 class-attribute instance-attribute

GRAY50 = 'gray50'

GRAY53 class-attribute instance-attribute

GRAY53 = 'gray53'

GRAY54 class-attribute instance-attribute

GRAY54 = 'gray54'

GRAY58 class-attribute instance-attribute

GRAY58 = 'gray58'

GRAY62 class-attribute instance-attribute

GRAY62 = 'gray62'

GRAY63 class-attribute instance-attribute

GRAY63 = 'gray63'

GRAY66 class-attribute instance-attribute

GRAY66 = 'gray66'

GRAY69 class-attribute instance-attribute

GRAY69 = 'gray69'

GRAY70 class-attribute instance-attribute

GRAY70 = 'gray70'

GRAY74 class-attribute instance-attribute

GRAY74 = 'gray74'

GRAY78 class-attribute instance-attribute

GRAY78 = 'gray78'

GRAY82 class-attribute instance-attribute

GRAY82 = 'gray82'

GRAY84 class-attribute instance-attribute

GRAY84 = 'gray84'

GRAY85 class-attribute instance-attribute

GRAY85 = 'gray85'

GRAY89 class-attribute instance-attribute

GRAY89 = 'gray89'

GRAY93 class-attribute instance-attribute

GRAY93 = 'gray93'

GRAY100 class-attribute instance-attribute

GRAY100 = 'gray100'

GREEN class-attribute instance-attribute

GREEN = 'green'

GREEN1 class-attribute instance-attribute

GREEN1 = 'green1'

GREEN3 class-attribute instance-attribute

GREEN3 = 'green3'

GREEN4 class-attribute instance-attribute

GREEN4 = 'green4'

GREEN_YELLOW class-attribute instance-attribute

GREEN_YELLOW = 'green_yellow'

GREY0 class-attribute instance-attribute

GREY0 = 'grey0'

GREY3 class-attribute instance-attribute

GREY3 = 'grey3'

GREY7 class-attribute instance-attribute

GREY7 = 'grey7'

GREY11 class-attribute instance-attribute

GREY11 = 'grey11'

GREY15 class-attribute instance-attribute

GREY15 = 'grey15'

GREY19 class-attribute instance-attribute

GREY19 = 'grey19'

GREY23 class-attribute instance-attribute

GREY23 = 'grey23'

GREY27 class-attribute instance-attribute

GREY27 = 'grey27'

GREY30 class-attribute instance-attribute

GREY30 = 'grey30'

GREY35 class-attribute instance-attribute

GREY35 = 'grey35'

GREY37 class-attribute instance-attribute

GREY37 = 'grey37'

GREY39 class-attribute instance-attribute

GREY39 = 'grey39'

GREY42 class-attribute instance-attribute

GREY42 = 'grey42'

GREY46 class-attribute instance-attribute

GREY46 = 'grey46'

GREY50 class-attribute instance-attribute

GREY50 = 'grey50'

GREY53 class-attribute instance-attribute

GREY53 = 'grey53'

GREY54 class-attribute instance-attribute

GREY54 = 'grey54'

GREY58 class-attribute instance-attribute

GREY58 = 'grey58'

GREY62 class-attribute instance-attribute

GREY62 = 'grey62'

GREY63 class-attribute instance-attribute

GREY63 = 'grey63'

GREY66 class-attribute instance-attribute

GREY66 = 'grey66'

GREY69 class-attribute instance-attribute

GREY69 = 'grey69'

GREY70 class-attribute instance-attribute

GREY70 = 'grey70'

GREY74 class-attribute instance-attribute

GREY74 = 'grey74'

GREY78 class-attribute instance-attribute

GREY78 = 'grey78'

GREY82 class-attribute instance-attribute

GREY82 = 'grey82'

GREY84 class-attribute instance-attribute

GREY84 = 'grey84'

GREY85 class-attribute instance-attribute

GREY85 = 'grey85'

GREY89 class-attribute instance-attribute

GREY89 = 'grey89'

GREY93 class-attribute instance-attribute

GREY93 = 'grey93'

GREY100 class-attribute instance-attribute

GREY100 = 'grey100'

HONEYDEW2 class-attribute instance-attribute

HONEYDEW2 = 'honeydew2'

HOT_PINK class-attribute instance-attribute

HOT_PINK = 'hot_pink'

HOT_PINK2 class-attribute instance-attribute

HOT_PINK2 = 'hot_pink2'

HOT_PINK3 class-attribute instance-attribute

HOT_PINK3 = 'hot_pink3'

INDIAN_RED class-attribute instance-attribute

INDIAN_RED = 'indian_red'

INDIAN_RED1 class-attribute instance-attribute

INDIAN_RED1 = 'indian_red1'

KHAKI1 class-attribute instance-attribute

KHAKI1 = 'khaki1'

KHAKI3 class-attribute instance-attribute

KHAKI3 = 'khaki3'

LIGHT_CORAL class-attribute instance-attribute

LIGHT_CORAL = 'light_coral'

LIGHT_CYAN1 class-attribute instance-attribute

LIGHT_CYAN1 = 'light_cyan1'

LIGHT_CYAN3 class-attribute instance-attribute

LIGHT_CYAN3 = 'light_cyan3'

LIGHT_GOLDENROD1 class-attribute instance-attribute

LIGHT_GOLDENROD1 = 'light_goldenrod1'

LIGHT_GOLDENROD2 class-attribute instance-attribute

LIGHT_GOLDENROD2 = 'light_goldenrod2'

LIGHT_GOLDENROD3 class-attribute instance-attribute

LIGHT_GOLDENROD3 = 'light_goldenrod3'

LIGHT_GREEN class-attribute instance-attribute

LIGHT_GREEN = 'light_green'

LIGHT_PINK1 class-attribute instance-attribute

LIGHT_PINK1 = 'light_pink1'

LIGHT_PINK3 class-attribute instance-attribute

LIGHT_PINK3 = 'light_pink3'

LIGHT_PINK4 class-attribute instance-attribute

LIGHT_PINK4 = 'light_pink4'

LIGHT_SALMON1 class-attribute instance-attribute

LIGHT_SALMON1 = 'light_salmon1'

LIGHT_SALMON3 class-attribute instance-attribute

LIGHT_SALMON3 = 'light_salmon3'

LIGHT_SEA_GREEN class-attribute instance-attribute

LIGHT_SEA_GREEN = 'light_sea_green'

LIGHT_SKY_BLUE1 class-attribute instance-attribute

LIGHT_SKY_BLUE1 = 'light_sky_blue1'

LIGHT_SKY_BLUE3 class-attribute instance-attribute

LIGHT_SKY_BLUE3 = 'light_sky_blue3'

LIGHT_SLATE_BLUE class-attribute instance-attribute

LIGHT_SLATE_BLUE = 'light_slate_blue'

LIGHT_SLATE_GRAY class-attribute instance-attribute

LIGHT_SLATE_GRAY = 'light_slate_gray'

LIGHT_SLATE_GREY class-attribute instance-attribute

LIGHT_SLATE_GREY = 'light_slate_grey'

LIGHT_STEEL_BLUE class-attribute instance-attribute

LIGHT_STEEL_BLUE = 'light_steel_blue'

LIGHT_STEEL_BLUE1 class-attribute instance-attribute

LIGHT_STEEL_BLUE1 = 'light_steel_blue1'

LIGHT_STEEL_BLUE3 class-attribute instance-attribute

LIGHT_STEEL_BLUE3 = 'light_steel_blue3'

LIGHT_YELLOW3 class-attribute instance-attribute

LIGHT_YELLOW3 = 'light_yellow3'

MAGENTA class-attribute instance-attribute

MAGENTA = 'magenta'

MAGENTA1 class-attribute instance-attribute

MAGENTA1 = 'magenta1'

MAGENTA2 class-attribute instance-attribute

MAGENTA2 = 'magenta2'

MAGENTA3 class-attribute instance-attribute

MAGENTA3 = 'magenta3'

MEDIUM_ORCHID class-attribute instance-attribute

MEDIUM_ORCHID = 'medium_orchid'

MEDIUM_ORCHID1 class-attribute instance-attribute

MEDIUM_ORCHID1 = 'medium_orchid1'

MEDIUM_ORCHID3 class-attribute instance-attribute

MEDIUM_ORCHID3 = 'medium_orchid3'

MEDIUM_PURPLE class-attribute instance-attribute

MEDIUM_PURPLE = 'medium_purple'

MEDIUM_PURPLE1 class-attribute instance-attribute

MEDIUM_PURPLE1 = 'medium_purple1'

MEDIUM_PURPLE2 class-attribute instance-attribute

MEDIUM_PURPLE2 = 'medium_purple2'

MEDIUM_PURPLE3 class-attribute instance-attribute

MEDIUM_PURPLE3 = 'medium_purple3'

MEDIUM_PURPLE4 class-attribute instance-attribute

MEDIUM_PURPLE4 = 'medium_purple4'

MEDIUM_SPRING_GREEN class-attribute instance-attribute

MEDIUM_SPRING_GREEN = 'medium_spring_green'

MEDIUM_TURQUOISE class-attribute instance-attribute

MEDIUM_TURQUOISE = 'medium_turquoise'

MEDIUM_VIOLET_RED class-attribute instance-attribute

MEDIUM_VIOLET_RED = 'medium_violet_red'

MISTY_ROSE1 class-attribute instance-attribute

MISTY_ROSE1 = 'misty_rose1'

MISTY_ROSE3 class-attribute instance-attribute

MISTY_ROSE3 = 'misty_rose3'

NAVAJO_WHITE1 class-attribute instance-attribute

NAVAJO_WHITE1 = 'navajo_white1'

NAVAJO_WHITE3 class-attribute instance-attribute

NAVAJO_WHITE3 = 'navajo_white3'

NAVY_BLUE class-attribute instance-attribute

NAVY_BLUE = 'navy_blue'

ORANGE1 class-attribute instance-attribute

ORANGE1 = 'orange1'

ORANGE3 class-attribute instance-attribute

ORANGE3 = 'orange3'

ORANGE4 class-attribute instance-attribute

ORANGE4 = 'orange4'

ORANGE_RED1 class-attribute instance-attribute

ORANGE_RED1 = 'orange_red1'

ORCHID class-attribute instance-attribute

ORCHID = 'orchid'

ORCHID1 class-attribute instance-attribute

ORCHID1 = 'orchid1'

ORCHID2 class-attribute instance-attribute

ORCHID2 = 'orchid2'

PALE_GREEN1 class-attribute instance-attribute

PALE_GREEN1 = 'pale_green1'

PALE_GREEN3 class-attribute instance-attribute

PALE_GREEN3 = 'pale_green3'

PALE_TURQUOISE1 class-attribute instance-attribute

PALE_TURQUOISE1 = 'pale_turquoise1'

PALE_TURQUOISE4 class-attribute instance-attribute

PALE_TURQUOISE4 = 'pale_turquoise4'

PALE_VIOLET_RED1 class-attribute instance-attribute

PALE_VIOLET_RED1 = 'pale_violet_red1'

PINK1 class-attribute instance-attribute

PINK1 = 'pink1'

PINK3 class-attribute instance-attribute

PINK3 = 'pink3'

PLUM1 class-attribute instance-attribute

PLUM1 = 'plum1'

PLUM2 class-attribute instance-attribute

PLUM2 = 'plum2'

PLUM3 class-attribute instance-attribute

PLUM3 = 'plum3'

PLUM4 class-attribute instance-attribute

PLUM4 = 'plum4'

PURPLE class-attribute instance-attribute

PURPLE = 'purple'

PURPLE3 class-attribute instance-attribute

PURPLE3 = 'purple3'

PURPLE4 class-attribute instance-attribute

PURPLE4 = 'purple4'

RED class-attribute instance-attribute

RED = 'red'

RED1 class-attribute instance-attribute

RED1 = 'red1'

RED3 class-attribute instance-attribute

RED3 = 'red3'

ROSY_BROWN class-attribute instance-attribute

ROSY_BROWN = 'rosy_brown'

ROYAL_BLUE1 class-attribute instance-attribute

ROYAL_BLUE1 = 'royal_blue1'

SALMON1 class-attribute instance-attribute

SALMON1 = 'salmon1'

SANDY_BROWN class-attribute instance-attribute

SANDY_BROWN = 'sandy_brown'

SEA_GREEN1 class-attribute instance-attribute

SEA_GREEN1 = 'sea_green1'

SEA_GREEN2 class-attribute instance-attribute

SEA_GREEN2 = 'sea_green2'

SEA_GREEN3 class-attribute instance-attribute

SEA_GREEN3 = 'sea_green3'

SKY_BLUE1 class-attribute instance-attribute

SKY_BLUE1 = 'sky_blue1'

SKY_BLUE2 class-attribute instance-attribute

SKY_BLUE2 = 'sky_blue2'

SKY_BLUE3 class-attribute instance-attribute

SKY_BLUE3 = 'sky_blue3'

SLATE_BLUE1 class-attribute instance-attribute

SLATE_BLUE1 = 'slate_blue1'

SLATE_BLUE3 class-attribute instance-attribute

SLATE_BLUE3 = 'slate_blue3'

SPRING_GREEN1 class-attribute instance-attribute

SPRING_GREEN1 = 'spring_green1'

SPRING_GREEN2 class-attribute instance-attribute

SPRING_GREEN2 = 'spring_green2'

SPRING_GREEN3 class-attribute instance-attribute

SPRING_GREEN3 = 'spring_green3'

SPRING_GREEN4 class-attribute instance-attribute

SPRING_GREEN4 = 'spring_green4'

STEEL_BLUE class-attribute instance-attribute

STEEL_BLUE = 'steel_blue'

STEEL_BLUE1 class-attribute instance-attribute

STEEL_BLUE1 = 'steel_blue1'

STEEL_BLUE3 class-attribute instance-attribute

STEEL_BLUE3 = 'steel_blue3'

TAN class-attribute instance-attribute

TAN = 'tan'

THISTLE1 class-attribute instance-attribute

THISTLE1 = 'thistle1'

THISTLE3 class-attribute instance-attribute

THISTLE3 = 'thistle3'

TURQUOISE2 class-attribute instance-attribute

TURQUOISE2 = 'turquoise2'

TURQUOISE4 class-attribute instance-attribute

TURQUOISE4 = 'turquoise4'

VIOLET class-attribute instance-attribute

VIOLET = 'violet'

WHEAT1 class-attribute instance-attribute

WHEAT1 = 'wheat1'

WHEAT4 class-attribute instance-attribute

WHEAT4 = 'wheat4'

WHITE class-attribute instance-attribute

WHITE = 'white'

YELLOW class-attribute instance-attribute

YELLOW = 'yellow'

YELLOW1 class-attribute instance-attribute

YELLOW1 = 'yellow1'

YELLOW2 class-attribute instance-attribute

YELLOW2 = 'yellow2'

YELLOW3 class-attribute instance-attribute

YELLOW3 = 'yellow3'

YELLOW4 class-attribute instance-attribute

YELLOW4 = 'yellow4'