# cli-alerts-arthur

> Cross platform CLI alerts with colors and colored symbols

Latest version **1.0.3** (published 2021-12-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install cli-alerts-arthur
pnpm add cli-alerts-arthur
yarn add cli-alerts-arthur
bun add cli-alerts-arthur
```

## 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-12-08 |
| First published | 2021-12-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Arthur Gamby |
| Maintainers | arthurgamby |
| Keywords | arthur gamby, arthur, gamby, cli alerts |

## Links

- npm: https://www.npmjs.com/package/cli-alerts-arthur
- npm.io page: https://npm.io/package/cli-alerts-arthur

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^4.0.0
- [cli-check-node](https://npm.io/package/cli-check-node.md) ^1.3.4

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-12-08
- 1.0.2 — 2021-12-07
- 1.0.1 — 2021-12-07
- 1.0.0 — 2021-12-07

## README

![cli-alerts-screenshot](./.github/screenshot.png)

 <br/>

# CLI ALERTS

> Use this CLI add some Joy and Color to your CLI

 <br/>

## Install

```js
npm install cli-alerts-arthur
```

 <br/>

## Usage

```js
const alert = require('cli-alerts-arthur');

// Provide the type, msg and name options
alert({type: 'success', msg: 'Everything finished!', name: 'DONE'});
// prints: ✔  DONE  Everything finished!

alert({type: 'info', msg: 'I love your CLI'});
// prints: ℹ  INFO  I love your CLI

alert({type: 'info', msg: 'Winter is coming', name: 'weather info'});
// prints: ℹ  WEATHER INFO  Winter is coming

alert({type: 'warning', msg: 'Fuel tank almost empty!'});
// prints: ⚠  WARNING  Fuel tank almost empty!

alert({type: 'error', msg: 'You dont have enough credits'});
// prints: ✖  ERROR  You dont have enough credits
```

<br/>

## API

### alert(options)

#### > options

Type: `object` <br>
Default: `{}`

You can specify the options below.

##### > type

Type: `string` <br>
Default: `error`

##### > msg

Type: `string` <br>
Default: `You forgot to define all options` (error message)

##### > name

Type: `string` <br>
Default: `' '`

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