notify-me

A lightweight CLI notification tool that sends messages to Telegram and other channels. Works behind firewalls/NAT with no public inbound connectivity required.

Features

• 📱 CLI-first: Easy to use in scripts, CI/CD pipelines, cron jobs
• 🚫 No public server: Works behind NAT/firewalls with polling
• 🔌 Multiple channels: Telegram (v0.0.1), Slack (future)
• 🏷️ Structured messages: Support for titles, links, fields, tags
• 💡 Interactive commands: Guided setup and discovery

Installation

Global Installation

# Install globally
npm install -g notify-me-cli

# Now use the command anywhere
notify-me "Build completed!"

Run without installing (via npx)

npx notify-me-cli "Build completed!"

Add to your project

# Add to your project
npm install --save-dev notify-me-cli

# Add to your package.json scripts
"scripts": {
  "notify": "notify-me"
}

Quick Start

# 1. Initialize configuration
notify-me init

# 2. Add a Telegram channel
notify-me channels new

# 3. Discover chat ID (follow instructions)
notify-me channels discover telegram-main

# 4. Send a notification
notify-me "Build completed!"

Usage Examples

# Simple notifications
notify-me "Deploy successful"

# With title and emoji (success/warning/error)
notify-me -f message.json

# Send to specific channel
notify-me -c telegram-main "Pipeline failed!"

# Broadcast to all channels
notify-me --all "System maintenance in 5 minutes"

Structured Messages (via JSON)

Create a message.json file:

{
  "title": "Build Complete ✅",
  "body": "Artifact uploaded successfully.",
  "level": "success",
  "fields": [
    { "label": "Repo", "value": "phenixcoder/notify-me" },
    { "label": "Commit", "value": "a1b2c3" }
  ],
  "links": [
    { "label": "Download", "url": "https://example.com" }
  ],
  "tags": ["ci", "build"]
}

Then send it:

notify-me -f message.json

Channel Management

# List channels
notify-me channels ls

# Create channel
notify-me channels new

# Set default
notify-me channels set-default telegram-main

Supported Channels

| Channel | Status | Authentication | Discovery Method | | --------- | ------------ | ------------------- | ------------------ | | Telegram | ✅ Supported | Bot Token | Polling | | Slack | 🔜 Planned | Webhook URL | - | | Discord | 🔜 Planned | Webhook URL | - |

License

MIT