dschep/ntfy
Ntfy
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.
Features
- Shell Command Completion Notifications - Monitors shell sessions and sends alerts when long-running commands finish, based on duration and focus.
- Notification Integrations - Provides connectors that bridge internal process events to external messaging and notification services through a standard function signature.
- Shell Notification Utilities - Schedules and sends alerts to desktop or mobile devices when long-running shell commands finish executing.
- Task Completion Notifications - Provides system-level alerts upon the completion of long-running background tasks.
- Script-Triggered Push Notifications - Triggers notifications from shell scripts and commands to deliver real-time alerts to mobile devices.
- Notification Plugin Frameworks - Implements a modular architecture that allows extending alert delivery capabilities via custom plugins.
- Push Notification Providers - Functions as a platform that integrates with various messaging services to deliver push notifications to client devices.
- Notification Dispatches - Provides a mechanism to send real-time alerts to remote endpoints using outbound HTTP requests.
- Notification Routing Platforms - Dispatches alerts to various communication channels and push services based on triggered process events.
- Notification Routing Services - Aggregates and dispatches alerts across multiple system backends and third-party communication channels.
- Shell Hook Integrations - Leverages shell-native hooks to monitor the lifecycle of commands and capture exit status for alert generation.
- Notification Integration Frameworks - Provides a modular system for integrating third-party API push services and custom notification modules.
- Execution Duration Triggers - Determines when to send an alert by comparing a command's execution time against a minimum duration setting.
- Shell Command Execution Monitoring - Monitors the execution of terminal commands to notify the user immediately when they finish.
- Process Completion Alerts - Triggers visual and auditory notifications when background shell processes terminate.
- Notification Backend Mappings - Uses a structured configuration file to map specific notification requests to the chosen backend providers.
- Alert Routing - Directs system alerts to appropriate communication channels across different operating systems and devices.
- Notification Suppression - Suppresses notifications when the terminal window is active to prevent unnecessary user interruptions.
- Desktop Notifications - Renders native on-screen alerts on the desktop to signal the completion of processes.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
