cli-welcome

 

> Welcome header for Node.js CLI software.


Install

``sh
npm install cli-welcome
`

![⚙️](./../../)

Usage

`js
const welcome = require('cli-welcome');

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

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

!img

![📃](./../../)

API

$3

#### ❯ 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.

![📝](changelog.md)

Changelog

❯ Read the changelog here →

KEY: 📦 NEW, 👌 IMPROVE, 🐛 FIX, 📖 DOC, 🚀 RELEASE, and ✅ TEST`

> _I use Emoji-log, you should try it and simplify your git commits._


License & Conduct

- MIT © Ahmad Awais
- Code of Conduct


Connect


Sponsor

Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.

- 🌟 $9.99/month (recommended) ❯ Two cups of Caffè latte (coffee) every month →
- 🚀 $99.99 (one-time sponsor) ❯ Support an hour of open-source code →
- 🔰 $49.99 (one-time sponsor) ❯ Support an hour of maintenance →
- ☕️ $9.99 (one-time sponsor) ❯ Lunch/coffee →

Or you can back me by checking out my super fun video course. As developers, we spend over 200 Hrs/month with our code editors — it's only fair to learn your next editor deeply. This course will save you 15-20 hours every month. Become a VSCode Power User →

VSCODE