Skip to content

msaaddev/exit-cli

Repository files navigation

image

⚡️ exit-cli

version license downloads

A nice way to exit your command-line tools.

Features

  • Adds a nice exit message in your CLI using your repo and twitter link.
  • Notify users if a CLI update is available

Install

# install the package
npm install exit-cli

API

  • github (required)
  • twitter (required)
  • pkgJSON (optional) Add this if you want the package to notify for CLI updates

Usage

  • Just display the exit message
const end = require('exit-cli');

// without package.json file
await end({
	github: `https://github.com/msaaddev/exit-cli`,
	twitter: `https://twitter.com/msaaddev`
})
  • Also notify the user if an update is available for the CLI
const end = require('exit-cli');
const packageJSON = require('./package.json');

// with package.json file
await end({
	github: `https://github.com/msaaddev/exit-cli`,
	twitter: `https://twitter.com/msaaddev`,
	pkgJSON: packageJSON
})

⚡️ Other Projects

I have curated a detailed list of all the open-source projects I have authored. Do take out a moment and take a look.

🔑 License & Conduct