# task-notify

> Notifications from the command line

Latest version **0.1.2** (published 2015-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install task-notify
pnpm add task-notify
yarn add task-notify
bun add task-notify
```

Provides the command `tnotify`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2015-12-26 |
| First published | 2015-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Known vulnerabilities | 0 (+25 in 5 direct dependencies) |
| Install scripts | no |
| Author | Diego Guerra |
| Maintainers | dgoguerra |
| Keywords | cli, notification, notifier, notify, push, pushbullet, smtp |

## Links

- npm: https://www.npmjs.com/package/task-notify
- npm.io page: https://npm.io/package/task-notify

## Dependencies (11)

- [tmp](https://npm.io/package/tmp.md) ^0.0.28
- [read](https://npm.io/package/read.md) ^1.0.7
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [twilio](https://npm.io/package/twilio.md) ^2.8.0
- [request](https://npm.io/package/request.md) ^2.67.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [nodemailer](https://npm.io/package/nodemailer.md) ^1.10.0
- [sprintf-js](https://npm.io/package/sprintf-js.md) ^1.0.3
- [node-notifier](https://npm.io/package/node-notifier.md) ^4.4.0

## Recent versions

- 0.1.2 (latest) — 2015-12-26
- 0.1.1 — 2015-12-26
- 0.1.0 — 2015-12-26

## README

task-notify
===========

`tnotify` is a utility to send notifications and pipe command outputs to different third-party services.

The goal of this project is mainly to have a useful command line tool to easily notify when a task is done or something happened through different services, and also to play with different APIs out there.

It is oriented mainly to be used from the command line, but it could also be required and used within a Node project directly.

Installation
------------

```bash
npm install -g task-notify
which tnotify # /usr/local/bin/tnotify
```

Usage
-----

The currently supported services and options they require are:

| Name | Description | Options |
| ---- | ----------- | ------- |
| `desktop` | Open a system notification in your desktop. Calls directly [node-notifier](https://github.com/mikaelbr/node-notifier). | None |
| `pushbullet` | Push notes through your [Pushbullet](https://www.pushbullet.com/) account directly to your browser or phone. | `access_token` |
| `smtp` | A SMTP client. | `host`, `port`, `secure` (boolean), `username`, `password`, `from`, `to` |
| `stdout` | For testing, outputs the content to stdout. | None |
| `twilio` | [Twilio](https://www.twilio.com/) SMS API. | `account_sid`, `auth_token`, `service_sid`, `from`, `to` |

Each service's options can be provided directly through the command line:

```bash
$ tnotify msg -s pushbullet --pushbullet-access-token=TOKEN 'Hey there!'
```

or configured beforehand:

```bash
$ tnotify config -s pushbullet
Current values of an option are shown between brackets. Leave empty to maintain the current value.
Configuring 'pushbullet' service:
Access Token []: qwerty123456
Saved into '/Users/dgo/.tnotify/config.json'

# and from now on...
$ tnotify msg -s pushbullet 'Hey there!'
```

`tnotify` has 4 different actions:

```bash
# list existing services
$ tnotify list

# configure services
$ tnotify config -s desktop,pushbullet,smtp

# run a command and send its output through the selected services:
$ tnotify run -s desktop,pushbullet,smtp -- ls -alh

# send a message directly
$ tnotify msg -s desktop,pushbullet,smtp --title='Test Notification' 'Hey there!'

# 'msg' action is assumed. the command's piped output is used as the message to send
$ echo 'Hey there!' | tnotify -s desktop,pushbullet,smtp
```

License
-------
MIT license - http://www.opensource.org/licenses/mit-license.php

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