csalam07 / welcome-for-cli

Welcome header for Node.js CLI.

welcome-for-cli

Welcome header for Node.js CLI software.

Installation

npm

npm install welcome-for-cli

Yarn

yarn add welcome-for-cli

Usage

import welcome from 'welcome-for-cli';

// Use it.
welcome({ title: `Welcome CLI`, tagLine: `by csalam07` });

// OR with all the options set like this:
welcome({
  title: `Welcome CLI`,
  tagLine: `by csalam07`,
  bgColor: `#FADC00`,
  color: `#000000`,
  bold: true,
  clear: true,
  version: `v1.0`,
});

API

welcome(options)

❯ options

Type: object
Default: {}

You can specify the options below.

❯ title

Type: string

CLI title with background color highlight.

❯ tagLine

Type: string

CLI tag line in front of the title without highlight but dimmed.

❯ description

Type: string

CLI description below the title.

clear

Type: boolean
Default: true

Clear console.

bold

Type: boolean
Default: true

Bold heading text.

bgColor

Type: string
Default: #ffffff

Background color highlight for heading.

color

Type: string
Default: true

Text color for heading.

version

Type: string
Default: (empty string)

Print version text.

License

• MIT © cslam07