JSPM

welcome-for-cli

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q21285F
  • License MIT

Welcome header for Node.js CLI

Package Exports

  • welcome-for-cli
  • welcome-for-cli/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (welcome-for-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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