ntfy Notify
Use scripts/ntfy_send.sh for deterministic, low-overhead notifications.
Prerequisites
- •Required default topic:
NTFY_DEFAULT_TOPIC- •Example:
export NTFY_DEFAULT_TOPIC="my-topic"
- •Example:
- •Optional auth:
NTFY_ACCESS_TOKEN(script also accepts legacyNTFY_TOKEN)- •Example:
export NTFY_ACCESS_TOKEN="<your-ntfy-access-token>"
- •Example:
- •Secrets/defaults file:
~/.config/stu-skills/ntfy-notify/.env- •The script reads this path from
ntfy-notify/.env-pathautomatically.
- •The script reads this path from
- •If
NTFY_DEFAULT_TOPICis missing and--topicis not passed, the script exits with an instruction for the agent to ask the user for it.
Configure
- •Set a default topic:
- •
export NTFY_DEFAULT_TOPIC="my-topic"
- •
- •Optionally set token auth:
- •
export NTFY_ACCESS_TOKEN="<your-ntfy-access-token>"
- •
- •Optional custom server (default is
https://ntfy.sh):- •
export NTFY_SERVER="https://ntfy.sh"
- •
- •Recommended: store values in
~/.config/stu-skills/ntfy-notify/.envso the agent only executes the script and does not need secret values inline.- •Example:
- •
NTFY_DEFAULT_TOPIC="my-topic" - •
NTFY_ACCESS_TOKEN="<your-ntfy-access-token>" - •
NTFY_SERVER="https://ntfy.sh"
- •
- •Example:
.env Sample
Path: ~/.config/stu-skills/ntfy-notify/.env
dotenv
NTFY_DEFAULT_TOPIC="my-topic" NTFY_ACCESS_TOKEN="<your-ntfy-access-token>" NTFY_SERVER="https://ntfy.sh"
Send
- •Basic:
- •
scripts/ntfy_send.sh "Build finished"
- •
- •Explicit topic:
- •
scripts/ntfy_send.sh --topic ops-alerts "Backup completed"
- •
- •Add title/priority/tags:
- •
scripts/ntfy_send.sh --title "Deploy" --priority 4 --tags rocket,white_check_mark "Release shipped"
- •
Notes
- •Prefer env vars for secrets and defaults.
- •
--dry-runredacts bearer token values in printed curl output. - •Keep messages short and actionable.
- •Use
--dry-runto verify payload/header behavior without network calls.