https://github.com/sari3l/notify

各端、平台快速消息通知程序，支持配置文件形式或API调用
https://github.com/sari3l/notify

api bark chanify dingtalk discord executable feishu mailgun notifications telegram

Last synced: 3 months ago
JSON representation

各端、平台快速消息通知程序，支持配置文件形式或API调用

• Host: GitHub
• URL: https://github.com/sari3l/notify
• Owner: sari3l
• License: gpl-3.0
• Created: 2022-06-14T02:56:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-25T06:23:50.000Z (5 months ago)
• Last Synced: 2024-07-25T07:37:13.577Z (5 months ago)
• Topics: api, bark, chanify, dingtalk, discord, executable, feishu, mailgun, notifications, telegram
• Language: Go
• Homepage:
• Size: 94.7 KB
• Stars: 21
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - sari3l/notify - 各端、平台快速消息通知程序，支持配置文件形式或API调用 (Go)

README

        


[![license](https://img.shields.io/github/license/sari3l/notify?style=flat-square)](https://github.com/sari3l/notify/LIENCES)

[![Go Report Card](https://goreportcard.com/badge/github.com/sari3l/notify)](https://goreportcard.com/report/github.com/sari3l/notify)

[![CodeFactor](https://www.codefactor.io/repository/github/sari3l/notify/badge)](https://www.codefactor.io/repository/github/sari3l/notify)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsari3l%2Fnotify.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsari3l%2Fnotify?ref=badge_shield)

## Usage

```shell

> ./notify -h       

Usage:

  notify [OPTIONS]

Application Options:

  -s, --show        显示配置信息

  -c, --config=     指定配置文件 (default: $HOME/.config/notify-config.yaml)

  -i, --id=         指定通知id

  -l, --level=      指定通告等级 (default: 0)

  -a, --aboveLevel= 指定最低通告等级

  -n, --noticer=    指定通知模块

  -v, --version     版本信息

Help Options:

  -h, --help        Show this help message

```

## 安装

```shell

go install -v github.com/sari3l/notify/cmd/notify@latest

```

## 配置

1. 配置文件默认路径`$HOME/.config/notify-config.yaml`，或通过`-c|--config`指定

2. 具体每个推送配置、样例见相关路径下 README.md

### 基本设置

每个配置内容下均可以设置三个参数，均可在`-s`中可见

- notifyLevel 指定当前配置等级，默认`0`

- notifyFormatter 指定当前配置内容占位符，默认`[]`

- notifyDescription 当前配置内容描述内容，默认`""`

## 支持

- 多参输入

  - `echo -e "part1\npart2" | notify -n bark`

  - `notify part1 part22 -n bark`

- 指定id、level、模块，或最低level广播

- 多占位自动映射

  ```golang

  opt := feishu.Option{Webhook: viper.GetString("notify.webhook")}

  opt.NotifyFormatter = []string{"{{part1}}", "{{part2}}"}

  opt.MsgType = "text"

  opt.Content = map[string]any{"text": "{{part2}}{{part1}}"}

  opt.ToNotifer.Send([]string{"1","2"})

  

  >> 21

  ```

## Licenses

[GPL v3.0](https://github.com/sari3l/nofity/blob/main/LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsari3l%2Fnotify.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsari3l%2Fnotify?ref=badge_large)