Categorygithub.com/davidvader/skelly
repository
0.0.3
Repository: https://github.com/davidvader/skelly.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

Skelly

Skelly is a Slack bot for automatically reacting to user typing, written in Go

Usage

To configure Skelly, all you need to do is

  1. Invite Skelly to your Slack channel
/invite @skelly
  1. Add a reaction in Slack through Skelly's slash commands

See also

/skelly help
/skelly add @slack-admins
  1. Start typing!

If you want your response to include nice links, use the following syntax:

<http://www.foo.com|This message is a link>

Managing Reactions

For a list of useful commands, try

/skelly help
CommandInputEffect
/skelly helpNONEprints helpful information
/skelly addNONEopens the modal for adding a typing reaction in that channel
/skelly addNONEadds a typing reaction in that channel for all users
/skelly updateNONEopens the modal for updating a typing reaction
/skelly deleteNONEopens the modal for deleting a typing reaction
/skelly listNONE`lists all typing reactions that exist in that channel

Development

To run the bot locally, simply configure the environment and use the Makefile

Interact with Skelly using the built-in CLI to make developing locally easier.


$ make build

$ ./release/skelly --help

$ ./release/skelly reaction add --channel <CHANNEL_ID> --response "Hello!"

$ ./release/skelly reaction trigger --channel <CHANNEL_ID> --user <USER_ID>

Environment

Store the required configurations in either your environment or an .env file

VariableSource
SKELLY_BOT_TOKENSlack bot token
SKELLY_VERIFICATION_TOKENSlack verification token
SKELLY_SIGNING_SECRETSlack signing secret
SKELLY_MONGO_HOSTMongo DB host
SKELLY_MONGO_DBMongo DB database name
SKELLY_MONGO_USERNAMEMongo DB username
SKELLY_MONGO_PASSWORDMongo DB password

Make

Use the Makefile to build and run the binary or the Docker image

# clone and navigate to skelly
$ git clone [email protected]:davidvader/skelly.git
$ cd skelly

# build the skelly binary and run the server
$ make up

Trigger the bot with You can also simulate all of Skelly's bot functionality using the Skelly CLI

# build the skelly binary
$ make build

# move the binary to bin
$ cp release/skelly /usr/local/bin/

# run the application
$ skelly --help

# add a reaction
$ skelly reaction view --channel C016DRZPLBC

# list reactions
$ skelly reaction list --channel C016DRZPLBC