Chalk

Terminal string styling done right

CLI
chalk/chalkchalk

README



Chalk



Terminal string styling done right

Coverage Status npm dependents Downloads run on repl.it

undefined




Sindre Sorhus' open source work is supported by the community on GitHub Sponsors

Special thanks to:





Strapi
Strapi is the leading open-source headless CMS.
It’s 100% JavaScript, fully customizable, and developer-first.


StackAid
Fund your open source dependencies





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


  1. ```sh
  2. npm install chalk
  3. ```

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


  1. ```js
  2. import chalk from 'chalk';

  4. console.log(chalk.blue('Hello world!'));
  5. ```

Chalk comes with an easy to use composable API where you just chain and nest the styles you want.

  1. ```js
  2. import chalk from 'chalk';

  4. const log = console.log;

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

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

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

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

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

  25. // ES2015 template literal
  26. log(`
  27. CPU: ${chalk.red('90%')}
  28. RAM: ${chalk.green('40%')}
  29. DISK: ${chalk.yellow('70%')}
  30. `);

  32. // Use RGB colors in terminal emulators that support it.
  33. log(chalk.rgb(123, 45, 67).underline('Underlined reddish color'));
  34. log(chalk.hex('#DEADED').bold('Bold gray!'));
  35. ```

Easily define your own themes:

  1. ```js
  2. import chalk from 'chalk';

  4. const error = chalk.bold.red;
  5. const warning = chalk.hex('#FFA500'); // Orange color

  7. console.log(error('Error!'));
  8. console.log(warning('Warning!'));
  9. ```

Take advantage of console.log string substitution:

  1. ```js
  2. import chalk from 'chalk';

  4. const name = 'Sindre';
  5. console.log(chalk.green('Hello %s'), name);
  6. //=> 'Hello Sindre'
  7. ```

API


### chalk.`