Skip to content
A bash library for terminal colors.
Shell
Branch: dev
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
colr.sh
test_colr.sh

README.md

Colr.sh

A BASH version of Colr. It provides easy terminal colors by executing it or sourcing it into another script.

Command Line Usage

Usage:
    colr.sh -h | -l | -L | -v
    colr.sh TEXT FORE [BACK] [STYLE]
    colr.sh -r TEXT

Options:
    BACK             : Name of back color for the text.
    FORE             : Name of fore color for the text.
    STYLE            : Name of style for the text.
    TEXT             : Text to colorize.
    -h,--help        : Show this message.
    -L,--listcodes   : List all colors and escape codes exported
                       by this script.
    -l,--liststyles  : List all colors exported by this script.
    -r,--repr        : Show a representation of escape codes found
                       in a string.
                       This may also be used on stdin data.
    -v,--version     : Show Colr version and exit.

Colors

Raw escape codes are provided through associative arrays named fore, back, and style. The preferred method for using colr.sh is to call the colr function, but the raw codes are still accessible.

Fore/Back

The fore and back arrays have numbered keys for all 256-color codes, and named keys for basic colors.

# Example keys/values after sourcing colr.sh.
fore[black]="\033[30m"
fore[red]="\033[31m"
fore[green]="\033[32m"
fore[yellow]="\033[33m"
fore[blue]="\033[34m"
fore[magenta]="\033[35m"
fore[cyan]="\033[36m"
fore[white]="\033[37m"
fore[reset]="\033[39m"
# The same is done for the `back` array, with the appropriate code numbers.

They also have convenient names for the lighter versions. Just prepend light to an existing name:

source colr.sh
# This is the same as:
# echo -e "$(colr "This is a test" "lightblue")"
echo -e "${fore[lightblue]}This is a test.${fore[reset]}"

Style

The style array has style names for keys.

# Example keys/values after sourcing colr.sh.
style[reset]="\033[0m"
style[bright]="\033[1m"
style[dim]="\033[2m"
style[italic]="\033[3m"
style[underline]="\033[4m"
style[flash]="\033[5m"
style[highlight]="\033[7m"
style[normal]="\033[22m"

Raw Escape Code Example Usage

source colr.sh
echo -e "${fore[red]}${style[bright]}Test${style[reset]}"

Functions

colr

colr TEXT [FORE] [BACK] [STYLE]

Applies escape codes to the text and prints it to stdout for consumption.

Example

source colr.sh

echo "$(colr "This is a test." "blue" "white" "bright")"

colr_auto_disable

colr_auto_disable

Automatically calls colr_disable if output is being piped.

Example

source colr.sh

colr_auto_disable
echo -e "$(colr "This will not be colorized when piped." "red")"

colr_enable

colr_enable

Enables colorized output after colr_disable has been called.

colr_disable

colr_disable

Disables colorized output until colr_enable is called again.

colr_is_disabled

colr_is_disabled

Provides access to the colr_disabled variable in command form.

Example

source colr.sh
# Only do something if colr is disabled.
if colr_is_disabled; then
    echo "Sorry, no color for you."
fi

This is equivalent to:

source colr.sh
# Only do something if colr is disabled.
if ((colr_disabled)); then
    echo "Sorry, no color for you."
fi

colr_is_enabled

colr_is_enabled

Provides access to the colr_disabled variable in reversed command form.

Example

source colr.sh
# Only do something when colr is enabled.
if colr_is_enabled; then
    echo -e "$(colr "Yay, colr..." "blue")"
fi

This is equivalent to:

source colr.sh
# Only do something when colr is enabled.
if ((!colr_disabled)); then
    echo -e "$(colr "Yay, colr..." "blue")"
fi

codeformat

codeformat NUMBER

Builds a basic escape code by number only. This is used to build the escape code associative arrays, and is generally not needed except for that use.

Example

source colr.sh
# Build the same escape code found in ${fore[red]}.
escapecode="$(codeformat 31)"

escape_code_repr

escape_code_repr STRING...

Print the representation of one or more escape-codes/strings, without escaping (without setting a color, style, etc.)

This will replace all escape codes in a string with their representation.

It is used to implement colr.sh --repr and the colr.sh --list* options.

Example

source colr.sh
# Print the representation for the color 'blue'
name="blue"
repr="$(escape_code_repr "${fore[$name]}")"
printf "The escape code for %s is: %s\n" "$name" "$repr"

# Reveal escape codes in a string.
string="This is ${fore[blue]}neat${fore[reset]}."
printf "Representation: %s\n" "$(escape_code_repr "$string")"

extbackformat

extbackformat NUMBER

Builds an escape code for the 256-color background colors (extended colors). This is used to build the escape code associative arrays, and is generally not needed except for that use.

Example

source colr.sh
# Build the same escape code found in ${back[155]}.
escapecode="$(extbackformat 155)"

extforeformat

extforeformat NUMBER

Builds an escape code for the 256-color forekground colors (extended colors). This is used to build the escape code associative arrays, and is generally not needed except for that use.

Example

source colr.sh
# Build the same escape code found in ${fore[125]}.
escapecode="$(extforeformat 125)"
You can’t perform that action at this time.