Notify.Console
1.2.0
dotnet tool install --global Notify.Console --version 1.2.0
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local Notify.Console --version 1.2.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Notify.Console&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Notify.Console --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Notify.Console
Cross-platform notification CLI tool, installed as a .NET global tool.
Install
dotnet tool install -g Notify.Console
Commands
system
Show a native OS notification (toast/banner).
notify system --title "Build done" --description "All tests passed"
| Platform | Method |
|---|---|
| Windows | Balloon tip via System.Windows.Forms.NotifyIcon |
| macOS | osascript / display notification |
| Linux | notify-send |
messagebox
Show a native OS message box dialog (blocks until dismissed).
notify messagebox --title "Confirm" --message "Deployment complete"
| Platform | Method |
|---|---|
| Windows | System.Windows.Forms.MessageBox |
| macOS | osascript / display dialog |
| Linux | zenity --info |
slack
Send a Slack message using a config profile defined in config.yaml.
notify slack my-profile --message "Deploy finished"
See config.yaml for profile configuration.
Send emails via Gmail API with support for HTML, attachments, and multiple recipients.
Basic usage:
notify email work --to user@example.com --subject "Test" --body "Hello"
Using stdin (recommended for large emails):
cat report.html | notify email work --to team@company.com --subject "Weekly Report"
Reading from file:
notify email work --to user@example.com --subject "Article" --file article.html
Multiple recipients and attachments:
notify email work \
--to user1@example.com --to user2@example.com \
--cc boss@example.com \
--subject "Files" \
--body "Please review attached documents" \
--attach document.pdf --attach spreadsheet.xlsx
Create draft instead of sending:
cat report.html | notify email work --to team@example.com --subject "Draft Report" --draft
Features:
- Automatic HTML detection with plain text fallback generation
- Multiple recipients (To, CC, BCC)
- File attachments (up to 25MB Gmail limit)
- Multiple input methods: stdin,
--body,--file - Draft mode for creating drafts instead of sending
- Profile-based configuration in
config.yaml
Gmail API Setup (one-time per profile):
- Create a Google Cloud project at https://console.cloud.google.com
- Enable the Gmail API
- Create OAuth 2.0 credentials (Desktop app type)
- Download
client_secret.json - Place the file at:
- Windows:
%APPDATA%\Notify.Console\gmail-credentials\{profile-name}\client_secret.json - Unix:
~/.config/notify-console/gmail-credentials/{profile-name}/client_secret.json
- Windows:
- First run will open browser for OAuth consent
- Grant Gmail send permission
- Credentials are saved automatically for future use
Configuration example (config.yaml):
email:
work:
provider: gmail
from: me@company.com
default_to: team@company.com # Optional
personal:
provider: gmail
from: personal@gmail.com
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.