https://github.com/tripplyons/alert-me

A shell utility that sends you a message through different means (Discord, Amazon Echo)
https://github.com/tripplyons/alert-me

alert alexa amazon-alexa amazon-echo discord notification notification-api notifications notifier

Last synced: 8 days ago
JSON representation

A shell utility that sends you a message through different means (Discord, Amazon Echo)

• Host: GitHub
• URL: https://github.com/tripplyons/alert-me
• Owner: tripplyons
• License: mit
• Created: 2020-09-08T02:33:52.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-19T18:56:47.000Z (about 4 years ago)
• Last Synced: 2024-10-11T18:37:58.964Z (about 1 month ago)
• Topics: alert, alexa, amazon-alexa, amazon-echo, discord, notification, notification-api, notifications, notifier
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/alert-me
• Size: 609 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# alert-me

A shell utility that sends you a message through different means (Discord, [Amazon Echo](https://www.thomptronics.com/about/notify-me))

`echo hi | alert-me`

![alert-me working with Discord](examples/discorddemo.gif)

## Usage

### Installation

```

npm i -g alert-me

```

### Setup (Configuration Tool)

```

alert-me --config

```

### Sending messages

#### To the default provider

```

echo "message" | alert-me

```

#### To a chosen provider

```

echo "message" | alert-me discord

```

#### To all providers

```

echo "message" | alert-me all

```

### Node API

```

const alertMe = require("alert-me")

alertMe("message")

alertMe("message", "discord")

alertMe("message", "echo")

```