ntfy

simple pub-sub push notification service

TLDR

Publish a message to a topic

$ ntfy publish [topic] "[message]"

Publish with title and priority

$ ntfy publish --title "[title]" --priority [high] [topic] "[message]"

Publish with emoji tags

$ ntfy publish --tags "[warning,skull]" [topic] "[message]"

Subscribe to a topic

$ ntfy subscribe [topic]

Subscribe and execute command on message

$ ntfy subscribe [topic] "[command]"

Run the ntfy server

$ ntfy serve

ntfy is a simple HTTP-based pub-sub notification service. It allows sending push notifications to phones and desktops via topics. The same binary serves as both the client (publish/subscribe) and the server.Messages can be published from the CLI, via curl, or any HTTP client. Subscribers receive real-time push notifications on mobile apps, the web interface, or the command line.

PARAMETERS

publish TOPIC [MESSAGE]

Send notification to a topic. Aliases: send, trigger, pub.

subscribe TOPIC [COMMAND]

Subscribe to topic notifications. Optionally run command on message arrival.

serve

Run the ntfy server (self-hosted).

--priority LEVEL

Set priority: min, low, default, high, max (or 1-5).

--title TITLE

Set notification title.

--tags TAGS

Add emoji tags (comma-separated).

--attach URL

Attach a file via URL.

--server URL

Specify ntfy server URL (default: ntfy.sh).

--user USER

Username for authentication.

--since TIME

Receive messages since time or message ID (with subscribe).

--help

Display help information.

CONFIGURATION

~/.config/ntfy/client.yml

Client configuration including default-host for self-hosted servers.

INSTALL

sudo apt install ntfy

sudo apk add ntfy

brew install ntfy

nix profile install nixpkgs#ntfy

CAVEATS

Requires ntfy.sh or a self-hosted server. Topics are public by default unless access control is configured. Free tier on ntfy.sh has rate limits.

HISTORY

ntfy was created by Philipp C. Heckel as a simple HTTP-based pub-sub notification service.