Skip to main content

A utility for sending push notifications

Project description

# 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.

## Usage
```

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

# send a notification with custom title (default is $USER@$HOST)
ntfy send -t 'ntfy' "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
- [x] [Pushover](https://pushover.net)
- [x] [Pushbullet](https://pushbullet.com)
- [x] Linux Desktop Notifications (notify-send)
- [ ] [Prowl](http://www.prowlapp.com)
- [ ] [Airgram](http://www.airgramapp.com)
- [ ] [Pushjet](https://pushjet.io)
- [ ] [Pushalot](https://pushalot.com)
- [ ] [Boxcar](https://boxcar.io)
- [ ] [Instapush](https://instapush.im)
- [ ] Mac OS X Notification Center
- [ ] Windows Desktop Notifications?

## Config
`ntfy` is configured via a json config file stored at `~/.ntfy.json`. It
requires at minimum 2 keys: backend & a config for that backend.

### Example Config
```
{
"backend": "pushbullet",
{"pushbullet": {"access_token": "<redacted>"}}
}
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ntfy-0.1.1.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file ntfy-0.1.1.tar.gz.

File metadata

  • Download URL: ntfy-0.1.1.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ntfy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0e2de025bcd601bedbf4cc90e16fae54f870cfc629c4d0a0e69505f49ca0725c
MD5 3c63a67b7d88f29a9740ba1a77e176a1
BLAKE2b-256 947e9704a1580e4837bdf508d86ac85800a7e2696e582cdf20257621898a07f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page