notify_slack

README

notify_slack

Notify slack from the command line. It receives standard input and notifies Slack all at once every second (can be changed with the -interval option).

Please watch this video. https://www.youtube.com/watch?v=wmKSr9Aoz-Y

Installation

GO111MODULE=on go get github.com/catatsuy/notify_slack/cmd/notify_slack

Or you download from Releases.

If you want to develop, please use the make. This software requires Go 1.12 or higher.

make

usage

./bin/notify_slack posts to Slack. You specify the setting in command line option or toml setting file. If both settings are specified, command line option will always take precedence.

./bin/output | ./bin/notify_slack

./bin/output is used for testing. While buffering, to post to slack.

./bin/notify_slack README.md

You post the file as a snippet. token and channel is required to use the Slack Web API.

If you want to upload to snippet via standard input, you must specify -snippet. If you specify filename, you can change the file name on Slack.

git diff | ./bin/notify_slack -snippet -filename git.diff

Slack's API can specify filetype. You can also specify -filetype. But it is automatically determined from the extension of the file. You make sure to give the appropriate extension.

file type | Slack

CLI options

-c string
      config file name
-channel string
      specify channel
-filename string
      specify a file name (for uploading to snippet)
-filetype string
      specify a filetype (for uploading to snippet)
-icon-emoji string
      specify icon emoji
-interval duration
      interval (default 1s)
-slack-url string
      slack url
-snippet
      switch to snippet uploading mode
-token string
      token (for uploading to snippet)
-username string
      specify username
-version
      Print version information and quit

toml configuration file

By default check the following files.

1. a file specified with -c
2. $HOME/.notify_slack.toml
3. $HOME/etc/notify_slack.toml
4. /etc/notify_slack.toml

The contents of the toml file are as follows.

[slack]
url = "https://hooks.slack.com/services/**"
token = "xxxxx"
channel = "#general"
username = "tester"
icon_emoji = ":rocket:"
interval = "1s"

Note:

• url is a required parameter.
  • You can specify channel, username, icon_emoji and interval.
• token and channel is necessary if you want to post to snippet.
  • username and icon_emoji are ignored in this case.
• token can be created on https://api.slack.com/custom-integrations/legacy-tokens
• webhook url can be created on https://slack.com/services/new/incoming-webhook

Tips:

• If you want to default to another channel only for snippet, you can use snippet_channel.

(Advanced) Environment Variables

Some settings can be given by the following environment variables.

NOTIFY_SLACK_WEBHOOK_URL
NOTIFY_SLACK_TOKEN
NOTIFY_SLACK_CHANNEL
NOTIFY_SLACK_SNIPPET_CHANNEL
NOTIFY_SLACK_USERNAME
NOTIFY_SLACK_ICON_EMOJI

It will be useful if you want to use it on a container. If you use it, you don't need a configuration file anymore.

Release

Version of cli/cli.go will be updated.

When you execute the following command and give a tag, it will be released via CircleCI.

git tag v0.3.0
git push origin v0.3.0