# dschep/ntfy

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/dschep-ntfy).**

4,959 stars · 217 forks · Python · GPL-3.0

## Links

- GitHub: https://github.com/dschep/ntfy
- Homepage: http://ntfy.rtfd.io
- awesome-repositories: https://awesome-repositories.com/repository/dschep-ntfy.md

## Topics

`bash` `linux` `macos` `notifications` `push-notifications` `windows` `zsh`

## Description

ntfy is a shell notification utility and multiplatform notification router designed to alert users when long-running commands finish executing. It functions as a command completion notifier that dispatches messages to desktop or mobile devices based on process duration and terminal focus.

The project is an extensible notification framework that integrates third-party API push services and custom notification modules through a standard function signature. This modular architecture allows for routing alerts across various chat platforms, push services, and system-level backends.

The system covers automated task notifications and shell command monitoring. It manages the delivery of desktop notifications and remote push alerts using a configurable routing engine to track the status of local or remote tasks.

## Tags

### Development Tools & Productivity

- [Shell Command Completion Notifications](https://awesome-repositories.com/f/development-tools-productivity/shell-command-completion-notifications.md) — Monitors shell sessions and sends alerts when long-running commands finish, based on duration and focus. ([source](https://cdn.jsdelivr.net/gh/dschep/ntfy@master/README.md))
- [Notification Integrations](https://awesome-repositories.com/f/development-tools-productivity/notification-integrations.md) — Provides connectors that bridge internal process events to external messaging and notification services through a standard function signature. ([source](http://ntfy.readthedocs.org/en/stable/))
- [Shell Notification Utilities](https://awesome-repositories.com/f/development-tools-productivity/shell-notification-utilities.md) — Schedules and sends alerts to desktop or mobile devices when long-running shell commands finish executing.
- [Task Completion Notifications](https://awesome-repositories.com/f/development-tools-productivity/task-completion-notifications.md) — Provides system-level alerts upon the completion of long-running background tasks.

### DevOps & Infrastructure

- [Script-Triggered Push Notifications](https://awesome-repositories.com/f/devops-infrastructure/push-notification-services/script-triggered-push-notifications.md) — Triggers notifications from shell scripts and commands to deliver real-time alerts to mobile devices.

### Networking & Communication

- [Notification Plugin Frameworks](https://awesome-repositories.com/f/networking-communication/communication-platforms-services/messaging-notification-systems/messaging-services/notification-delivery-services/notification-plugin-frameworks.md) — Implements a modular architecture that allows extending alert delivery capabilities via custom plugins.
- [Push Notification Providers](https://awesome-repositories.com/f/networking-communication/communication-platforms-services/messaging-notification-systems/messaging-services/notification-delivery-services/push-notification-providers.md) — Functions as a platform that integrates with various messaging services to deliver push notifications to client devices.
- [Notification Dispatches](https://awesome-repositories.com/f/networking-communication/http-request-dispatchers/notification-dispatches.md) — Provides a mechanism to send real-time alerts to remote endpoints using outbound HTTP requests.
- [Notification Routing Platforms](https://awesome-repositories.com/f/networking-communication/notification-routing-platforms.md) — Dispatches alerts to various communication channels and push services based on triggered process events. ([source](http://ntfy.readthedocs.org/en/stable/))
- [Notification Routing Services](https://awesome-repositories.com/f/networking-communication/notification-routing-services.md) — Aggregates and dispatches alerts across multiple system backends and third-party communication channels. ([source](http://ntfy.readthedocs.org/en/stable/py-modindex.html))

### Operating Systems & Systems Programming

- [Shell Hook Integrations](https://awesome-repositories.com/f/operating-systems-systems-programming/shell-hook-integrations.md) — Leverages shell-native hooks to monitor the lifecycle of commands and capture exit status for alert generation.

### Software Engineering & Architecture

- [Notification Integration Frameworks](https://awesome-repositories.com/f/software-engineering-architecture/notification-integration-frameworks.md) — Provides a modular system for integrating third-party API push services and custom notification modules.
- [Notification Backend Mappings](https://awesome-repositories.com/f/software-engineering-architecture/declarative-configuration-managers/backend-resource-mapping/notification-backend-mappings.md) — Uses a structured configuration file to map specific notification requests to the chosen backend providers.

### System Administration & Monitoring

- [Execution Duration Triggers](https://awesome-repositories.com/f/system-administration-monitoring/real-time-monitoring-systems/infrastructure-health-monitoring/threshold-based-alerters/execution-duration-triggers.md) — Determines when to send an alert by comparing a command's execution time against a minimum duration setting.
- [Shell Command Execution Monitoring](https://awesome-repositories.com/f/system-administration-monitoring/shell-command-execution-monitoring.md) — Monitors the execution of terminal commands to notify the user immediately when they finish.
- [Alert Routing](https://awesome-repositories.com/f/system-administration-monitoring/alert-routing.md) — Directs system alerts to appropriate communication channels across different operating systems and devices.

### User Interface & Experience

- [Process Completion Alerts](https://awesome-repositories.com/f/user-interface-experience/alerts-notifications/process-completion-alerts.md) — Triggers visual and auditory notifications when background shell processes terminate.
- [Notification Suppression](https://awesome-repositories.com/f/user-interface-experience/notification-suppression.md) — Suppresses notifications when the terminal window is active to prevent unnecessary user interruptions.

### Web Development

- [Desktop Notifications](https://awesome-repositories.com/f/web-development/desktop-application-frameworks/native-macos-frameworks/desktop-notifications.md) — Renders native on-screen alerts on the desktop to signal the completion of processes. ([source](http://ntfy.readthedocs.org/en/stable/_sources/index.rst.txt))
