@thzero/library_cli

library_cli

A cli tool for the opinonated @thzero/library packages.

Installation

CLI

The tool includes a command line interface application that performs a couple of tasks

• Generate short UUIDs
• Update version information in a package.json

Usage

library-cli <options>

--help, --h :: help

--version, --v :: cli version

--generate :: generates a unique ids, default is a UUID v4
  --number, --n <value> :: the number of ids to generate
  --long :: generates a long UUID v4
  --nano :: generates a nanoid
  --nanoshort, --ns :: generates a nanoid with length of 16
  --short :: generates a short UUID v4
  --length, --l :: length of a nanoid, default is 21
  --alphanum, --a :: custom alphanumeric only alphabet for nanoid
  --custom, --c :: custom alphabet for a nanoid
  --number, --n :: number of ids to generate, max 100

--updateversion :: updates the version
  --major, --ma <major> :: sets the major version, defaults to the current value or 0
  --minor, --mi <minor> :: sets the minor version, defaults to the current value or 0
  --patch, --p <patch> :: sets the patch, defaults to the current value or 0
  --patch_inc, --pi :: increments the patch by one
  --date, --d <date> :: sets the version date in MM/DD/YYYY format, defaults to current date
  --silent, --s :: does not prompt

Help

node -r esm index.js --help
// from within an application
./node_modules/.bin/library-cli --help

Version

node -r esm index.js --version
// from within an application
./node_modules/.bin/library-cli --version

The version will utilize the following properties in the package.json file.

  "version": "<major>.<minor>.<patch>",
  "version_major": <major>,
  "version_minor": <minor>,
  "version_patch": <patch; to increment must be an integer value>,
  "version_date": "<date in MM/DD/YYY>",

Generate UUID examples

Single UUID

// installed globally
library-cli --generate
// installed locally
./node_modules/.bin/library-cli --generate

Multiple UUIDs

// installed globally
library-cli --generate --n 5
// installed locally
./node_modules/.bin/library-cli --generate --n 5

Update Version examples

Increment patch

// installed globally
library-cli --updateversion --pi
// installed locally
./node_modules/.bin/library-cli --updateversion --pi"

Update date

// installed globally
library-cli--updateversion --d '7/15/2020'
// installed locally
./node_modules/.bin/library-cli --updateversion --d '7/15/2020'"