- Notifications
You must be signed in to change notification settings - Fork44
PingMe is a CLI which provides the ability to send messages or alerts to multiple messaging platforms & email.
License
kha7iq/pingme
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Documentation •Supported Services •Install •Github Action •Configuration •Contributing •
PingMe is a personal project to satisfy my needs of having alerts, mostmajor platforms have integration to send alerts but its not always useful,either you are stuck with one particular platform, or you have to do alot ofintegrations. I needed a small utility which i can just call from my backup scripts,cron jobs, CI/CD pipelines or from anywhere to send a message with particularinformation. And i can ship it everywhere with ease. Hence, the birth of PingMe.
Everything is configurable via environment variables, and you can simply exportthe logs or messages to a variable which will be sent as message, and most ofall this serves as a swiss army knife sort of tool which supports multipleplatforms.
- Discord
- Gotify
- Line
- Mastodon
- Mattermost
- Microsoft Teams
- Pushbullet
- Pushover
- RocketChat
- Slack
- Telegram
- Textmagic
- Twillio
- Zulip
brew install kha7iq/tap/pingme
By default pingme is going to be installed at/usr/bin/ sudo is requried for this operation.
If you would like to provide a custom install path you can do so as input to script. i.e./install.sh $HOME/bin
curl -s https://raw.githubusercontent.com/kha7iq/pingme/master/install.sh| sudo shor
curl -sL https://bit.ly/installpm| sudo sh- AUR
# build from sourcesyay -S pingme# binaryyay -S pingme-bin
# Chose desired version, architecture & target osexport PINGME_VERSION="0.2.6"export ARCH="x86_64"export OS="Linux"wget -q https://github.com/kha7iq/pingme/releases/download/v${PINGME_VERSION}/pingme_${OS}_${ARCH}.tar.gz&& \tar -xf pingme_${OS}_${ARCH}.tar.gz&& \chmod +x pingme&& \sudo mv pingme /usr/local/bin/pingme
scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.gitscoop install pingme
Alternatively you can head over torelease pagesand downloaddeb,rpm orbinary for windows & all other supported platforms.
Docker container is also available on both dockerhub and github container registry.
latest tag will always pull the latest version available, or you can also downloadspecific version. Checkoutreleasepage for available versions.
Docker Registry
docker pull khaliq/pingme:latest
Github Registry
docker pull ghcr.io/kha7iq/pingme:latest
Run
docker run ghcr.io/kha7iq/pingme:latest
A github action is available for integration with your workflows, you can find it onGithub Market Place orhereGithub Repo.
-name:PingMe-Actionuses:kha7iq/pingme-action@v1
❯ pingmeNAME: PingMe - Send message to multiple platformsUSAGE: main [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 andcommand line switches.Currently supported platforms include Slack, Telegram, RocketChat, Discord, Pushover, Mattermost, Pushbullet, Microsoft Teams, Twillio, Mastodon, email address, Line, Gotify and Wechat.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 pushover Send message to pushover email Send an email mattermost Send message to mattermost pushbullet Send message to pushbullet twillio Send sms via twillio zulip Send message to zulip mastodon Set status messagefor mastodon line Send message to line messenger wechat Send message to wechat official account gotify Send push notification to gotify server help, h Shows a list of commands orhelpfor onecommandGLOBAL OPTIONS: --help, -h showhelp (default: false)
CheckDocumentation Page for more details.
All the flags have corresponding environment variables associated with it. Youcan either provide the value with flags or export to a variable.
View theDocumentation Page for moredetails.
Contributions, issues and feature requests are welcome!
Feel free to checkissues page. You can also take a lookat thecontributing guide.
This project is based on amazing libraryNotify
About
PingMe is a CLI which provides the ability to send messages or alerts to multiple messaging platforms & email.