Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CatchZeng/dingtalk

DingTalk(dingding) 是钉钉机器人的 go 实现。支持 Docker、Jenkinsfile、命令行模式，module 模式，加签安全设置，支持链式语法创建消息，支持文本、链接、Markdown、ActionCard、FeedCard消息类型; DingTalk (dingding) is the go implementation of the DingTalk robot. Support Docker, Jenkinsfile, command line mode, module mode, signature security settings, chain syntax to create messages, support text, link, markdown,ActionCard,FeedCard message types.
https://github.com/CatchZeng/dingtalk

dingding dingding-alert dingding-bot dingding-golang dingtalk dingtalk-robot dingtalk-sdk jenkins

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/CatchZeng/dingtalk
Owner: CatchZeng
License: mit
Created: 2020-02-21T12:37:12.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-05-10T09:29:10.000Z (over 1 year ago)
Last Synced: 2024-06-20T10:19:19.244Z (3 months ago)
Topics: dingding, dingding-alert, dingding-bot, dingding-golang, dingtalk, dingtalk-robot, dingtalk-sdk, jenkins
Language: Go
Homepage:
Size: 98.6 KB
Stars: 214
Watchers: 3
Forks: 35
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # dingtalk

![Go](https://github.com/CatchZeng/dingtalk/workflows/Go/badge.svg)

[![codecov](https://codecov.io/gh/CatchZeng/dingtalk/branch/master/graph/badge.svg)](https://codecov.io/gh/CatchZeng/dingtalk)

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

[![Release](https://img.shields.io/github/release/CatchZeng/dingtalk.svg)](https://github.com/CatchZeng/dingtalk/releases)

[![GoDoc](https://godoc.org/github.com/CatchZeng/dingtalk?status.svg)](https://pkg.go.dev/github.com/CatchZeng/dingtalk?tab=doc)

[English](https://github.com/CatchZeng/dingtalk/blob/master/READMEEN.md)

> DingTalk(dingding) 是钉钉机器人的 go 实现。支持 **Docker、Jenkinsfile、命令行模式，module 模式**；支持**加签**安全设置，支持**链式语法**创建消息；支持**文本、链接、Markdown、ActionCard、FeedCard** 消息类型。

> 注：使用飞书的小伙伴，可以使用[飞书（feishu）版](https://github.com/CatchZeng/feishu)。

## 文档

[钉钉文档](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq)

## 特性

- [x] 支持[Docker](https://github.com/CatchZeng/dingtalk#Docker)

- [x] 支持[Jenkinsfile](https://github.com/CatchZeng/dingtalk#Jenkinsfile)

- [x] 支持[module](https://github.com/CatchZeng/dingtalk#%E4%BD%9C%E4%B8%BA-module)

- [x] 支持[命令行模式](https://github.com/CatchZeng/dingtalk#%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7)

- [x] 支持[配置文件](https://github.com/CatchZeng/dingtalk#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6)

- [x] 支持[环境变量](https://github.com/CatchZeng/dingtalk#%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F)

- [x] 支持加签



- [x] Text 消息



- [x] Link 消息



- [x] Markdown 消息



- [x] ActionCard 消息

    

    

- [x] FeedCard 消息



## 安装

## Docker 安装

```shell

docker pull catchzeng/dingtalk

```

### 二进制安装

到 [releases](https://github.com/CatchZeng/dingtalk/releases/) 下载相应平台的二进制可执行文件，然后加入到 PATH 环境变量即可。

### go install 安装

```sh

# Go 1.16+

go install github.com/CatchZeng/[email protected]

# Go version < 1.16

go get -u github.com/CatchZeng/[email protected]

```

## 使用方法

### 配置文件

可以在 `$/HOME/.dingtalk` 下创建 `config.yaml` 填入 `access_token` 和 `secret` 默认值。

```yaml

access_token: "1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f"

secret: "SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68"

```

### 环境变量

```sh

$ export ACCESS_TOKEN="1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f"

$ export SECRET="SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68"

$ dingtalk link -i "标题" -e "信息" -u "https://makeoptim.com/" -p "https://makeoptim.com/assets/img/logo.png" -a

```

你也可以为环境变量设置一个**前缀**

```sh

$ export DINGTALK_ENV_PREFIX="DINGTALK_"

$ export DINGTALK_ACCESS_TOKEN="1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f"

$ export DINGTALK_SECRET="SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68"

$ dingtalk link -i "标题" -e "信息" -u "https://makeoptim.com/" -p "https://makeoptim.com/assets/img/logo.png" -a

```

### Docker

```shell

docker run catchzeng/dingtalk dingtalk text -t 1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f -s SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68 -c "docker test"

```

### Jenkinsfile

```shell

pipeline {

    agent {

        docker {

            image 'catchzeng/dingtalk:latest'

        }

    }

    environment {

        DING_TOKEN = '1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f'

        DING_SECRET = 'SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68'

    }

    stages {

        stage('notify') {

            steps {

                sh 'dingtalk link -t ${DING_TOKEN} -s ${DING_SECRET} -i "标题" -e "信息" -u "https://makeoptim.com/" -p "https://makeoptim.com/assets/img/logo.png" -a'

            }

        }

    }

}

```

### 作为 module

```sh

go get github.com/CatchZeng/dingtalk

```

```go

package main

import (

    "log"

    "github.com/CatchZeng/dingtalk/pkg/dingtalk"

)

func main() {

	accessToken := "1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f"

    secret := "SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68"

    client := dingtalk.NewClient(accessToken, secret)

    msg := dingtalk.NewTextMessage().SetContent("测试文本&at 某个人").SetAt([]string{"177010xxx60"}, false)

    client.Send(msg)

}

```

### 命令行工具

#### Demo

```shell

$ dingtalk text -t 1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f -s SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68 -c "测试命令行 & at 某个人" -m "177010xxx60","177010xxx61"

```

```shell

$ dingtalk markdown -D -i "杭州天气" -e '## 杭州天气 @150XXXXXXXX

 > 9度，西北风1级，空气良89，相对温度73%

 > ![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png)

 > ###### 10点20分发布 [天气](https://www.dingtalk.com)' -t 1c53e149ba5de6597cxxxxxx0e901fdxxxxxx80b8ac141e4a75afdc44c85ca4f -s SECb90923e19e58b466481e9e7b7a5bxxxxxx4531axxxxxxad3967fb29f0eae5c68

{"msgtype":"markdown","markdown":{"title":"杭州天气","text":"## 杭州天气 @150XXXXXXXX\n \u003e 9度，西北风1级，空气良89，相对温度73%\n \u003e ![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png)\n \u003e ###### 10点20分发布 [天气](https://www.dingtalk.com)"},"at":{"atMobiles":[],"isAtAll":false}}

```

> -D 参数：打印发送的消息内容

#### Help

```shell

$ dingtalk -h

dingtalk is a command line tool for DingTalk

Usage:

  dingtalk [command]

Available Commands:

  actionCard  send actionCard message with DingTalk robot

  feedCard    send feedCard message with DingTalk robot

  help        Help about any command

  link        send link message with DingTalk robot

  markdown    send markdown message with DingTalk robot

  text        send text message with DingTalk robot

  version     dingtalk version

Flags:

  -t, --access_token string   access_token

  -m, --atMobiles strings     atMobiles

  -D, --debug                 debug

  -h, --help                  help for dingtalk

  -a, --isAtAll               isAtAll

  -s, --secret string         secret

Use "dingtalk [command] --help" for more information about a command.

```

## Stargazers

[![Stargazers over time](https://starchart.cc/CatchZeng/dingtalk.svg)](https://starchart.cc/CatchZeng/dingtalk)