cli-color

Created: 2011-07-11 15:05
Updated: 2019-02-19 09:54
License: isc

README.md

*nix build status Windows build status Transpilation status npm version

cli-color

Yet another colors and formatting for the console solution

Colors, formatting and other goodies for the console. This package won't mess with built-ins and provides neat way to predefine formatting patterns, see below.

Installation

$ npm install cli-color

Usage

Usage:

var clc = require("cli-color");

Output colored text:

console.log(clc.red("Text in red"));

Styles can be mixed:

console.log(clc.red.bgWhite.underline("Underlined red text on white background."));

Styled text can be mixed with unstyled:

console.log(clc.red("red") + " plain " + clc.blue("blue"));

Styled text can be nested:

console.log(clc.red("red " + clc.blue("blue") + " red"));

Best way is to predefine needed stylings and then use it:

var error = clc.red.bold;
var warn = clc.yellow;
var notice = clc.blue;

console.log(error("Error!"));
console.log(warn("Warning"));
console.log(notice("Notice"));

Supported are all ANSI colors and styles:

Styles

Styles will display correctly if font used in your console supports them.

  • bold
  • italic
  • underline
  • blink
  • inverse
  • strike

Colors

Foreground Background
black bgBlack
red bgRed
green bgGreen
yellow bgYellow
blue bgBlue
magenta bgMagenta
cyan bgCyan
white bgWhite
Bright variants
Foreground Background
blackBright bgBlackBright
redBright bgRedBright
greenBright bgGreenBright
yellowBright bgYellowBright
blueBright bgBlueBright
magentaBright bgMagentaBright
cyanBright bgCyanBright
whiteBright bgWhiteBright
xTerm colors (256 colors table)

Not supported on Windows and some terminals. However if used in not supported environment, the closest color from basic (16 colors) palette is chosen.

Usage:

var msg = clc.xterm(202).bgXterm(236);
console.log(msg("Orange text on dark gray background"));

Color table:

0 1 2 3 4 5 6 7
8 9 10 11 12 13 14 15
16 17 18 19 20 21
22 23 24 25 26 27
28 29 30 31 32 33
34 35 36 37 38 39
40 41 42 43 44 45
46 47 48 49