https://github.com/ben/botkit-shell
Shell adapter for Botkit
https://github.com/ben/botkit-shell
Last synced: about 1 year ago
JSON representation
Shell adapter for Botkit
- Host: GitHub
- URL: https://github.com/ben/botkit-shell
- Owner: ben
- Created: 2016-06-20T02:10:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T17:34:05.000Z (over 8 years ago)
- Last Synced: 2025-04-09T03:38:00.816Z (about 1 year ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 10
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Botkit-Shell
This is a shell adapter for testing a [botkit](https://github.com/howdyai/botkit) bot, derived from the [Slack adapter](https://github.com/howdyai/botkit/blob/master/lib/SlackBot.js).
## Installing
You'll want to be running Node 6.1.0 or newer.
```shell
$ npm install --save botkit-shell
```
## Initializating
In your bot initialization code, do this:
```js
let shellbot = require('botkit-shell')
controller = shellbot({})
controller.spawn({})
```
The shellbot follows most of the same conventions as the Slack bot, since it's written
## Using
Start up your bot with this adapter, and you should get a prompt that looks like this:
```shell
##>
```
Interact as though you were in a public channel.
Switch to a DM context with `\dm`, switch back with `\ch`.
Do `\?` for more info on the shell commands.