feat: Add notify alias for Windows toast notifications using BurntToast #7238

Closed
opened 2026-02-16 18:06:32 -05:00 by yindo · 2 comments
Owner

Originally created by @ScottWilliamAnderson on GitHub (Jan 22, 2026).

Originally assigned to: @thdxr on GitHub.

Summary

Add a notify command/alias that wraps the BurntToast PowerShell module to display Windows toast notifications from the terminal. Primary use case: alerting when long-running scripts complete.

Proposed Features

1. notify function

A simple wrapper around New-BurntToastNotification:

# Simple usage
notify "Build complete!"

# With title
notify "Build complete!" -Title "npm build"

# Full options (pass-through to BurntToast)
notify "Deployment finished" -Title "Deploy" -Sound Alarm -Urgent

Parameters:

Parameter Description Default
Message Notification body text (positional) Required
-Title Optional notification title None
-Sound Notification sound (pass-through) System default
-Urgent Mark as important/urgent $false
-Image Custom icon/image path BurntToast default

2. remind-me function

Timer-based reminder that sends a notification after a delay:

remind-me 5m "Take a break"
remind-me 1h "Check on deployment"
remind-me 30s "Timer done"

3. Installation

Add burnttoast-psmodule to packages.config for Chocolatey auto-install.

Manual installation options:

# Chocolatey (preferred)
choco install burnttoast-psmodule

# PowerShell Gallery
Install-Module -Name BurntToast

Example Use Cases

# Notify on success or failure (recommended for long-running tasks)
npm run build && notify "Build succeeded!" -Title "npm" || notify "Build FAILED!" -Title "npm" -Urgent -Sound Alarm

# Simple success-only notification
dotnet test && notify "Tests passed!"

# Remind yourself
remind-me 25m "Pomodoro break"

# Urgent notification
notify "Server is down!" -Urgent -Sound Call

References

Originally created by @ScottWilliamAnderson on GitHub (Jan 22, 2026). Originally assigned to: @thdxr on GitHub. ## Summary Add a `notify` command/alias that wraps the [BurntToast](https://github.com/Windos/BurntToast) PowerShell module to display Windows toast notifications from the terminal. Primary use case: alerting when long-running scripts complete. ## Proposed Features ### 1. `notify` function A simple wrapper around `New-BurntToastNotification`: ```powershell # Simple usage notify "Build complete!" # With title notify "Build complete!" -Title "npm build" # Full options (pass-through to BurntToast) notify "Deployment finished" -Title "Deploy" -Sound Alarm -Urgent ``` **Parameters:** | Parameter | Description | Default | |-----------|-------------|---------| | `Message` | Notification body text (positional) | Required | | `-Title` | Optional notification title | None | | `-Sound` | Notification sound (pass-through) | System default | | `-Urgent` | Mark as important/urgent | `$false` | | `-Image` | Custom icon/image path | BurntToast default | ### 2. `remind-me` function Timer-based reminder that sends a notification after a delay: ```powershell remind-me 5m "Take a break" remind-me 1h "Check on deployment" remind-me 30s "Timer done" ``` ### 3. Installation Add `burnttoast-psmodule` to `packages.config` for Chocolatey auto-install. **Manual installation options:** ```powershell # Chocolatey (preferred) choco install burnttoast-psmodule # PowerShell Gallery Install-Module -Name BurntToast ``` ## Example Use Cases ```powershell # Notify on success or failure (recommended for long-running tasks) npm run build && notify "Build succeeded!" -Title "npm" || notify "Build FAILED!" -Title "npm" -Urgent -Sound Alarm # Simple success-only notification dotnet test && notify "Tests passed!" # Remind yourself remind-me 25m "Pomodoro break" # Urgent notification notify "Server is down!" -Urgent -Sound Call ``` ## References - [BurntToast GitHub](https://github.com/Windos/BurntToast) - [Chocolatey package](https://chocolatey.org/packages/burnttoast-psmodule)
yindo added the windows label 2026-02-16 18:06:32 -05:00
yindo closed this issue 2026-02-16 18:06:32 -05:00
Author
Owner

@ScottWilliamAnderson commented on GitHub (Jan 22, 2026):

Opened in wrong repo by mistake. Correct issue: https://github.com/ScottWilliamAnderson/scripts/issues/32

@ScottWilliamAnderson commented on GitHub (Jan 22, 2026): Opened in wrong repo by mistake. Correct issue: https://github.com/ScottWilliamAnderson/scripts/issues/32
Author
Owner

@github-actions[bot] commented on GitHub (Jan 22, 2026):

This issue might be a duplicate of existing issues. Please check:

  • #213: [feature request] notifications - General feature request for notifications system
  • #2372: Feature Request: play sound when agent is done running - Similar use case for alerting on completion
  • #7242: [FEATURE]: Notification when plan/build is done! - Requests system notifications for plan/build completion
  • #4454: Proposal: OSC 9 terminal notifications for TUI toasts - CLOSED proposal for desktop notifications from the TUI

While this issue specifically focuses on Windows toast notifications via BurntToast (a Windows-specific solution), the above issues discuss broader notification/alert functionality that may overlap in goals. You might want to review those to see if your Windows-specific approach could complement or be part of a broader notification strategy.

Feel free to ignore if this is a Windows-specific implementation that differs from the above general requests.

@github-actions[bot] commented on GitHub (Jan 22, 2026): This issue might be a duplicate of existing issues. Please check: - #213: [feature request] notifications - General feature request for notifications system - #2372: Feature Request: play sound when agent is done running - Similar use case for alerting on completion - #7242: [FEATURE]: Notification when plan/build is done! - Requests system notifications for plan/build completion - #4454: Proposal: OSC 9 terminal notifications for TUI toasts - CLOSED proposal for desktop notifications from the TUI While this issue specifically focuses on Windows toast notifications via BurntToast (a Windows-specific solution), the above issues discuss broader notification/alert functionality that may overlap in goals. You might want to review those to see if your Windows-specific approach could complement or be part of a broader notification strategy. Feel free to ignore if this is a Windows-specific implementation that differs from the above general requests.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#7238