# terminal-mailbreachchecker

> This a school project aimed at creating and implementing a cli that tells you if your email has been breached or not and which are the website concerned by those breaches.

Latest version **1.1.1** (published 2019-01-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install terminal-mailbreachchecker
pnpm add terminal-mailbreachchecker
yarn add terminal-mailbreachchecker
bun add terminal-mailbreachchecker
```

Provides the command `pwned`.

## 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.1.1 |
| Published | 2019-01-24 |
| First published | 2019-01-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | olivierk95 |

## Links

- npm: https://www.npmjs.com/package/terminal-mailbreachchecker
- Repository: https://github.com/olivierk95/nodejs_cli
- Homepage: https://github.com/olivierk95/nodejs_cli#readme
- Issues: https://github.com/olivierk95/nodejs_cli/issues
- npm.io page: https://npm.io/package/terminal-mailbreachchecker

## Dependencies (5)

- [ora](https://npm.io/package/ora.md) ^3.0.0
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [figlet](https://npm.io/package/figlet.md) ^1.2.1
- [email-validator](https://npm.io/package/email-validator.md) ^2.0.4

## Recent versions

- 1.1.1 (latest) — 2019-01-24
- 1.1.0 — 2019-01-22
- 1.0.0 — 2019-01-21

## README

This a school project aimed at creating and implementing a cli that tells you if your email has been breached or not and which are the website concerned by those breaches.

## Install and Usage

```console
$ npm install terminal-mailbreachchecker
```

Simple usage in terminal:

```console
$ pwned test@test.com
```

## Dependencies

In order to add a bit of fun, other node packages have been added so that the experience of wandering if one email has possible breaches or not is funnier.

* [**axios**](https://github.com/axios/axios) : make the HTTP request to the API of the website [Have I Been Pwned](https://haveibeenpwned.com/) and return a JSON object with the breaches.
* [**email-validator**](https://github.com/manishsaraan/email-validator) : check if it is a valid email entry or if it does not respect basic 
* [**chalk**](https://github.com/chalk/chalk/releases/tag/v2.0.0) : make the response returned in color to illustrate if it is whether an error, a breach or a no-breach.
* [**ora**](https://travis-ci.org/sindresorhus/ora) : enables to make a small animation while loading the results and processing the request to the API.
* [**figlet**](https://travis-ci.org/patorjk/figlet.js) : render a stylised text when the response come in the terminal.


## Release History
* 2019.01.22 v1.1.0 packages figlet, chalk and ora added.
* 2019.01.21 v1.0.0 basic application without any packages except email-validator.

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