Cross platform CLI Alerts with colors & colored symbols for success, info, warning, error.
Work on macOS, Linux, and Windows. [![DOWNLOADS](https://img.shields.io/npm/dt/cli-alerts?label=DOWNLOADS%20%20❯&colorA=6A788D&colorB=6A788D&style=flat)](https://www.npmjs.com/package/cli-alerts) [![Node.js CLI](https://img.shields.io/badge/-NodeCLI.com-gray.svg?colorB=6A788D&style=flat)](https://NodeCLI.com/?utm_source=FOSS) [![Learn VSCode](https://img.shields.io/badge/-VSCODE.pro-gray.svg?colorB=6A788D&style=flat)](https://VSCode.pro/?utm_source=FOSS) [![Sponsor](https://img.shields.io/badge/-Sponsor-gray.svg?colorB=6A788D&style=flat)](https://github.com/ahmadawais/sponsor?utm_source=FOSS) [![Follow @MrAhmadAwais on Twitter](https://img.shields.io/badge/FOLLOW%20@MRAHMADAWAIS%20%E2%86%92-gray.svg?colorA=6A788D&colorB=6A788D&style=flat)](https://twitter.com/mrahmadawais/)

# cli-alerts [![📟](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/install.png)](./../../) ## Install ```sh npm install cli-alerts ```
[![⚙️](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/usage.png)](./../../) ## Usage ```js const alert = require('cli-alerts'); // Provide the type, msg, and name options. alert({type: `success`, msg: `Everything finished!`}); // Prints: ✔ SUCCESS Everything finished! alert({type: `success`, msg: `Everything finished!`, name: `DONE`}); // Prints: ✔ DONE Everything finished! alert({type: `warning`, msg: `You didn't add something!`}); // Prints: ⚠ WARNING You didn't add something! alert({type: `info`, msg: `Awais is awesome!`}); // Prints: ℹ INFO Awais is awesome! alert({type: `error`, msg: `Something went wrong!`}); // Prints: ✖ ERROR Something went wrong! ```
[![📃](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/options.png)](./../../) ## API ### alert(options) #### ❯ options Type: `object`
Default: `{}` You can specify the options below. ##### ❯ type Type: `string`
Default: `error` ##### ❯ msg Type: `string`
Default: `You forgot to define all options.` (Error message) ##### ❯ name Type: `string`
Default: `''` (Empty string)
[![📝](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/log.png)](changelog.md) ## Changelog [❯ Read the changelog here →](changelog.md)
**KEY**: `📦 NEW`, `👌 IMPROVE`, `🐛 FIX`, `📖 DOC`, `🚀 RELEASE`, and `🤖 TEST` > _I use [Emoji-log](https://github.com/ahmadawais/Emoji-Log), you should try it and simplify your git commits._
[![📃](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/license.png)](./../../) ## License & Conduct - MIT © [Ahmad Awais](https://twitter.com/MrAhmadAwais/) - [Code of Conduct](code-of-conduct.md)
[![🙌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/connect.png)](./../../) ## Connect

(follow) To stay up to date on free & open-source software

(follow) To get #OneDevMinute daily hot tips & trolls

(subscribe) To tech talks & #OneDevMinute videos

(read) In-depth & long form technical articles

(connect) On the LinkedIn profile y'all

[![👌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/sponsor.png)](./../../) ## Sponsor Me ([Ahmad Awais](https://twitter.com/mrahmadawais/)) and my incredible wife ([Maedah Batool](https://twitter.com/MaedahBatool/)) are two engineers who fell in love with open source and then with each other. You can read more [about me here](https://ahmadawais.com/about). If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate. [![Ahmad on Twitter](https://img.shields.io/twitter/follow/mrahmadawais.svg?style=social&label=Follow%20@MrAhmadAwais)](https://twitter.com/mrahmadawais/) ### [NodeCLI.com][n] — Learn to build Node.js CLI Automation > This repository is part of the [NodeCLI.com][n] course. After building hundreds of developer automation tools used by millions of developers, I am sharing exactly how you can do it yourself with minimum effective effort. Learn to build Node.js & JavaScript based CLI (Command Line Interface) apps. Automate the grunt work, do more in less time, impress your manager, and help the community. → I'm sharing it all in this online video course. [Node CLI Automation without wasting a 1,000 hours][n] →

[![Node CLI Course](https://raw.githubusercontent.com/ahmadawais/stuff/master/nodecli/featured.jpg)][n] [![Node CLI](https://img.shields.io/badge/-NodeCLI.com%20%E2%86%92-gray.svg?colorB=488640&style=flat)][n] [n]: https://NodeCLI.com?utm_source=github&utm_medium=referral&utm_campaign=ahmadawais/cli-meow-help [![Awais on Twitter](https://raw.githubusercontent.com/ahmadawais/stuff/master/sponsor/sponsor.jpg)](https://github.com/AhmadAwais/sponsor)