Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keisukeyamashita/notifyer
Notification util written in golang
https://github.com/keisukeyamashita/notifyer
cli discord golang line notifyer slack
Last synced: 16 days ago
JSON representation
Notification util written in golang
- Host: GitHub
- URL: https://github.com/keisukeyamashita/notifyer
- Owner: KeisukeYamashita
- License: mit
- Created: 2019-09-09T20:35:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-03T05:18:15.000Z (over 5 years ago)
- Last Synced: 2024-10-05T12:24:47.155Z (3 months ago)
- Topics: cli, discord, golang, line, notifyer, slack
- Language: Go
- Homepage:
- Size: 135 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notifyer
[![License][license-badge]][license]
[![GoDoc][godoc-badge]][godoc]
[![GolangCI][golangci-badge]][golangci]
[![Go Report Card][go-report-card-badge]][go-report-card]
> Extendable notification tool for various services
`notifyer` is a notification tool written in golang. It will read stdin and sends notification to services such as Slack, Discord and so on. You will have to configure by writting TOML file. Don't worry, it is very very simple to configure and to use.
## Install
### homebrew
```
$ brew tap KeisukeYamashita/notifyer
$ brew install notifyer
```
### git
```
$ git clone https://KeisukeYamashita/notifyer
$ make install
```
## Sample Usage
Post message to slack.
```
cat message.txt | notifyer slack
```
See below for detailed usage and supported services.
## Supports
### Input
Currently supports sdtin only.
### Output
Service name
Status
Discord
○
Slack
○
Line
○
## Usage
### Config file
The script will check the following files for configuration.
1. `NOTIFYER_PATH` env var
1. `$HOME/.notify_discord`
The config toml file should be in this format.
```toml
[slack]
url = "hogehoge"
channel = "poip"
[linebot]
accessToken = ""
to = ""
[discord]
url = "https://"
```
### Slack
```
echo "Hello fron Notifyer" | notifyer slack
```
### Line
```
echo "Hello fron Notifyer" | notifyer linebot
```
### Discord
```
echo "Hello fron Notifyer" | notifyer discord
```
### Docker mode
Also docker images are supported.
```
echo "Hello from Notifyer" | docker run -v $HOME/.notifyer.toml:/root/.notifyer.toml 1915keke/notifyer:0.1.0 slack
```
## Contribution
* I welcome your contributions.
* Please send issues and pull requests.
## License
Notifyer is released under the MIT license.
© 2019 GitHub, Inc.
## Author
* [KeisukeYamashita](https://github.com/KeisukeYamashita)
[license]: LICENSE
[godoc]: https://godoc.org/github.com/KeisukeYamashita/notifyer
[go-report-card]: https://goreportcard.com/report/github.com/KeisukeYamashita/notifyer
[golangci]: https://golangci.com/r/github.com/KeisukeYamashita/notifyer
[license-badge]: https://img.shields.io/badge/license-Apache%202.0-%23E93424
[circleci-badge]: https://img.shields.io/circleci/project/github/micnncim/protocol-buffers-language-server.svg?label=circleci&logo=circleci
[godoc-badge]: https://img.shields.io/badge/godoc.org-reference-blue.svg
[go-report-card-badge]: https://goreportcard.com/badge/github.com/KeisukeYamashita/notifyer
[golangci-badge]: https://golangci.com/badges/github.com/KeisukeYamashita/notifyer