https://github.com/msaaddev/exit-cli
⭐️ A nice way to end your command-line tools
https://github.com/msaaddev/exit-cli
automation cli command-line-tool javascript nodejs npm
Last synced: 2 months ago
JSON representation
⭐️ A nice way to end your command-line tools
- Host: GitHub
- URL: https://github.com/msaaddev/exit-cli
- Owner: msaaddev
- License: mit
- Created: 2021-06-30T21:19:28.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-23T13:46:02.000Z (almost 5 years ago)
- Last Synced: 2025-08-09T05:51:50.879Z (11 months ago)
- Topics: automation, cli, command-line-tool, javascript, nodejs, npm
- Language: JavaScript
- Homepage: https://twitter.com/msaaddev
- Size: 349 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# ⚡️ 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
```sh
# 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
})
```
## ⚡️ Other Projects
I have curated a [detailed list](https://github.com/msaaddev/open-source) of all the open-source projects I have authored. Do take out a moment and take a look.
## 🔑 License & Conduct
- MIT © [Saad Irfan](https://github.com/msaaddev)
- [Code of Conduct](https://github.com/msaaddev/exit-cli/blob/master/code-of-conduct.md)