Categorygithub.com/nezorflame/bd-reminder-bot
repositorypackage
1.1.0
Repository: https://github.com/nezorflame/bd-reminder-bot.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

bd-reminder-bot Go Report Card Build Status

Slack bot to remind your team and team manager about the upcoming birthdays.

Requires Go 1.8+ (1.10+ for Go modules support).

Inspired by mybot from RapidLoop at https://github.com/rapidloop/mybot

Install

  • with module-aware go get:
go get github.com/nezorflame/bd-reminder-bot
  • without:
go get -u github.com/nezorflame/bd-reminder-bot
cd $GOPATH/src/github.com/nezorflame/bd-reminder-bot
go install

Usage

Flags

FlagTypeDescriptionDefault
configstringConfig file name (without extension)config
dbstringBoltDB file location./bolt.db
debugboolDebug level for logsfalse

Config

Example configuration can be found in config.example.toml

Available commands

CommandDescription
hiPrints the greeting message
birthdayPrints the amount of days left to the next user's birthday
turnoffPrints the farewell message and exits (manager only)

Before using any command, mention the bot username before the command name, like this:

@bdreminder hi

Limitations

Currently users have to fill their birthday into the Skype field (because there is no Birthday field available) so that bot could parse it.

This behaviour will change in the future versions.