Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ewilan-riviere/notifier
CLI command to send notification on Discord or Slack.
https://github.com/ewilan-riviere/notifier
cli discord go slack webhook
Last synced: about 1 month ago
JSON representation
CLI command to send notification on Discord or Slack.
- Host: GitHub
- URL: https://github.com/ewilan-riviere/notifier
- Owner: ewilan-riviere
- License: mit
- Created: 2023-07-16T18:52:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-25T10:07:38.000Z (about 1 year ago)
- Last Synced: 2023-10-26T09:27:49.245Z (about 1 year ago)
- Topics: cli, discord, go, slack, webhook
- Language: Go
- Homepage: https://pkg.go.dev/github.com/ewilan-riviere/notifier
- Size: 2.15 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# notifier
[![go][go-version-src]][go-version-href]
[![tests][tests-src]][tests-href]
[![license][license-src]][license-href]
A simple notifier CLI for Discord and Slack with Webhook. Powered by [Go][go-version-href].
- `discord`: send a message to Discord (from CLI or `.env` file)
- `slack`: send a message to Slack (from CLI or `.env` file)
> [!NOTE]
>
> To use Webhooks with Discord, check [Discord documentation](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) and for Slack, check [Slack documentation](https://api.slack.com/messaging/webhooks).
## Install
### From Go
With this install, you cannot use `.env` file
```bash
go install github.com/ewilan-riviere/notifier@latest
```
### From source
```bash
git clone https://github.com/ewilan-riviere/notifier.git
cd notifier
go build -o notifier
```
Create `.env` file and add your Discord and Slack webhooks, you can leave it blank.
```bash
cp .env.example .env
```
Create symlink to use `notifier` everywhere
```bash
sudo rm -f /usr/local/bin/notifier
sudo ln -s ~/notifier/notifier /usr/local/bin
sudo chmod +x /usr/local/bin/notifier
```
### As library
```bash
go get github.com/ewilan-riviere/notifier@latest
```
## Usage (CLI)
### With webhook URL
Send a message to Discord or Slack.
```bash
notifier discord "Hello World" https://discord.com/api/webhooks/XXXXXXXXX/XXXXXXXXX
notifier slack "Hello World" https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXX
```
You can use only channel
```bash
notifier discord "Hello World" XXXXXXXXX/XXXXXXXXX
notifier slack "Hello World" XXXXXXXXX/XXXXXXXXX/XXXXXXXXX
```
### With `.env` file
> [!IMPORTANT]
>
> Available only if you install from source.
```bash
cp .env.example .env
```
Add your Discord and Slack webhooks, you can leave it blank.
```yaml
DISCORD_WEBHOOK=XXXXXXXXX/XXXXXXXXX
SLACK_WEBHOOK=XXXXXXXXX/XXXXXXXXX/XXXXXXXXX
```
Send a message to Discord or Slack, with `.env` file.
> [!NOTE]
>
> If you use `.env` file, you can omit the webhook argument, it will be automatically used.
```bash
notifier discord "Hello World"
notifier slack "Hello World"
```
## Usage (library)
You have to import `notify` package.
```go
import "github.com/ewilan-riviere/notifier/notify"
func main() {
notify.Notifier("To discord", "https://discord.com/api/webhooks/XXXXXXXXX/XXXXXXXXX")
notify.Notifier("To slack", "https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXX")
// Works with channel only
notify.Notifier("To discord", "XXXXXXXXX/XXXXXXXXX") // Will send to Discord
notify.Notifier("To slack", "XXXXXXXXX/XXXXXXXXX/XXXXXXXXX") // Will send to Slack
}
```
## Example with GitLab CI
You can install locally `notifier` and use it in your GitLab CI. The better solution is to use `.env` file, with installation from source. But in this example, we use webhook URL.
You can create a script, for example `notify`, on your server, on `/usr/local/bin` for example to use it everywhere.
```bash
#!/bin/bash
notifier discord "$1" https://discord.com/api/webhooks/XXXXXXXXX/XXXXXXXXX
notifier slack "$1" https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXX
```
Allow execution of this script.
```bash
chmod +x /usr/local/bin/notify
```
Use it in your GitLab CI, without `.env` file and hidden credentials.
```yaml
stages:
- deploy
deploy-job:
stage: deploy
image: alpine:latest
script:
- notify '$CI_PROJECT_TITLE deployed'
only:
- main
```
## Test
To locally test
```bash
go build -o notifier && ./notifier
```
Execute tests
```bash
go test ./pkg/... -coverprofile=coverage.out
go test -v ./...
go test -v ./pkg/webhook
```
## License
[MIT](LICENSE) © Ewilan Rivière
[go-version-src]: https://img.shields.io/static/v1?style=flat&label=Go&message=v1.21&color=00ADD8&logo=go&logoColor=ffffff&labelColor=18181b
[go-version-href]: https://go.dev/
[tests-src]: https://img.shields.io/github/actions/workflow/status/ewilan-riviere/notifier/run-tests.yml?branch=main&label=tests&style=flat&colorA=18181B
[tests-href]: https://packagist.org/packages/ewilan-riviere/notifier
[license-src]: https://img.shields.io/github/license/ewilan-riviere/notifier.svg?style=flat&colorA=18181B&colorB=00ADD8
[license-href]: https://github.com/ewilan-riviere/notifier/blob/main/LICENSE