https://github.com/eddywashere/ghost-bot

A chatbot/cli built with yargs & claudia.js
https://github.com/eddywashere/ghost-bot

bot chat chatbot claudia claudia-bot-builder claudiajs slack yargs

Last synced: 25 days ago
JSON representation

A chatbot/cli built with yargs & claudia.js

• Host: GitHub
• URL: https://github.com/eddywashere/ghost-bot
• Owner: eddywashere
• Created: 2017-06-17T19:11:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-17T19:54:14.000Z (over 7 years ago)
• Last Synced: 2024-09-18T05:08:14.964Z (about 2 months ago)
• Topics: bot, chat, chatbot, claudia, claudia-bot-builder, claudiajs, slack, yargs
• Language: JavaScript
• Size: 125 KB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ghost-bot

A CLI inspired lambda chat bot and CLI. Built with [yargs](http://yargs.js.org), [yargs-promise](https://github.com/eddywashere/yargs-promise), and [Claudia.js](https://claudiajs.com).

## Resources

- [Claudia.js](https://claudiajs.com/tutorials/index.html)

- [Delayed Responses to Slack Slash Commands](https://claudiajs.com/tutorials/slack-delayed-responses.html)

- [Yargs Docs](http://yargs.js.org/docs/)

## Setup

Install dependencies via yarn:

```

yarn install

```

or install dependencies via npm:

```

npm install

```

## Running locally

To test the command functionality without deploying, run `npm link` to link this package to your global npm modules. It's very similar to running `npm install -g {packagename}`. (make sure the )

```sh

cd ghost-bot

npm link

ghost --help

```

## From slack

Type out `/ghost logs` or `/ghost --help` for more info.

## Deploying

Create a slack slash command and grab the token - [docs](https://my.slack.com/services/new/slash-commands)

Create the lambda and configure the slash command.

```

npm run claudia:create

```

Deploying

```

npm run claudia:update

```

## Example

![preview](./example.png)