cli-welcome

cli-welcome

Welcome header for Node.js CLI software.

Install

npm install cli-welcome

Usage

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

// Use it.
welcome(`Welcome CLI`, `by Ahmad Awais`);
welcome(`Welcome CLI`, `by Ahmad Awais`, { bgColor: `#FADC00`, color: `#000000` bold: true, clear: true, version: `v1.0`});

API

welcome(heading, subHeading, options?)

❯ heading

Type: string

CLI heading with background color highlight.

❯ subHeading

Type: string

CLI sub heading without highlight but dimmed.

❯ options

Type: object
Default: {} (optional)

You can specify the options below.

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.

newLine

Type: boolean
Default: false

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

 (follow) To stay up to date on free & open-source software

 (follow) To get #OneDevMinute daily hot tips & trolls

 (subscribe) To tech talks & #OneDevMinute videos

 (read) In-depth & long form technical articles

 (connect) On the LinkedIn profile y'all

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

Changelog

RELEASE: 1.2.0

📦 New Line d1a50f7

👌 Tests 9bd78dd

📖 Changelog update a12abaa

📖 Changelog update ff244d8

<br> <br> <img src="https://raw.githubusercontent.com/ahmadawais/stuff/master/changelog/dark-hr.png#gh-dark-mode-only" alt="hr" /> <img src="https://raw.githubusercontent.com/ahmadawais/stuff/master/changelog/light-hr.png#gh-light-mode-only" alt="hr" /> <br>