Skip to content

A pluggable SlackBot to easily interface with your Slack instance.

License

Notifications You must be signed in to change notification settings

nbar1/pluggable-slackbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pluggable Slackbot

A library to create an easily pluggable slackbot for your Slack instance.

Installation

npm install pluggable-slackbot

Usage

var pluggableSlackbot = require('pluggable-slackbot');

var bot = new pluggableSlackbot({
	token: 'your-slack-api-token',
	name: 'SlackBot',
	iconUrl: 'url-to-bot-icon',
	pluginPath: __dirname + '/plugins',
});

To invoke a reponse from your bot on Slack, you can either message the bot directly or reference it in a channel by starting your message with the bots name like SlackBot, flip a coin

Creating Plugins

You can create plugins and store them in the specified pluginPath.

There are example plugins in the example-plugins folder.

Tests

Tests are implemented but there is not full coverage yet

yarn test

About

A pluggable SlackBot to easily interface with your Slack instance.

Resources

License

Stars

Watchers

Forks

Packages

No packages published