https://github.com/FMotalleb/nu_plugin_desktop_notifications
A nushell plugin to send notification to desktop using notify-rust
https://github.com/FMotalleb/nu_plugin_desktop_notifications
desktop-notifications notifications nushell-plugin
Last synced: 12 days ago
JSON representation
A nushell plugin to send notification to desktop using notify-rust
- Host: GitHub
- URL: https://github.com/FMotalleb/nu_plugin_desktop_notifications
- Owner: FMotalleb
- License: mit
- Created: 2023-11-08T10:28:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-05T08:59:13.000Z (11 months ago)
- Last Synced: 2024-05-05T09:41:19.330Z (11 months ago)
- Topics: desktop-notifications, notifications, nushell-plugin
- Language: Rust
- Homepage:
- Size: 98.6 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nu - nu_plugin_desktop_notifications
README
# 🔔 nu_plugin_desktop_notifications
A [Nushell](https://www.nushell.sh/) plugin for sending desktop notifications using [notify-rust](https://github.com/hoodie/notify-rust).
---
## ✨ Features
- **Send notifications** with custom title, body, icon, and app name.
- **Supports macOS, Windows, and Linux (XDG Desktop)**.
- **Configurable timeout** (for macOS and XDG desktops).
- **Error handling** with optional crash reporting.
---
## 📌 Usage
### **Sending a Notification**
```bash
notify -t "Test notification body" --summary "Test title"
```
### **Flags**
- `-h, --help` → Show help message.
- `-s, --summary ` → Title of the notification.
- `-t, --body ` → Body message of the notification.
- `--subtitle ` → Subtitle (macOS & Windows only).
- `-a, --app-name ` → App name for the notification.
- `-i, --icon ` → Path to an icon for the notification.
- `--timeout ` → Duration before the notification disappears _(macOS & XDG Desktop only)_. Defaults to system settings.
- `--crash-on-error ` → Return an error if the notification fails.
---
## 🎯 Example: Notify on Task Completion
Send a notification after a task completes, displaying the elapsed time:
```bash
def "notify on done" [
task: closure
] {
let start = date now
let result = do $task
let end = date now
let total = $end - $start | format duration sec
let body = $"Task completed in ($total)"
notify -s "Task Finished" -t $body
return $result
}
notify on done { port scan 8.8.8.8 53 }
```
---
## 🔧 Installation
### 🚀 Recommended: Using [nupm](https://github.com/nushell/nupm)
```bash
git clone https://github.com/FMotalleb/nu_plugin_desktop_notifications.git
nupm install --path nu_plugin_desktop_notifications -f
```
### 🛠️ Manual Compilation
```bash
git clone https://github.com/FMotalleb/nu_plugin_desktop_notifications.git
cd nu_plugin_desktop_notifications
cargo build -r
register target/release/nu_plugin_desktop_notifications
```
### 📦 Install via Cargo (using git)
```bash
cargo install --git https://github.com/FMotalleb/nu_plugin_desktop_notifications.git
register ~/.cargo/bin/nu_plugin_desktop_notifications
```
### 📦 Install via Cargo (crates.io) _Not Recommended_
>
> _Since I live in Iran and crates.io often restricts package updates, the version there might be outdated._
```bash
cargo install nu_plugin_desktop_notifications
register ~/.cargo/bin/nu_plugin_desktop_notifications
```