Skip to content

AstroCB/mnotify

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

mnotify

NPM

Test mnotify

mnotify is a simple command-line utility for sending notifications through Facebook Messenger. It takes input from stdin and sends it to a pre-configured recipient (presumably, you). It's great for sending yourself build notifications, cron job alerts, or anything else that is worthy of a ping.

It works by accepting arbitrary input from stdin, and then sending that data to a preconfigured user over Messenger. Here's an example:

do_some_long_running_task && echo "Task done" | mnotify

You'll receive a message when the task has finished. For a more practical example, you can receive notifications when a build is finished:

make giant_codebase | mnotify

Then, you can go grab a coffee or take a walk while your build runs, and you'll get the entire log sent to your phone when it finishes (or fails 😞).

Lastly, you can use mnotify to send you alerts when certain jobs run (e.g. cron jobs or service disruption events):

59 19 * * * ~/scripts/get-daily-covid-stats | mnotify

Installation

You can install from npm:

npm install -g mnotify

Once installed, you must configure mnotify before using it:

mnotify --init

This will allow you to log in with the accounts required to send and receive notifications (which can be the same) and cache the resulting session to prevent you from having to log in every time. You'll also be given the option to store your account credentials to automatically retry logging in when your session expires. This is recommended, as it minimizes maintenance, but it requires storing your credentials in plaintext.

This utility respects the XDG Base Directory specification, and will store all of the configuration information set at initialization in the directory specified by the XDG_CONFIG_HOME environment variable, if it exists. Otherwise, it will be stored in $HOME/.config.

If you need to alter any of your login information, simply run the init command again.

For more information and commands, see

mnotify --help

Programmatic usage

mnotify is primarily intended for use as a command-line utility, but it can also be used programmatically in Node.js scripts. You can easily send a notification using the notify function exposed from the main module:

const mnotify = require("mnotify");
if (somethingHasGoneVeryWrong) {
    mnotify.notify("uh oh");
}

This will send an alert to the pre-configured recipient from the sender's account, exactly as if triggered via CLI. If it is unable to deliver the notification due to a missing configuration file or failed login, the call to notify will throw, allowing you to fall back on other notification methods.

As with the previous commands, you must initialize mnotify before this will work; if you've already done this via mnotify --init, you are good to go, but you can also do it programmatically:

Note

The code below is just an example for testing purposes; I don't recommend storing your login credentials in plaintext in any source file. In real world usage, you should store the required values below as environment variables or in some external gitignored file that won't be accidentally committed. When you call init, you should read in these values from the file or environment to pass as the first parameter.

mnotify.init({
    "senderEmail": "sender@example.com",
    "senderPass": "*******",
    "receiverEmail": "receiver@example.com",
    "receiverPass": "*******",
    "storeSenderCredentials": true
}, err => {
    if (!err) {
        mnotify.notify("Initialized successfully!");
    } else {
        console.error("Failed to initialize; oof");
    }
});

About

A command-line utility for sending alerts and notifications through Facebook Messenger.

Topics

Resources

License

Stars

Watchers

Forks