slacksend/README.md

85 lines
1.5 KiB
Markdown

# slacksend
Slackにメッセージを送信するツール
- [slacksend](#slacksend)
- [Environments](#environments)
- [Functions](#functions)
- [How To Use](#how-to-use)
- [Develop](#develop)
- [Init](#init)
- [Aiuto Docs](#aiuto-docs)
- [Markdown](#markdown)
- [Webserver](#webserver)
## Environments
Slack Appで`Incoming Webhook`を有効にする必要があります。
[Slack App](https://api.slack.com/apps)はこちらからどうぞ
* 参考記事: https://qiita.com/to3izo/items/c2d16f8b3e52b09e543e
## Functions
* Slackのチャンネルにメッセージを送信する
* Incoming Webhookに対応
* `SLACK_WEBHOOK_URL` : URLを指定する
* `--title`: タイトルを設定する
* 現在の仕様ではチャンネル設定はできません。
* 宛先によりチャンネルを設定します。
---
## How To Use
Incoming Webhookでメッセージを送信する場合
```sh
export SLACK_WEBHOOK_URL="https://hooks.slack.com/services/XXX/YYY/ZZZ"
slacksend --title "タイトル" "本文を指定してください"
```
## Develop
実行
```sh
go run ./cmd/slacksend
```
ビルド
```sh
go build -o slacksend ./cmd/slacksend
```
### Init
```sh
go mod init gitea.pglikers.com/tools/slacksen
```
### Aiuto Docs
#### Markdown
`gomarkdoc`のInstallが必要です
```sh
go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
gomarkdoc ./... > docs/api.md
```
#### Webserver
`pkgsite`のInstallが必要です
```sh
go install golang.org/x/pkgsite/cmd/pkgsite@latest
pkgsite
```