Installations
npm install chalk
Developer Guide
Typescript
Yes
Module System
ESM
Min. Node Version
^12.17.0 || ^14.13 || >=16.0.0
Node Version
16.20.0
NPM Version
9.2.0
Score
99.4
Supply Chain
99.5
Quality
78.2
Maintenance
100
Vulnerability
100
License
Releases
Contributors
Languages
JavaScript (72.94%)
TypeScript (27.06%)
Developer
chalk
Download Statistics
Total Downloads
47,906,037,850
Last Day
56,472,344
Last Week
293,704,750
Last Month
1,400,138,500
Last Year
15,463,903,290
GitHub Statistics
22,035 Stars
358 Commits
1,303 Forks
148 Watching
1 Branches
57 Contributors
Bundle Size
5.58 kB
Minified
2.27 kB
Minified + Gzipped
Sponsor this package
Package Meta Information
Latest Version
5.3.0
Package Id
chalk@5.3.0
Unpacked Size
42.71 kB
Size
13.08 kB
File Count
12
NPM Version
9.2.0
Node Version
16.20.0
Publised On
29 Jun 2023
Total Downloads
Cumulative downloads
Total Downloads
47,906,037,850
Last day
-6%
56,472,344
Compared to previous day
Last week
-0.2%
293,704,750
Compared to previous week
Last month
6.5%
1,400,138,500
Compared to previous month
Last year
19.5%
15,463,903,290
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
10
Terminal string styling done right
Sindre Sorhus' open source work is supported by the community on GitHub Sponsors
Special thanks to:Highlights
- Expressive API
- Highly performant
- No dependencies
- Ability to nest styles
- 256/Truecolor color support
- Auto-detects color support
- Doesn't extend
String.prototype
- Clean and focused
- Actively maintained
- Used by ~86,000 packages as of October 4, 2022
Install
1npm install chalk
IMPORTANT: Chalk 5 is ESM. If you want to use Chalk with TypeScript or a build tool, you will probably want to use Chalk 4 for now. Read more.
Usage
1import chalk from 'chalk'; 2 3console.log(chalk.blue('Hello world!'));
Chalk comes with an easy to use composable API where you just chain and nest the styles you want.
1import chalk from 'chalk'; 2 3const log = console.log; 4 5// Combine styled and normal strings 6log(chalk.blue('Hello') + ' World' + chalk.red('!')); 7 8// Compose multiple styles using the chainable API 9log(chalk.blue.bgRed.bold('Hello world!')); 10 11// Pass in multiple arguments 12log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')); 13 14// Nest styles 15log(chalk.red('Hello', chalk.underline.bgBlue('world') + '!')); 16 17// Nest styles of the same type even (color, underline, background) 18log(chalk.green( 19 'I am a green line ' + 20 chalk.blue.underline.bold('with a blue substring') + 21 ' that becomes green again!' 22)); 23 24// ES2015 template literal 25log(` 26CPU: ${chalk.red('90%')} 27RAM: ${chalk.green('40%')} 28DISK: ${chalk.yellow('70%')} 29`); 30 31// Use RGB colors in terminal emulators that support it. 32log(chalk.rgb(123, 45, 67).underline('Underlined reddish color')); 33log(chalk.hex('#DEADED').bold('Bold gray!'));
Easily define your own themes:
1import chalk from 'chalk'; 2 3const error = chalk.bold.red; 4const warning = chalk.hex('#FFA500'); // Orange color 5 6console.log(error('Error!')); 7console.log(warning('Warning!'));
Take advantage of console.log string substitution:
1import chalk from 'chalk'; 2 3const name = 'Sindre'; 4console.log(chalk.green('Hello %s'), name); 5//=> 'Hello Sindre'
API
chalk.<style>[.<style>...](string, [string...])
Example: chalk.red.bold.underline('Hello', 'world');
Chain styles and call the last one as a method with a string argument. Order doesn't matter, and later styles take precedent in case of a conflict. This simply means that chalk.red.yellow.green
is equivalent to chalk.green
.
Multiple arguments will be separated by space.
chalk.level
Specifies the level of color support.
Color support is automatically detected, but you can override it by setting the level
property. You should however only do this in your own code as it applies globally to all Chalk consumers.
If you need to change this in a reusable module, create a new instance:
1import {Chalk} from 'chalk'; 2 3const customChalk = new Chalk({level: 0});
Level | Description |
---|---|
0 | All colors disabled |
1 | Basic color support (16 colors) |
2 | 256 color support |
3 | Truecolor support (16 million colors) |
supportsColor
Detect whether the terminal supports color. Used internally and handled for you, but exposed for convenience.
Can be overridden by the user with the flags --color
and --no-color
. For situations where using --color
is not possible, use the environment variable FORCE_COLOR=1
(level 1), FORCE_COLOR=2
(level 2), or FORCE_COLOR=3
(level 3) 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.
chalkStderr and supportsColorStderr
chalkStderr
contains a separate instance configured with color support detected for stderr
stream instead of stdout
. Override rules from supportsColor
apply to this too. supportsColorStderr
is exposed for convenience.
modifierNames, foregroundColorNames, backgroundColorNames, and colorNames
All supported style strings are exposed as an array of strings for convenience. colorNames
is the combination of foregroundColorNames
and backgroundColorNames
.
This can be useful if you wrap Chalk and need to validate input:
1import {modifierNames, foregroundColorNames} from 'chalk'; 2 3console.log(modifierNames.includes('bold')); 4//=> true 5 6console.log(foregroundColorNames.includes('pink')); 7//=> false
Styles
Modifiers
reset
- Reset the current style.bold
- Make the text bold.dim
- Make the text have lower opacity.italic
- Make the text italic. (Not widely supported)underline
- Put a horizontal line below the text. (Not widely supported)overline
- Put a horizontal line above the text. (Not widely supported)inverse
- Invert background and foreground colors.hidden
- Print the text but make it invisible.strikethrough
- Puts a horizontal line through the center of the text. (Not widely supported)visible
- Print the text only when Chalk has a color level above zero. Can be useful for things that are purely cosmetic.
Colors
black
red
green
yellow
blue
magenta
cyan
white
blackBright
(alias:gray
,grey
)redBright
greenBright
yellowBright
blueBright
magentaBright
cyanBright
whiteBright
Background colors
bgBlack
bgRed
bgGreen
bgYellow
bgBlue
bgMagenta
bgCyan
bgWhite
bgBlackBright
(alias:bgGray
,bgGrey
)bgRedBright
bgGreenBright
bgYellowBright
bgBlueBright
bgMagentaBright
bgCyanBright
bgWhiteBright
256 and Truecolor color support
Chalk supports 256 colors and Truecolor (16 million colors) on supported terminal apps.
Colors are downsampled from 16 million RGB values to an ANSI color format that is supported by the terminal emulator (or by specifying {level: n}
as a Chalk option). For example, Chalk configured to run at level 1 (basic color support) will downsample an RGB value of #FF0000 (red) to 31 (ANSI escape for red).
Examples:
chalk.hex('#DEADED').underline('Hello, world!')
chalk.rgb(15, 100, 204).inverse('Hello!')
Background versions of these models are prefixed with bg
and the first level of the module capitalized (e.g. hex
for foreground colors and bgHex
for background colors).
chalk.bgHex('#DEADED').underline('Hello, world!')
chalk.bgRgb(15, 100, 204).inverse('Hello!')
The following color models can be used:
rgb
- Example:chalk.rgb(255, 136, 0).bold('Orange!')
hex
- Example:chalk.hex('#FF8800').bold('Orange!')
ansi256
- Example:chalk.bgAnsi256(194)('Honeydew, more or less')
Browser support
Since Chrome 69, ANSI escape codes are natively supported in the developer console.
Windows
If you're on Windows, do yourself a favor and use Windows Terminal instead of cmd.exe
.
Origin story
colors.js used to be the most popular string styling module, but it has serious deficiencies like extending String.prototype
which causes all kinds of problems and the package is unmaintained. Although there are other packages, they either do too much or not enough. Chalk is a clean and focused alternative.
Related
- chalk-template - Tagged template literals support for this module
- chalk-cli - CLI for this module
- ansi-styles - ANSI escape codes for styling strings in the terminal
- supports-color - Detect whether a terminal supports color
- strip-ansi - Strip ANSI escape codes
- strip-ansi-stream - Strip ANSI escape codes from a stream
- has-ansi - Check if a string has ANSI escape codes
- ansi-regex - Regular expression for matching ANSI escape codes
- wrap-ansi - Wordwrap a string with ANSI escape codes
- slice-ansi - Slice a string with ANSI escape codes
- color-convert - Converts colors between different models
- chalk-animation - Animate strings in the terminal
- gradient-string - Apply color gradients to strings
- chalk-pipe - Create chalk style schemes with simpler style strings
- terminal-link - Create clickable links in the terminal
Maintainers
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: .github/security.md:1
- Info: Found linked content: .github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: .github/security.md:1
- Info: Found text in security policy: .github/security.md:1
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
0 existing vulnerabilities detected
Reason
Found 14/30 approved changesets -- score normalized to 4
Reason
0 commit(s) and 4 issue activity found in the last 90 days -- score normalized to 3
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/chalk/chalk/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/chalk/chalk/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/chalk/chalk/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:22
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Score
4.7
/10
Last Scanned on 2024-12-09
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More