cli-color

What is cli-color?

The cli-color npm package is a library for adding color and formatting to text in Node.js command line applications. It provides a simple API to style strings that appear in the terminal, making it easier to produce visually distinct and organized output.

What are cli-color's main functionalities?

Text coloring

This feature allows you to change the color of the text output in the terminal. The example shows how to make text appear in red.

const clc = require('cli-color');
console.log(clc.red('This text is red'));

Text formatting

This feature enables text formatting such as making text bold, underlined, etc. The example demonstrates how to make text bold.

const clc = require('cli-color');
console.log(clc.bold('This text is bold'));

Background coloring

This feature allows you to set the background color of the text. The example shows white text on a blue background.

const clc = require('cli-color');
console.log(clc.bgBlue.white('White text on blue background'));

Other packages similar to cli-color

chalk

Chalk is a popular npm package similar to cli-color with a chainable API that allows for easier and more readable syntax. Chalk supports modern terminal features and has a broader color palette compared to cli-color.

colors

Colors is another npm package that adds colors to Node.js console output. It extends String.prototype to add color methods directly to strings, which can be less modular and potentially messier than cli-color's functional approach.

README

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'));

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
• inverse
• strike

Foreground colors

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white

Background colors

• bgBlack
• bgRed
• bgGreen
• bgYellow
• bgBlue
• bgMagenta
• bgCyan
• bgWhite

Additional functions:

trim(formatedText)

Trims ANSI formatted string to plain text

var ansiTrim = require('cli-color/lib/trim');

var plain = ansiTrim(formatted);

throbber(interval[, format])

Displays throbber on given interval. Interval should be clock.interval object Optionally throbber output can be formatted with given format

var interval = require('clock/lib/interval')
  , ansiThrobber = require('cli-color/lib/throbber');

var i = interval(200, true);

// Display throbber while interval is ticking
ansiThrobber(i);

// at any time you can stop/start interval
// When interval is stopped throbber doesn't show
i.stop();