notifier

A simple notifier CLI for Discord and Slack with Webhook. Powered by Go.

• 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 and for Slack, check Slack documentation.

Install

From Go

With this install, you cannot use .env file

go install github.com/ewilan-riviere/notifier@latest

From source

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.

cp .env.example .env

Create symlink to use notifier everywhere

sudo rm -f /usr/local/bin/notifier
sudo ln -s ~/notifier/notifier /usr/local/bin
sudo chmod +x /usr/local/bin/notifier

As library

go get github.com/ewilan-riviere/notifier@latest

Usage (CLI)

With webhook URL

Send a message to Discord or Slack.

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

notifier discord "Hello World" XXXXXXXXX/XXXXXXXXX
notifier slack "Hello World" XXXXXXXXX/XXXXXXXXX/XXXXXXXXX

With .env file

[!IMPORTANT]

Available only if you install from source.

cp .env.example .env

Add your Discord and Slack webhooks, you can leave it blank.

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.

notifier discord "Hello World"
notifier slack "Hello World"

Usage (library)

You have to import notify package.

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.

#!/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.

chmod +x /usr/local/bin/notify

Use it in your GitLab CI, without .env file and hidden credentials.

stages:
  - deploy

deploy-job:
  stage: deploy
  image: alpine:latest
  script:
    - notify '$CI_PROJECT_TITLE deployed'
  only:
    - main

Test

To locally test

go build -o notifier && ./notifier

Execute tests

go test ./pkg/... -coverprofile=coverage.out
go test -v ./...
go test -v ./pkg/webhook

License

MIT © Ewilan Rivière