/go-notify

A GOlang CLI that allows you to report any type of information to some group chat software

Primary LanguageGoMIT LicenseMIT

go-notify

GOlang CLI that allows you to report any type of information to some group chat software like Microsoft Teams.

Table of Contents

  1. Develop
  2. Usage
    2.1. Microsoft Teams
           2.1.1 messageCard
           2.1.2 adaptiveCard
  3. Examples
    3.1. Microsoft Teams
           3.1.1 Desktop
           3.1.2 Mobile

1.Develop

If your git command is authenticated globally:

go get -u github.com/hugo-lorenzo-mato/go-notify.git

Else:

mkdir -p src/github.com/hugo-lorenzo-mato
cd srcgithub.com/hugo-lorenzo-mato
git clone https://github.com/hugo-lorenzo-mato/go-notify.git
cd go-notify
export GOPATH={Absolute path to the directory immediately before .../src/ created previously}
go build

2.Usage

$go-notify.exe --help

NAME:
   go-notify.exe - Reports any type of incident to the configured messaging services

USAGE:
   go-notify.exe [global options] command [command options] [arguments...]

VERSION:
   0.0.1

COMMANDS:
     microsoftTeams  Microsoft Teams Channel report options
     help, h         Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug, -d               Activate debug mode
   --config value, -c value  Yaml config file path (default: ".")
   --help, -h                show help
   --version, -v             print the version
2.1 microsftTeams
$go-notify.exe microsoftTeams --help

NAME:
   go-notify.exe microsoftTeams - Microsoft Teams Channel report options

USAGE:
   go-notify.exe microsoftTeams command [command options] [arguments...]

COMMANDS:
     messageCard   Report any type of information to Microsoft Teams Channel using messageCard card type
     adaptiveCard  Report any type of information to Microsoft Teams Channel using adaptiveCard card type

OPTIONS:
   --help, -h  show help
2.1.1 messageCard
$go-notify.exe microsoftTeams messageCard --help

NAME:
   go-notify.exe microsoftTeams messageCard - Report any type of information to Microsoft Teams Channel using messageCard card type

USAGE:
   go-notify.exe microsoftTeams messageCard [command options] [arguments...]

OPTIONS:
   --hookUrl value    Channel webhook URL
   --cardTitle value  Card title
   --cardText value   Card text
   --uriAction value  URI action
   --planKey value    Plan key
2.1.2 adaptiveCard
NOT YET IMPLEMENTED

3.Examples

3.1 Microsoft Teams
3.1.1 Desktop

Microsoft Teams Golang CLI Desktop Message Card Black

Microsoft Teams Golang CLI Desktop Message Card White

3.1.2 Mobile

Microsoft Teams Golang CLI Desktop Message Card Black Mobile

Microsoft Teams Golang CLI Desktop Message Card Black Notification