{"id":13541157,"url":"https://github.com/FMotalleb/nu_plugin_desktop_notifications","last_synced_at":"2025-04-02T08:30:58.524Z","repository":{"id":206183072,"uuid":"716028871","full_name":"FMotalleb/nu_plugin_desktop_notifications","owner":"FMotalleb","description":"A nushell plugin to send notification to desktop using notify-rust","archived":false,"fork":false,"pushed_at":"2024-05-05T08:59:13.000Z","size":101,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-05T09:41:19.330Z","etag":null,"topics":["desktop-notifications","notifications","nushell-plugin"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FMotalleb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-08T10:28:58.000Z","updated_at":"2024-05-29T21:40:47.168Z","dependencies_parsed_at":"2023-12-17T14:28:31.210Z","dependency_job_id":"cf5aee28-4c47-4525-9dc9-7cef1286102f","html_url":"https://github.com/FMotalleb/nu_plugin_desktop_notifications","commit_stats":null,"previous_names":["fmotalleb/nu_plugin_desktop_notifications"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FMotalleb%2Fnu_plugin_desktop_notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FMotalleb%2Fnu_plugin_desktop_notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FMotalleb%2Fnu_plugin_desktop_notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FMotalleb%2Fnu_plugin_desktop_notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FMotalleb","download_url":"https://codeload.github.com/FMotalleb/nu_plugin_desktop_notifications/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246781938,"owners_count":20832937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["desktop-notifications","notifications","nushell-plugin"],"created_at":"2024-08-01T10:00:39.818Z","updated_at":"2025-04-02T08:30:58.511Z","avatar_url":"https://github.com/FMotalleb.png","language":"Rust","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# 🔔 nu_plugin_desktop_notifications  \n\nA [Nushell](https://www.nushell.sh/) plugin for sending desktop notifications using [notify-rust](https://github.com/hoodie/notify-rust).  \n\n---\n\n## ✨ Features  \n\n- **Send notifications** with custom title, body, icon, and app name.  \n- **Supports macOS, Windows, and Linux (XDG Desktop)**.  \n- **Configurable timeout** (for macOS and XDG desktops).  \n- **Error handling** with optional crash reporting.  \n\n---\n\n## 📌 Usage  \n\n### **Sending a Notification**  \n\n```bash\nnotify -t \"Test notification body\" --summary \"Test title\"\n```  \n\n### **Flags**  \n\n- `-h, --help`                 → Show help message.  \n- `-s, --summary \u003cstring\u003e`     → Title of the notification.  \n- `-t, --body \u003cstring\u003e`        → Body message of the notification.  \n- `--subtitle \u003cstring\u003e`        → Subtitle (macOS \u0026 Windows only).  \n- `-a, --app-name \u003cstring\u003e`    → App name for the notification.  \n- `-i, --icon \u003cfilepath\u003e`      → Path to an icon for the notification.  \n- `--timeout \u003cduration\u003e`       → Duration before the notification disappears _(macOS \u0026 XDG Desktop only)_. Defaults to system settings.  \n- `--crash-on-error \u003cfilepath\u003e` → Return an error if the notification fails.  \n\n---\n\n## 🎯 Example: Notify on Task Completion  \n\nSend a notification after a task completes, displaying the elapsed time:  \n\n![image](https://github.com/FMotalleb/nu_plugin_desktop_notifications/assets/30149519/a4fbc2a9-6537-4d18-8d98-e55ebcd6b0bd)  \n\n```bash\ndef \"notify on done\" [\n    task: closure\n] {\n    let start = date now\n    let result = do $task\n    let end = date now\n    let total = $end - $start | format duration sec\n    let body = $\"Task completed in ($total)\"\n    notify -s \"Task Finished\" -t $body\n    return $result\n}\n\nnotify on done { port scan 8.8.8.8 53 }\n```  \n\n---\n\n## 🔧 Installation  \n\n### 🚀 Recommended: Using [nupm](https://github.com/nushell/nupm)  \n\n```bash\ngit clone https://github.com/FMotalleb/nu_plugin_desktop_notifications.git  \nnupm install --path nu_plugin_desktop_notifications -f  \n```  \n\n### 🛠️ Manual Compilation  \n\n```bash\ngit clone https://github.com/FMotalleb/nu_plugin_desktop_notifications.git  \ncd nu_plugin_desktop_notifications  \ncargo build -r  \nregister target/release/nu_plugin_desktop_notifications  \n```  \n\n### 📦 Install via Cargo (using git)  \n\n```bash\ncargo install --git https://github.com/FMotalleb/nu_plugin_desktop_notifications.git  \nregister ~/.cargo/bin/nu_plugin_desktop_notifications  \n```  \n\n### 📦 Install via Cargo (crates.io) _Not Recommended_  \n\u003e\n\u003e _Since I live in Iran and crates.io often restricts package updates, the version there might be outdated._  \n\n```bash\ncargo install nu_plugin_desktop_notifications  \nregister ~/.cargo/bin/nu_plugin_desktop_notifications  \n```  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFMotalleb%2Fnu_plugin_desktop_notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFMotalleb%2Fnu_plugin_desktop_notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFMotalleb%2Fnu_plugin_desktop_notifications/lists"}