Detect whether a terminal supports color
$ npm install supports-color
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)');
}
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
: Truecolor support (16 million colors)It obeys the --color
and --no-color
CLI flags.
Can be overridden by the user with the flags --color
and --no-color
. For situations where using --color
is not possible, add the environment variable FORCE_COLOR=1
to forcefully enable color or FORCE_COLOR=0
to forcefully disable. The use of FORCE_COLOR
overrides all other color support checks.
Explicit 256/Truecolor mode can be enabled using the --color=256
and --color=16m
flags, respectively.
MIT