cli-welcome
Welcome customised header for Node.js CLI software
Install
npm install @tos_/cli-welcome
Usage
const welcome = require('@tos_/cli-welcome');
// Use it.
welcome({title: `Welcome CLI`, tagLine: `by Tawseef Ahmad`});
// OR with all the options set like this:
welcome({
title: `Welcome CLI`,
tagLine: `by Tawseef Ahmad`,
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.
Connect
