athea

Repositories Projects Packages

supports-color (5.5.0)

Published 2026-02-24 14:05:55 +00:00 by atheaadmin

Installation

Setup this registry in your project .npmrc file:

registry=

To install the package using npm, run the following command:

npm install supports-color@5.5.0

or add it to the package.json file:

"supports-color": "5.5.0"

For more information on the npm registry, see the documentation.

About this package

supports-color

Detect whether a terminal supports color

Install

$ npm install supports-color

Usage

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

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

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

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

API

Returns an Object with a stdout and stderr property for testing either streams. Each property is an Object, or false if color is not supported.

The stdout/stderr objects 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)

Info

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.

Related

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

Maintainers

• Sindre Sorhus
• Josh Junon

License

MIT

Dependencies

Dependencies

ID	Version
has-flag	^3.0.0

Development Dependencies

ID	Version
ava	^0.25.0
import-fresh	^2.0.0
xo	^0.20.0

Keywords

color colour colors terminal console cli ansi styles tty rgb 256 shell xterm command-line support supports capability detect truecolor 16m

Details

npm

2026-02-24 14:05:55 +00:00

0

Sindre Sorhus

Project Site

MIT

3.0 KiB

Assets (1)

supports-color-5.5.0.tgz 3.0 KiB

Versions (3) View all

7.2.0 2026-02-24

8.1.1 2026-02-24

5.5.0 2026-02-24