alexxnica / supports-color

Detect whether a terminal supports color

supports-color

Detect whether a terminal supports color

Install

$ npm install --save supports-color

Usage

const supportsColor = require('supports-color');

if (supportsColor) {
	console.log('Terminal supports color');
}

if (supportsColor.has256) {
	console.log('Terminal supports 256 colors');
}

if (supportsColor.has16m) {
	console.log('Terminal supports 16 million colors (truecolor)');
}

API

Returns an Object, or false if color is not supported.

The returned object specifies a level of support for color through a .level property and a corresponding flag:

• .level = 1 and .hasBasic = true: Basic color support (16 colors)
• .level = 2 and .has256 = true: 256 color support
• .level = 3 and .has16m = true: 16 million (truecolor) support

Info

It obeys the --color and --no-color CLI flags.

For situations where using --color is not possible, add an environment variable FORCE_COLOR=1 to forcefully enable color and FORCE_COLOR=0 forcefully disable. The use of FORCE_COLOR overrides all other color checks performed by this module.

Explicit 256/truecolor mode can be enabled using the --color=256 and --color=16m flags, respectively.

Related

• supports-color-cli - CLI for this module
• chalk - Terminal string styling done right

License

MIT © Sindre Sorhus