@friedrith/notify

notify

A easy-to-use command line interface to notify you when a very long terminal process is finished.

How to install

$ npm install -g @friedrith/notify

# or with yarn
$ yarn add --global @friedrith/notify

How to use?

$ <command to wait> ; notify

$ notify -h # for help

How to configure?

You can customize the notification on the fly

$  <command to wait> ; notify --adapter native --message "Customized message"

You can also use a configuration file :

{
  "adapter": "native",
  "message": "Customized message"
}

By default, notify tries to load configuration file located in /home/<user>/.notify but you can specify the path:

$  <command to wait> ; notify --config <path>

Adapters

Adapters are the way to display the notification. By default, only the native os notification systems are enabled but you can setup new adapters like Slack for example.

Do not hesitate to propose new adapters like Microsoft team, facebook, sms, etc.

Slack

The first step is to create an Slack app on your slack workspace and to authorize incoming webhooks. You should get a webhook url.

Then

$  <command to wait> ; notify --adapter slack --webhook <webhook>

or in your configuration file :

{
  "adapter": "slack",
  "webhook": "<webhook>"
}

Changelog

0.1.1 (2019-09-13)

Bug Fixes

• fix lint config (543ab89)
• fix prettier on program file (ae74bbb)

Features

• add notify with native and slack notification (2470198)