Ntfy Push Notifications

🚀 NTFYロボットメッセージ処理プロジェクトの設定ガイド

このプロジェクトは、NTFYロボットでのメッセージ処理に関する設定を提供します。以下に、インストール、設定、使用方法、開発方法などの詳細を説明します。

🚀 クイックスタート

このセクションでは、NTFYロボットメッセージ処理プロジェクトのインストールと基本的な設定方法を説明します。

📦 インストール

npmを使用したインストール

node install https://github.com/gitmotion/ntfy-me-mcp.git

Gitを使用したリポジトリのクローンによるインストール

git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp
npm install

📚 ドキュメント

設定ガイド

環境変数の設定

必須設定

NTFY_TOPIC 環境変数を設定して、デフォルトのNTFYトピックを指定します。

export NTFY_TOPIC=your-topic-name

オプション設定

必要に応じて、以下の任意の環境変数を設定できます。

• NTFY_URL: NTFYサービスのアドレスを指定します。デフォルトは https://ntfy.sh です。
• NTFY_AUTH: NTFFYの認証情報（APIキーなど）を設定します。

使用ガイド

メッセージ送信ツール (ntfy_me)

コマンドラインでの使用

ntfy_me --title "通知タイトル" --message "通知内容" [--priority レベル] [--tags タグリスト]

例

1. デフォルトのメッセージを送信する場合：

   ntfy_me --title "新しいメールが届きました" --message "新しい電子メールが届いています。ご確認ください。"
   

2. 高い優先度とタグを設定する場合：

   ntfy_me --title "サーバー警告" --message "CPU使用率が高いです。確認をおすすめします。" --priority high --tags warning,alert
   

メッセージ検索ツール (ntfy_me_fetch)

コマンドラインでの使用

ntfy_me_fetch [--topic トピック名] [--since 時間範囲] [--message-id メッセージID]

例

1. 過去30分間のメッセージを取得する場合：

   ntfy_me_fetch --since 30m
   

2. タイトルと優先度でメッセージを絞り込む場合：

   ntfy_me_fetch --topic updates --messageTitle "更新完了" --priorities high
   

開発ガイド

ソースコードからのビルド

git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp
npm install
npm run build

📄 ライセンス

このプロジェクトは GNU General Public License v3.0 に基づいてライセンスされています。詳細は LICENSE ファイルを参照してください。

🔗 貢献ガイド

貢献を歓迎します！自由に Pull Request を送信してください。

gitmotion によって開発され、❤️ オープンソースコミュニティに捧げられます。