{"id":13530155,"url":"https://github.com/kha7iq/pingme","last_synced_at":"2025-05-16T14:07:26.299Z","repository":{"id":40314111,"uuid":"357569945","full_name":"kha7iq/pingme","owner":"kha7iq","description":"PingMe is a CLI which provides the ability to send messages or alerts to multiple messaging platforms \u0026 email.","archived":false,"fork":false,"pushed_at":"2025-04-17T05:24:58.000Z","size":7293,"stargazers_count":793,"open_issues_count":1,"forks_count":44,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-08T16:50:37.724Z","etag":null,"topics":["alert","cli","discord","email","golang","gotify","line","mastodon","mattermost","messaging","microsoft-teams","pingme","pushbullet","pushover","rocketchat","slack","telegram","twillio","wechat"],"latest_commit_sha":null,"homepage":"https://pingme.lmno.pk","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kha7iq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-13T13:49:32.000Z","updated_at":"2025-04-23T15:16:56.000Z","dependencies_parsed_at":"2023-12-27T23:09:40.611Z","dependency_job_id":"69b1e309-32d0-465b-888f-4875d342bef1","html_url":"https://github.com/kha7iq/pingme","commit_stats":{"total_commits":180,"total_committers":16,"mean_commits":11.25,"dds":"0.19999999999999996","last_synced_commit":"f24407ea7e1b6981c2d8c225f678b7918ffb5f1f"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kha7iq%2Fpingme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kha7iq","download_url":"https://codeload.github.com/kha7iq/pingme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alert","cli","discord","email","golang","gotify","line","mastodon","mattermost","messaging","microsoft-teams","pingme","pushbullet","pushover","rocketchat","slack","telegram","twillio","wechat"],"created_at":"2024-08-01T07:00:44.830Z","updated_at":"2025-05-16T14:07:26.250Z","avatar_url":"https://github.com/kha7iq.png","language":"Go","funding_links":[],"categories":["Development","开源类库","Go","Open source library","\u003ca name=\"chat\"\u003e\u003c/a\u003eChat and instant messaging"],"sub_categories":["Devops","监控告警","Monitoring"],"readme":"\u003c!-- markdownlint-disable MD033 --\u003e\n\u003c!-- markdownlint-disable-next-line --\u003e\n\u003ch2 align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003cp align=\"center\"\u003e\u003cimg width=30% src=\"https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png\"\u003e\u003c/p\u003e\n\u003c/h2\u003e\n\n\u003ch4 align=\"center\"\u003ePingMe CLI\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://github.com/kha7iq/pingme/releases\"\u003e\n   \u003cimg alt=\"Release\" src=\"https://img.shields.io/github/v/release/kha7iq/pingme\"\u003e\n   \u003ca href=\"https://goreportcard.com/report/github.com/kha7iq/pingme\"\u003e\n   \u003cimg alt=\"Go Report Card\" src=\"https://goreportcard.com/badge/github.com/kha7iq/pingme\"\u003e\n   \u003ca href=\"https://github.com/kha7iq/pingme/issues\"\u003e\n   \u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/kha7iq/pingme?style=flat-square\u0026logo=github\u0026logoColor=white\"\u003e\n   \u003ca href=\"https://github.com/kha7iq/pingme/blob/master/LICENSE.md\"\u003e\n   \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/kha7iq/pingme\"\u003e\n   \u003ca href=\"https://github.com/agarrharr/awesome-cli-apps#devops\"\u003e\n   \u003cimg alt=\"Awesome\" src=\"https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg\"\u003e\n   \u003ca href=\"https://pkg.go.dev/github.com/kha7iq/pingme\"\u003e\n   \u003cimg alt=\"Go Dev Reference\" src=\"https://img.shields.io/badge/go.dev-reference-007d9c?logo=go\u0026logoColor=white\u0026style=flat\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://kha7iq.github.io/pingme\"\u003eDocumentation\u003c/a\u003e •\n  \u003ca href=\"#supported-services\"\u003eSupported Services\u003c/a\u003e •\n  \u003ca href=\"#install\"\u003eInstall\u003c/a\u003e •\n  \u003ca href=\"#github-action\"\u003eGithub Action\u003c/a\u003e •\n  \u003ca href=\"#configuration\"\u003eConfiguration\u003c/a\u003e •\n  \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e •\n\u003c/p\u003e\n\n---\n\n## About\n\n**PingMe** is a personal project to satisfy my needs of having alerts, most\nmajor platforms have integration to send alerts but its not always useful,\neither you are stuck with one particular platform, or you have to do alot of\nintegrations. I needed a small utility which i can just call from my backup scripts,\ncron jobs, CI/CD pipelines or from anywhere to send a message with particular\ninformation. And i can ship it everywhere with ease. Hence, the birth of PingMe.\n\nEverything is configurable via environment variables, and you can simply export\nthe logs or messages to a variable which will be sent as message, and most of\nall this serves as a swiss army knife sort of tool which supports multiple\nplatforms.\n\n## Supported services\n\n- *Discord*\n- *Email*\n- *Gotify*\n- *Line*\n- *Mastodon*\n- *Mattermost*\n- *Microsoft Teams*\n- *Pushbullet*\n- *Pushover*\n- *RocketChat*\n- *Slack*\n- *Telegram*\n- *Textmagic*\n- *Twillio*\n- *Zulip*\n- *Wechat*\n\n## Install\n\n### MacOS \u0026 Linux Homebrew\n\n```bash\nbrew install kha7iq/tap/pingme\n```\n\n\n## Shell Script\nBy default pingme is going to be installed at `/usr/bin/` sudo is requried for this operation.\n\nIf you would like to provide a custom install path you can do so as input to script. i.e `./install.sh $HOME/bin`\n```bash\ncurl -s https://raw.githubusercontent.com/kha7iq/pingme/master/install.sh | sudo sh\n```\nor\n```bash\ncurl -sL https://bit.ly/installpm | sudo sh\n```\n\n## Linux\n\n* AUR\n```bash\n# build from sources\nyay -S pingme\n\n# binary\nyay -S pingme-bin\n\n```\n\n## Manual\n```bash\n# Chose desired version, architecture \u0026 target os\nexport PINGME_VERSION=\"0.2.6\"\nexport ARCH=\"x86_64\"\nexport OS=\"Linux\"\nwget -q https://github.com/kha7iq/pingme/releases/download/v${PINGME_VERSION}/pingme_${OS}_${ARCH}.tar.gz \u0026\u0026 \\\ntar -xf pingme_${OS}_${ARCH}.tar.gz \u0026\u0026 \\\nchmod +x pingme \u0026\u0026 \\\nsudo mv pingme /usr/local/bin/pingme\n```\n\n\n\n### Windows\n\n```powershell\nscoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git\nscoop install pingme\n```\n\nAlternatively you can head over to [release pages](https://github.com/kha7iq/pingme/releases)\nand download `deb`, `rpm` or `binary` for windows \u0026 all other supported platforms.\n\n### Docker\n\nDocker container is also available on both dockerhub and github container registry.\n\n`latest` tag will always pull the latest version available, or you can also download\nspecific version. Checkout [release](https://github.com/kha7iq/pingme/releases)\npage for available versions.\n\nDocker Registry\n\n```bash\ndocker pull khaliq/pingme:latest\n```\n\nGithub Registry\n\n```bash\ndocker pull ghcr.io/kha7iq/pingme:latest\n```\n\nRun\n\n```bash\ndocker run ghcr.io/kha7iq/pingme:latest\n```\n\n## Github Action\n\nA github action is available for integration with your workflows, you can find it on\n[Github Market Place](https://github.com/marketplace/actions/pingme-action) or\nhere [Github Repo](https://github.com/kha7iq/pingme-action).\n```yaml\n- name: PingMe-Action\n  uses: kha7iq/pingme-action@v1\n```\n\n## Usage\n\n```bash\n❯ pingme\n\nNAME:\n   PingMe - Send message to multiple platforms\n\nUSAGE:\n   main [global options] command [command options] [arguments...]\n\nDESCRIPTION:\n   PingMe is a CLI tool which provides the ability to send messages or alerts to multiple\n   messaging platforms and also email, everything is configurable via environment\n   variables and command line switches.Currently supported platforms include Slack, Telegram,\n   RocketChat, Discord, Pushover, Mattermost, Pushbullet, Microsoft Teams, Twillio, Mastodon,\n   email address, Line, Gotify and Wechat.\n\nCOMMANDS:\n   telegram    Send message to telegram\n   rocketchat  Send message to rocketchat\n   slack       Send message to slack\n   discord     Send message to discord\n   teams       Send message to microsoft teams\n   pushover    Send message to pushover\n   email       Send an email\n   mattermost  Send message to mattermost\n   pushbullet  Send message to pushbullet\n   twillio     Send sms via twillio\n   zulip       Send message to zulip\n   mastodon    Set status message for mastodon\n   line        Send message to line messenger\n   wechat      Send message to wechat official account\n   gotify      Send push notification to gotify server\n   help, h     Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --help, -h  show help (default: false)\n```\n\nCheck [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.\n\n## Configuration\n\nAll the flags have corresponding environment variables associated with it. You\ncan either provide the value with flags or export to a variable.\n\nView the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more\ndetails.\n\n## Contributing\n\nContributions, issues and feature requests are welcome!\u003cbr/\u003eFeel free to check\n[issues page](https://github.com/kha7iq/pingme/issues). You can also take a look\nat the [contributing guide](https://github.com/kha7iq/pingme/blob/master/CONTRIBUTING.md).\n\n## Acknowledgments\n\nThis project is based on amazing library [Notify](https://github.com/nikoksr/notify)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkha7iq%2Fpingme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkha7iq%2Fpingme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkha7iq%2Fpingme/lists"}