Inline docs Code Climate Build Status Coverage Status

Dependency Status Development Dependency Status

Node.js module for easy command line text styling.


Dependencies

  • None

Install

npm install opensoars_cls

API

cls(text, [color], [style])

Where text is the string or object to style, color is an optional color string and style is an optional style string or an array of style strings.

Example

const cls = require('opensoars_cls');

let styled_string = cls('Hello, world!', 'red', ['bold', 'underline']);

console.log(styled_string);

Options

  • 9 Colors
    • white
    • grey
    • black
    • blue
    • cyan
    • green
    • magenta
    • red
    • yellow
  • 5 Styles (if supported by your OS its terminal)
    • bold
    • italic
    • underline
    • inverse
    • strikethrough