Skip to content

ಠ_ಠ Terminal string styling done right.

Notifications You must be signed in to change notification settings

ZechyW/colors-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

colors-cli

Build Status

Terminal string styling done right. ಠ_ಠ

Install with npm:

npm install colors-cli --save-dev

Styles

boldfaintitalicunderlineblinkoverlineinverseconcealstrike

Colors

ForegroundBackgroundBright ForegroundBright Background
blackblack_b black_btblack_bbt
redred_b red_btred_bbt
greengreen_b green_btgreen_bbt
yellowyellow_b yellow_btyellow_bbt
blueblue_b blue_btblue_bbt
magentamagenta_b magenta_btmagenta_bbt
cyancyan_b cyan_btcyan_bbt
whitewhite_b white_btwhite_bbt

Basic usage:

Output colored text:

var color = require('colors-cli')
console.log( color.red('hello') )

Best way is to predefine needed stylings and then use it:

var color = require('colors-cli/safe')
var error = color.red.bold;
var warn = color.yellow;
var notice = color.blue;
console.log(error('Error!'));
console.log(warn('Warning'));
console.log(notice('Notice'));

Styles can be mixed:

var color = require('colors-cli/safe')
console.log( color.red.bold.underline('hello') )
require('colors-cli/toxic')
console.log( 'hello'.green );
console.log( 'hello'.green.black_b.underline );

ANSI 256 colors

Support ANSI 256 colors. [0 - 255], The rules of method name.

  • Foreground x32
  • Background xb32
var color = require('colors-cli/safe')
console.log( color.x45.bold.underline('hello') )

require('colors-cli/toxic')
console.log( 'hello'.x23.underline );
console.log( 'hello'.green.xb34.underline );

Use the command line

 Usage: colors

 Options:

   --black  => black
   --black_b  => black_b
   --red  => red
   ...

 Examples:

   colors --red "\nhello world" --bold,underline,yellow "wcj"
   colors --green,bold "\nhello world"
   colors --x12,bold "hello world"

Reference

The ANSI Escape sequences control code screen.

echo -e "\033[31;41;4m something here 33[0m"

\033 As the escape character, inform the terminal to switch to the escape mode.
[ The beginning of the CSI.
m Make the action to be performed.
; ASCII code separator.

About

ಠ_ಠ Terminal string styling done right.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • JavaScript 100.0%