About • Documentation • Supported Services • Install • Configuration • Contributing • Show Your Support •
--- ## About **PingMe** is a personal project to satisfy my needs of having alerts, most of major platforms have integration to send alerts but its not always useful, either you are stuck with one particlaur platform or you have to do alot of integrations. I needed a small app which i can just call from my backup scripts, cron jobs, CI/CD pipelines or from anywhere to send a message with particular information. And i can ship it everywhere with ease. Hence the birth of PingMe. Everything is configurable via enviornment variables and you can simply export the logs or messages to a variable which will be sent as message. And most of all this serves as a swiss army knife sort of tool which supports multiple platforms. ## Supported services - *Discord* - *Email* - *Microsoft Teams* - *RocketChat* - *Slack* - *Telegram* ## Install ### Linux & MacOs ```bash brew install kha7iq/tap/pingme ``` ### Go Get ```bash go get -u github.com/kha7iq/pingme ``` ### Windows Alternativly you can head over to [release pages](https://github.com/kha7iq/pingme/releases) and download the binary for windows & all other supported platforms. ## Usage ```bash ❯ pingme NAME: PingMe - Send message to multiple platforms USAGE: pingme [global options] command [command options] [arguments...] DESCRIPTION: PingMe is a CLI tool which provides the ability to send messages or alerts to multiple messaging platforms and also email, everything is configurable via environment variables and command line switches.Currently supported platforms include Slack, Telegram, RocketChat, Discord, Microsoft Teams and email address. COMMANDS: telegram Send message to telegram rocketchat Send message to rocketchat slack Send message to slack discord Send message to discord teams Send message to microsoft teams email Send an email help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --help, -h show help (default: false) ``` Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details. ## Configuration All the flags have crosponding enviornment variables assosiated with it. You can either provide the value with flags or export to a variable. View the [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details. ## Contributing Contributions, issues and feature requests are welcome!