Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: a298d526d0
Fetching contributors…

Cannot retrieve contributors at this time

file 58 lines (39 sloc) 3.069 kb

Colouring the Command-Line

When working on the command line, it can be both fun and extremely useful to colorize one's output. To colorize console output, you need to use ANSI escape codes. The module colors.js, available on npm, provides an extremely easy to use wrapper that makes adding colors a breeze.

First, install it to the directory you'd like to work in.

 $ cd mydir
 $ npm install colors

Now open up a little test script for yourself, and try something like this:

 var colors = require('colors'),
     stringOne = 'This is a plain string.',
     stringTwo = 'This string is red.'.red,
     stringThree = 'This string is blue.'.blue;

 console.log(stringOne.green);
 console.log(stringOne.yellow);

 console.log(stringTwo);
 console.log(stringThree);

 console.log(stringTwo.magenta);
 console.log(stringThree.grey.bold);

There are several things to take note of here - first, the string object has been prototyped, so any color may be added simply by adding the property to the string! It works both on string literals and on variables, as shown at the top of the example above.

Notice, also, from the second pair of console.log statements, that once set, a color value persists as part of the string. This is because under the hood, the proper ANSI color tags have been prepended and appended as necessary - anywhere the string gets passed where ANSI color codes are also supported, the color will remain.

The last pair of console.log statements are probably the most important. Because of the way colors.js and ANSI color codes work, if more than one color property is set on a string, only the first color property to be set on the string takes effect. This is because the colors function as 'state shifts' rather than as tags.

Let's look at a more explicit example. If you set the following properties with colors.js:

 myString.red.blue.green

You can think of your terminal saying to itself, "Make this green. No, make this blue. No, make this red. No more color codes now? Red it is, then." The codes are read in the reverse order, and the last/'innermost' is applied. This can be extremely useful if you're using a library that sets its own default colors that you don't like - if you set a color code yourself on the string you pass in to the library, it will supersede the other author's color code(s).

The last thing to note is the final line of the example script. While a color code was set previously, a 'bold' code was not, so the example was made bold, but not given a different color.

One last thing: the colors can look quite different in different terminals - sometimes, bold is bold, sometimes it's just a different color. Try it out and see for yourself!

For reference, here's the full list of available colors.js properties.

  • bold
  • italic
  • underline
  • inverse
  • yellow
  • cyan
  • white
  • magenta
  • green
  • red
  • grey
  • blue
  • rainbow

Some people may tell you that colors.js is haunted, but those people are just trolls... right?

Something went wrong with that request. Please try again.