Skip to content
/ ntfy Public
forked from dschep/ntfy

A utility for sending notifications, on demand and when commands finish.

License

Notifications You must be signed in to change notification settings

danryder/ntfy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About ntfy

Version Downloads Build Coverage

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

Click here for full demo

https://raw.githubusercontent.com/dschep/ntfy/master/demo/ntfy-demo.gif

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.

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.2 minutes'
ntfy done sleep 10

Backends

Supported

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

ToDo

Config

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

For full docs consult the wiki

Example Config

{
    "backends": ["pushbullet"],
    "pushbullet": {"access_token": "<redacted>"}
}

Testing

python setup.py test

About

A utility for sending notifications, on demand and when commands finish.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%