# exit-cli

> A nice way to end your command line tool

Latest version **1.0.3** (published 2021-07-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install exit-cli
pnpm add exit-cli
yarn add exit-cli
bun add exit-cli
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-07-01 |
| First published | 2021-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Saad Irfan |
| Maintainers | msaaddev |
| Keywords | command line tool, cli, footer, cli exit, Saad Irfan, msaaddev, nodejs cli, update check, notify update |

## Links

- npm: https://www.npmjs.com/package/exit-cli
- Repository: https://github.com/msaaddev/exit-cli
- Homepage: https://github.com/msaaddev/exit-cli#readme
- Issues: https://github.com/msaaddev/exit-cli/issues
- npm.io page: https://npm.io/package/exit-cli

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.6
- [update-check](https://npm.io/package/update-check.md) ^1.5.4

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-07-01
- 1.0.2 — 2021-06-30
- 1.0.1 — 2021-06-30
- 1.0.0 — 2021-06-30

## README

![image](assets/image.png)

# ⚡️ exit-cli

![version](https://img.shields.io/npm/v/exit-cli?color=%236445F6)
![license](https://img.shields.io/npm/l/exit-cli?color=%236445F6)
![downloads](https://img.shields.io/npm/dt/exit-cli?color=%236445F6)

>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

<br>

<img src="./assets/suitcase.png" width="10%" />

## Install

```sh
# install the package
npm install exit-cli
```

<br>

<img src="./assets/api.png" width="10%" />

## API

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

<br>

<img src="./assets/rocket.png" width="10%" />

## 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](https://github.com/msaaddev)
- [Code of Conduct](https://github.com/msaaddev/exit-cli/blob/master/code-of-conduct.md)

---
_Source: https://npm.io/package/exit-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
