node package manager

colors

colors.js Build Status

get color and style in your node.js console

Demo

Installation

npm install colors

colors and styles!

text colors

  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white
  • gray
  • grey

background colors

  • bgBlack
  • bgRed
  • bgGreen
  • bgYellow
  • bgBlue
  • bgMagenta
  • bgCyan
  • bgWhite

styles

  • reset
  • bold
  • dim
  • italic
  • underline
  • inverse
  • hidden
  • strikethrough

extras

  • rainbow
  • zebra
  • america
  • trap
  • random

Usage

By popular demand, colors now ships with two types of usages!

The super nifty way

var colors = require('colors');
 
console.log('hello'.green); // outputs green text 
console.log('i like cake and pies'.underline.red) // outputs red underlined text 
console.log('inverse the color'.inverse); // inverses the color 
console.log('OMG Rainbows!'.rainbow); // rainbow 
console.log('Run the trap'.trap); // Drops the bass 
 

or a slightly less nifty way which doesn't extend String.prototype

var colors = require('colors/safe');
 
console.log(colors.green('hello')); // outputs green text 
console.log(colors.red.underline('i like cake and pies')) // outputs red underlined text 
console.log(colors.inverse('inverse the color')); // inverses the color 
console.log(colors.rainbow('OMG Rainbows!')); // rainbow 
console.log(colors.trap('Run the trap')); // Drops the bass 
 

I prefer the first way. Some people seem to be afraid of extending String.prototype and prefer the second way.

If you are writing good code you will never have an issue with the first approach. If you really don't want to touch String.prototype, the second usage will not touch String native object.

Disabling Colors

To disable colors you can pass the following arguments in the command line to your application:

node myapp.js --no-color

Console.log string substitution

var name = 'Marak';
console.log(colors.green('Hello %s'), name);
// outputs -> 'Hello Marak' 

Custom themes

Using standard API

 
var colors = require('colors');
 
colors.setTheme({
  silly: 'rainbow',
  input: 'grey',
  verbose: 'cyan',
  prompt: 'grey',
  info: 'green',
  data: 'grey',
  help: 'cyan',
  warn: 'yellow',
  debug: 'blue',
  error: 'red'
});
 
// outputs red text 
console.log("this is an error".error);
 
// outputs yellow text 
console.log("this is a warning".warn);

Using string safe API

var colors = require('colors/safe');
 
// set single property 
var error = colors.red;
error('this is red');
 
// set theme 
colors.setTheme({
  silly: 'rainbow',
  input: 'grey',
  verbose: 'cyan',
  prompt: 'grey',
  info: 'green',
  data: 'grey',
  help: 'cyan',
  warn: 'yellow',
  debug: 'blue',
  error: 'red'
});
 
// outputs red text 
console.log(colors.error("this is an error"));
 
// outputs yellow text 
console.log(colors.warn("this is a warning"));
 

You can also combine them:

var colors = require('colors');
 
colors.setTheme({
  custom: ['red', 'underline']
});
 
console.log('test'.custom);

Protip: There is a secret undocumented style in colors. If you find the style you can summon him.

We ♥ your boss

Selectively mirror the npm registry inside your firewall. Filter packages based on security, licensing, code quality and more. Build awesome stuff faster. Try npm Enterprise for free…

how? learn more

Collaborators list

Stats

Try it out

Keywords

ansi, terminal, colors

Dependencies

None

Dependents (8319)

generator-accelerate-droplet-setup, clti, penny, service-log-reporter, noderest, logit, grunt-saucelabs-qunit, chopjs, jwalk, restytest, daisy, add-to-jira-sprint, nappy, git-azure, functional-docs, tcase, speed-dial, tcpmole, slowhost, otis, toast, tsunami-server, v2ex, hn-cli, bystander, push_server, djinn, doxumentor, peppermint, logStream, sql-builder, niftylettuce-replace, jshint-tap-simple, crayon, getbot, acs-qe, overlord, dynasaur, platypus-grunt-image-normalize, less-livereload, pavlov, keepitup, lofty, node-mockey, dokumentiere, jirest, yui-repl, weo-http-proxy, pegram, colored, and more