Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.58 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.58 KB
Raw

PHINEAS

Build Status

Installing dependencies

$ npm install

Slack launch

$ HUBOT_SLACK_TOKEN=xoxb-YOUR-TOKEN-HERE ./bin/hubot --adapter slack

Your Slack API token is on the Edit configuration from here.

Phineas is a chat bot built on the Hubot framework. It was initially generated by generator-hubot, and configured to be deployed on Heroku to get you up and running as quick as possible.

This README is intended to help get you started. Definitely update and improve to talk about your own instance, how to use and deploy, what functionality is available, etc!

Running Phineas Locally

You can test your hubot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.

You can start Phineas locally by running:

% bin/hubot

You'll see some start up output and a prompt:

[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
Phineas>

Then you can interact with Phineas by typing Phineas help.

Phineas > Phineas help
Phineas animate me <query> - The same thing as `image me`, except adds [snip]
Phineas help - Displays all of the help commands that Phineas knows about.
...