ntfy-notify

ntfy Notify

決定論的でオーバーヘッドの少ない通知には、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 も指定されていない場合、スクリプトはエージェントに値をユーザーへ確認するよう指示して終了します。

設定

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 に保存することを推奨します。
   • 例：
     • 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 出力内のベアラートークン値が伏せられます。
• メッセージは短く、実行につながる内容にしてください。
• ネットワークへの接続なしでペイロードやヘッダーの動作を確認するには、--dry-run を使用してください。