chalk

Overview

Terminal string styling done right. A popular CLI package for Node.js with 1.7B monthly downloads.

Installation

npm install chalk

Core API / Usage

// Combine styled and normal strings
log(chalk.blue('Hello') + ' World' + chalk.red('!'));

// Compose multiple styles using the chainable API
log(chalk.blue.bgRed.bold('Hello world!'));

Common Patterns

Pattern 1

// Pass in multiple arguments
log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz'));

Pattern 2

// Nest styles
log(chalk.red('Hello', chalk.underline.bgBlue('world') + '!'));

Pattern 3

// Nest styles of the same type even (color, underline, background)
log(chalk.green(
	'I am a green line ' +
	chalk.blue.underline.bold('with a blue substring') +
	' that becomes green again!'
));

Configuration

See the official documentation for configuration options and advanced settings.

Tips & Gotchas

• Includes built-in TypeScript type definitions.
• Current version: 5.6.2. Check the changelog when upgrading across major versions.