mcpField
N
ntfy-notify

ntfy-notify

github.com/gitstua生产力077 次安装20 周前更新
代码仓库

关于 ntfy-notify

ntfy-notify 是一个通过脚本发送 ntfy 通知的技能,适用于需要以命令行触发简短消息的自动化任务。它支持指定主题、标题、优先级和标签,并可在发送前用 dry-run 检查请求内容。

主要功能

  1. 01通过脚本发送通知
  2. 02使用默认或显式指定主题
  3. 03设置标题、优先级和标签
  4. 04支持令牌认证和自定义服务地址
  5. 05dry-run 检查请求内容并隐藏令牌

适用场景

  1. 01发送构建完成通知
  2. 02通知备份任务完成
  3. 03发布部署状态消息

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/gitstua/stu-skills --skill ntfy-notify

安装后在 Claude Code 中输入/ntfy-notify确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

.env-path
agents/
openai.yaml
scripts/
ntfy_send.sh

详细介绍

ntfy 通知

使用 scripts/ntfy_send.sh 发送确定性、低开销的通知。

前置条件

  • 必需的默认主题:NTFY_DEFAULT_TOPIC
    • 示例:export NTFY_DEFAULT_TOPIC="my-topic"
  • 可选的身份验证:NTFY_ACCESS_TOKEN(脚本也接受旧版 NTFY_TOKEN)
    • 示例:export NTFY_ACCESS_TOKEN="<your-ntfy-access-token>"
  • 密钥/默认值文件:~/.config/stu-skills/ntfy-notify/.env
    • 脚本会自动从 ntfy-notify/.env-path 读取此路径。
  • 如果缺少 NTFY_DEFAULT_TOPIC,且未传入 --topic,脚本会退出并提示 Agent 向用户询问主题。

配置

  1. 设置默认主题:
    • export NTFY_DEFAULT_TOPIC="my-topic"
  2. 可选地设置令牌身份验证:
    • export NTFY_ACCESS_TOKEN="<your-ntfy-access-token>"
  3. 可选的自定义服务(默认值为 https://ntfy.sh):
    • export NTFY_SERVER="https://ntfy.sh"
  4. 建议:将值存储在 ~/.config/stu-skills/ntfy-notify/.env 中,这样 Agent 只需执行脚本,无需在命令中直接填写密钥。
    • 示例:
      • NTFY_DEFAULT_TOPIC="my-topic"
      • NTFY_ACCESS_TOKEN="<your-ntfy-access-token>"
      • NTFY_SERVER="https://ntfy.sh"

.env 示例

路径:~/.config/stu-skills/ntfy-notify/.env

NTFY_DEFAULT_TOPIC="my-topic"
NTFY_ACCESS_TOKEN="<your-ntfy-access-token>"
NTFY_SERVER="https://ntfy.sh"

发送

  • 基本用法:
    • scripts/ntfy_send.sh "Build finished"
  • 指定主题:
    • scripts/ntfy_send.sh --topic ops-alerts "Backup completed"
  • 添加标题/优先级/标签:
    • scripts/ntfy_send.sh --title "Deploy" --priority 4 --tags rocket,white_check_mark "Release shipped"

说明

  • 密钥和默认值优先使用环境变量。
  • --dry-run 会在打印的 curl 输出中隐藏 Bearer 令牌值。
  • 消息应简短且便于采取行动。
  • 使用 --dry-run 可在不发起网络请求的情况下验证负载和标头行为。

评论

支持 Markdown