#push-notifications #command-line-tool #notifications #pushover #exit-status #send-notifications #sh

app chirp-pushover

通过 Pushover 应用发送推送通知的命令行工具

1 个不稳定版本

0.1.0 2024 年 7 月 28 日

#306命令行工具

Download history 128/week @ 2024-07-27 6/week @ 2024-08-03

134 每月下载量

MIT 许可证

18KB
229

chirp-pushover — Pushover 的命令行通知器

Crate

Pushover 是一个为 iPhone 和 Android 设备管理推送通知的服务。 chirp 是一个命令行工具,可以将通知推送到您的手机,例如当任务完成、遇到错误等情况。

genome_assembly.sh && chirp success -m "Genome assembly complete"

Chirp 还包括一个简单的 Bash 包装脚本(通过 chirp config 安装),可以用于将更多关于命令的信息传递给消息,例如总运行时间和退出状态。例如,

chirper -t "Genome assembly" genome_assembly.sh

将发送推送通知,例如 "命令成功:genome_assembly.sh (退出代码:0,持续时间:12h 12m 3s)" 或 "命令失败:genome_assembly.sh (退出代码:1,持续时间:2h 12m 11s)",具体取决于退出状态等。

Chirp 安装和 Pushover 设置

  1. 首先,使用 Rust 的 cargo 命令安装 Chirp 命令行工具。如果您还没有安装 Rust,启动它非常简单:只需按照这里提供的说明操作:https://rustup.rs。然后,使用以下命令安装 chirp

    cargo install chirp-pushover
    
  2. 然后,根据您的设备类型下载 iPhoneAndroid Pushover 应用。

  3. 打开应用。此时,您可能想支付一次性的 5 美元费用。

  4. 访问 https://pushover.net 并将您的 用户密钥 存放在某个地方。

  5. 然后,我们需要将 chirp 应用程序注册到 Pushover。为此,请访问 https://pushover.net/apps/build,并在名称栏中填写 "chirp"(或您喜欢的任何名称)。您可以将其他框留空,但请勾选服务条款框,然后点击提交。这应该会带您到一个包含 API 令牌 的页面。

  6. 最后,运行一次性的机器配置,通过运行以下命令将 chirp 工具与 Pushover 链接起来:

    chirp config --api-token <API_TOKEN> --user-key <USER_KEY>
    

    这些令牌将被保存在 ~.pushover_tokens.yml 中,并在 ~/.local/bin/chirper 中安装一个Bash-wrapper脚本。这个简单的Bash脚本封装了命令调用,允许将更多信息直接传递给 chirp 发送的消息(例如退出状态和运行时间)。

使用 Chirp

Chirp 是一个非常简单的命令行工具。请参阅 chirp --help 获取所有子命令列表。要发送消息,您可以使用 chirp msg --title <title> --message <message> --priority <priority>。由于 chirp 很可能主要用于监控具有成功/失败终止状态的作业,因此子命令 chirp success --message <message>chirp failure --message <message> 将自动创建表示成功或失败的标题。还可以设置优先级;使用 --priority emergency 优先级将不断ping个人,直到他们确认通知。

chirper Bash脚本也很简单,只需在 chirper 设置后指定您的完整命令即可。

chirper -t "Genome Assembly" -m "big genome assembly"  -- genome_assembly.sh

依赖项

~13–28MB
~420K SLoC