pingme

CLI do PingMe

Documentação • Serviços Suportados • Instalação • Ação do Github • Configuração • Contribuição •

---

Sobre

PingMe é um projeto pessoal para satisfazer minhas necessidades de alertas, a maioria das principais plataformas tem integração para enviar alertas, mas nem sempre é útil, ou você está preso a uma plataforma específica ou tem que fazer muitas integrações. Eu precisava de um pequeno utilitário que pudesse chamar de meus scripts de backup, tarefas cron, pipelines de CI/CD ou de qualquer lugar para enviar uma mensagem com informações específicas. E posso enviá-lo para qualquer lugar com facilidade. Daí o nascimento do PingMe.

Tudo é configurável através de variáveis ​​de ambiente, e você pode simplesmente exportar os logs ou mensagens para uma variável que será enviada como mensagem, e acima de tudo isso serve como uma ferramenta do tipo canivete suíço que suporta múltiplas plataformas.

Serviços suportados

• Discórdia
• E-mail
• Gotificar
• Linha
• Mastodonte
• Mais importante
• Equipes Microsoft
• Pushbullet
• Flexão
• RocketChat
• Folga
• Telegrama
• Texto mágico
• Twillio
• Zulip
• Conversamos

Instalar

Homebrew para MacOS e Linux

brew install kha7iq/tap/pingme

Script de shell

Por padrão, o pingme será instalado em /usr/bin/ sudo é necessário para esta operação.

Se desejar fornecer um caminho de instalação personalizado, você pode fazê-lo como entrada para o script. ou seja, ./install.sh $HOME/bin

curl -s https://raw.githubusercontent.com/kha7iq/pingme/master/install.sh | sudo sh

ou

curl -sL https://bit.ly/installpm | sudo sh

Linux

• AUR

 # build from sources
yay -S pingme

# binary
yay -S pingme-bin

Manual

 # Chose desired version, architecture & target os
export 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

Windows

scoop bucket add pingme https: // github.com / kha7iq / scoop - bucket.git
scoop install pingme

Alternativamente, você pode acessar as páginas de lançamento e baixar deb , rpm ou binary para Windows e todas as outras plataformas suportadas.

Docker

O contêiner Docker também está disponível no registro de contêiner do dockerhub e do github.

A tag latest sempre obterá a versão mais recente disponível ou você também pode baixar uma versão específica. Confira a página de lançamento para ver as versões disponíveis.

Registro Docker

docker pull khaliq/pingme:latest

Registro do GitHub

docker pull ghcr.io/kha7iq/pingme:latest

Correr

docker run ghcr.io/kha7iq/pingme:latest

Ação do Github

Uma ação do github está disponível para integração com seus fluxos de trabalho, você pode encontrá-la no Github Market Place ou aqui no Github Repo.

- name : PingMe-Action
  uses : kha7iq/pingme-action@v1 

Uso

❯ pingme

NAME:
   PingMe - Send message to multiple platforms

USAGE:
   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 and command 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 message for 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 or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Verifique a página de documentação para obter mais detalhes.

Configuração

Todos os sinalizadores possuem variáveis ​​de ambiente correspondentes associadas a eles. Você pode fornecer o valor com sinalizadores ou exportar para uma variável.

Veja a página de documentação para mais detalhes.

Contribuindo

Contribuições, problemas e solicitações de recursos são bem-vindos!
Sinta-se à vontade para verificar a página de problemas. Você também pode dar uma olhada no guia de contribuição.

Agradecimentos

Este projeto é baseado na incrível biblioteca Notify