Skip to content

Module to help build a custom command-line vocabulary for your bot

License

Notifications You must be signed in to change notification settings

sdjmchattie/slack-terminalize

 
 

Repository files navigation

Slack Terminalize

Build Status Coverage Status


Helps build a command-line system in Slack, to create a custom vocabulary for your bot.


Motivation

This module was built to abstract away some of the basic tasks of massaging a message posted on Slack channel, before giving it to the bot. That said, this is an opinionated implementation, because as it is, it limits to building a linux shell-like environment, where the first word of the message is taken as the command and the words that follow, the arguments. You can find a sample app built to use this module from the links below.


Usage

var slackTerminal = require('slack-terminalize');

slackTerminal.init('<your-slack-token-here>', 
    {}, // slack-client options: https://github.com/slackhq/node-slack-client/blob/master/lib/clients/rtm/client.js
    {} // configurations for the app: https://github.com/ggauravr/slack-terminalize/blob/master/util/config.js
});

Checkout this app to get started and to know more about the options and configuration parameters to customize the behavior.


Installation

npm install --save slack-terminalize


Tests

npm test


Code Coverage

npm run cover


Help and Links

About

Module to help build a custom command-line vocabulary for your bot

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%