msaaddev
⚡️ exit-cli
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
`js 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
```js
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
})
🔑 License & Conduct
- MIT © Saad Irfan
- Code of Conduct