|
|
|
|
<!-- markdownlint-disable MD033 -->
|
|
|
|
|
<!-- markdownlint-disable-next-line -->
|
|
|
|
|
<h2 align="center">
|
|
|
|
|
<br>
|
|
|
|
|
<p align="center"><img width=20% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p>
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<h4 align="center">PingMe CLI</h4>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
<a href="https://github.com/kha7iq/pingme/releases">
|
|
|
|
|
<img alt="Release" src="https://img.shields.io/github/v/release/kha7iq/pingme">
|
|
|
|
|
<a href="#">
|
|
|
|
|
<img alt="Build" src="https://img.shields.io/github/workflow/status/kha7iq/pingme/goreleaser">
|
|
|
|
|
<a href="https://github.com/kha7iq/pingme/issues">
|
|
|
|
|
<img alt="GitHub issues" src="https://img.shields.io/github/issues/kha7iq/pingme?style=flat-square&logo=github&logoColor=white">
|
|
|
|
|
<a href="https://github.com/kha7iq/pingme/blob/master/LICENSE.md">
|
|
|
|
|
<img alt="License" src="https://img.shields.io/github/license/kha7iq/pingme">
|
|
|
|
|
<a href="#">
|
|
|
|
|
<img alt="Go Version" src="https://img.shields.io/github/go-mod/go-version/kha7iq/pingme">
|
|
|
|
|
<a href="https://pkg.go.dev/github.com/kha7iq/pingme">
|
|
|
|
|
<img alt="Go Dev Reference" src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat">
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
<a href="#/?id=about">About</a> •
|
|
|
|
|
<a href="#?id=supported-services">Supported Services</a> •
|
|
|
|
|
<a href="#?id=demo">Demo</a> •
|
|
|
|
|
<a href="#?id=contributing">Contributing</a> •
|
|
|
|
|
<a href="#?id=show-your-support">Show Your Support</a> •
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## About
|
|
|
|
|
|
|
|
|
|
**PingMe** is a personal project to satisfy my needs of having alerts, most
|
|
|
|
|
major platforms have integration to send alerts but it's not always useful,
|
|
|
|
|
either you are stuck with one particular 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 environment 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*
|
|
|
|
|
- *Gotify*
|
|
|
|
|
- *Line*
|
|
|
|
|
- *Mastodon*
|
|
|
|
|
- *Mattermost*
|
|
|
|
|
- *Microsoft Teams*
|
|
|
|
|
- *Pushbullet*
|
|
|
|
|
- *Pushover*
|
|
|
|
|
- *RocketChat*
|
|
|
|
|
- *Slack*
|
|
|
|
|
- *Telegram*
|
|
|
|
|
- *Twillio*
|
|
|
|
|
- *Zulip*
|
|
|
|
|
- *Wechat*
|
|
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Contributions, issues and feature requests are welcome!
|
|
|
|
|
|
|
|
|
|
Feel free to check [issues page](https://github.com/kha7iq/pingme/issues).
|
|
|
|
|
You can also take a look at the [contribution guide](contribution.md).
|
|
|
|
|
|
|
|
|
|
## Show your support
|
|
|
|
|
|
|
|
|
|
Give a ⭐️ if you like this project!
|
|
|
|
|
|
|
|
|
|
## Disclaimer
|
|
|
|
|
|
|
|
|
|
Any misuse of this utility is your own liability and responsibility and cannot
|
|
|
|
|
be attributed to the authors of this library. See
|
|
|
|
|
[license](https://github.com/kha7iq/pingme/blob/master/LICENSE.md) for more.
|
|
|
|
|
|
|
|
|
|
Spamming through the use of this library **may get you permanently banned** on
|
|
|
|
|
most supported platforms.
|
