eye-candy-cli

Various eye-candy gadgets for your Node.js command-line interface.

About

eye-candy-cli is a set of promisified tools that make your Node.js CLI look pretty and funny.

This project is an aggregation of many other modules. All the credits of what you'll get on your CLI have to go to the creators of those modules. See in the dependencies in package.json for more info about those modules. The idea behind this aggregation is that some of the tools may be mixed together for even better fun! See the demos folder for examples and insights about mixing the tools together.

Beyond the aggregation of those modules, most of them are made available with Promises.

Download / install

eye-candy-cli is available on NPM. To get it, just run:

npm install eye-candy-cli

Usage and notes

boxen

Notes:

• this feature uses boxen.
• this method returns a Promise.
• you can color the input with chalk.

Usage:

var ecc = require('eye-candy-cli');
ecc.boxen({
  text: 'my-text',
  borderColor: 'red',
  padding: 2,
  margin: 1
}).then(function(data) {
  console.log(ecc.chalk.yellow(data));
});

cat-ascii-faces

Notes:

• this feature uses cat-ascii-faces.
• this method returns a Promise.
• you can color the output with chalk.

Usage:

var ecc = require('eye-candy-cli');
ecc.catAsciiFaces().then(function(data) {
  console.log(ecc.chalk.yellow(data));
});

cat-me

Notes:

• this feature uses cat-me.
• this method returns a Promise.
• you can color the output with chalk.

Usage:

var ecc = require('eye-candy-cli');
ecc.catMe('nyan').then(function(data) {
  console.log(ecc.chalk.grey(data));
});

chalk

Notes:

• this feature uses chalk.
• this method does not return a Promise.

Usage:

console.log(ecc.chalk.cyan('eye-candy-cli'));

cli-table

Notes:

• this feature uses cli-table.
• this method returns a Promise.

Usage:

var Table = require('cli-table');
var table = new Table({
  head: ['TH 1 label', 'TH 2 label']
  , colWidths: [100, 200]
});
table.push(
  ['First value', 'Second value']
  , ['First value', 'Second value']
);
ecc.cliTable(table).then(function(data) {
  console.log(ecc.chalk.cyan(data));
});

cool-ascii-faces

Notes:

• this feature uses cool-ascii-faces.
• this method returns a Promise.
• you can color the output with chalk.

Usage:

var ecc = require('eye-candy-cli');
ecc.coolAsciiFaces().then(function(data) {
  console.log(ecc.chalk.magenta(data));
});

cowsay

Notes:

• this feature uses cowsay.
• this method returns a Promise.
• you can color the input and the output with chalk. While coloring the input adjusts the color of the sentence given in the txt parameter, coloring the output will color the entire cow (except for the sentence given in the txt parameter).

Usage:

var ecc = require('eye-candy-cli');
ecc.cowsay({
  text: ecc.chalk.cyan('eye-candy-cli'),
  e: 'oO',
  T: 'U '
}).then(function(data) {
  console.log(ecc.chalk.yellow(data));
});

dogefy

Notes:

• this feature uses dogefy.
• this method returns a Promise.
• you can color the output with chalk.

Usage:

var ecc = require('eye-candy-cli');
ecc.dogefy('Peccp').then(function(data) {
  console.log(ecc.chalk.magenta(data));
});

figlet

Notes:

• this feature uses figlet.
• this method returns a Promise.
• you can color the output with chalk.

Usage:

var ecc = require('eye-candy-cli');
ecc.figlet({
  txt: 'eye-candy-cli',
  font: 'Small',
  horizontalLayout: 'default',
  verticalLayout: 'default'
}).then(function(data) {
  console.log(ecc.chalk.blue(data));
});

qrcode

Notes:

• this feature uses qrcode-terminal.
• this method returns a Promise.

Usage:

ecc.qrcode({
  txt: 'eye-candy-cli',
  errorLevel: 'Q'
}).then(function(data) {
  console.log(data);
});

sparkly

Notes:

• this feature uses sparkly.
• this method returns a Promise.
• you can color the output with chalk.

Usage:

ecc.sparkly([
  0, 3, 5, 8, 4, 3, 4, 10
]).then(function(data) {
  console.log(ecc.chalk.green(data));
});

yosay

Notes:

• this feature uses yosay.
• this method returns a Promise.
• you can color the input with chalk. Coloring the input adjusts the color of the sentence given in the only parameter.

Usage:

ecc.yosay(ecc.chalk.cyan('eye-candy-cli')).then(function(data) {
  console.log(data);
});