About ntfy

ntfy is a command line utility (and to a degree, python library) for sending push notifications. It also can send a notification when a program finishes.

Unlike many existing utilities for Pushover or Pushbullet, it supports multiple backends.

Demo

Install

sudo pip install ntfy

Note: It is suggested to globally (as indicated above, without a virtualenv) install ntfy. It can be installed in a virtualenv, with caveats. Linux notifications requires --system-site-packages to be used and OS X notifications don't work at all.

Emoji Support 🎉

ntfy features emoji support, it is installable as an extra, just install like this:

sudo pip install ntfy[emoji]

XMPP Support

The xmpp module requires sleekxmpp. To install this extra install ntfy like this:

sudo pip install ntfy[xmpp]

Usage

# send a notification
ntfy send "Here's a notification!"

# send a notification with custom title (default is $USER@$HOST)
ntfy -t 'ntfy' send "Here's a notification with a custom title!"

# send a notification when the command `sleep 10` finishes
# this send the message '"sleep 10" succeeded in 0:10 minutes'
ntfy done sleep 10

Backends

Supported

• Pushover
• Pushbullet
• XMPP
• Linux Desktop Notifications
• Windows Desktop Notifications
• Mac OS X Notification Center

ToDo

• Prowl
• Airgram
• Pushjet
• Pushalot
• Boxcar
• Instapush

Config

ntfy is configured via a yaml config file stored at ~/.ntfy.yml. It requires at minimum 1 keys: backends & a config for any backend that requires one.

See the Configuration docs for more.

Example Config:

---
backends
    - pushbullet
pushbullet
    access_token: T0K3N

Testing

python setup.py test

Contributors

• dschep - Maintainer & Lead Developer
• danryder - XMPP Backend & emoji support