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

Configuration

A few scripts (including some installed by default) require environmentvariables to be set as a simple form of configuration.

Each script should have a commented header which contains a "Configuration"section that explains which values it requires to be placed in which variable.When you have lots of scripts installed this process can be quite labourintensive. The following shell command can be used as a stop gap until aneasier way to do this has been implemented.

How to set environment variables will be specific to your operating system.Rather than recreate the various methods and best practices in achieving this,it's suggested that you search for a dedicated guide focused on your OS.

Scripting

An example script is included at scripts/example.coffee, so check it out toget started, along with the Scripting Guide.

For many common tasks, there's a good chance someone has already one to do justthe thing.

external-scripts

There will inevitably be functionality that everyone will want. Instead ofwriting it yourself, you can use existing plugins.

Hubot is able to load plugins from third-party npm packages. This is therecommended way to add functionality to your hubot. You can get a list ofavailable hubot plugins on npmjs.com or by using npm search:

To use a package, check the package's documentation, but in general it is:

Use npm install --save to add the package to package.json and install it

Add the package name to external-scripts.json as a double quoted string

You can review external-scripts.json to see what is included by default.

Advanced Usage

It is also possible to define external-scripts.json as an object toexplicitly specify which scripts from a package should be included. The examplebelow, for example, will only activate two of the six available scripts insidethe hubot-fun plugin, but all four of those in hubot-auto-deploy.

{
"hubot-fun": [
"crazy",
"thanks"
],
"hubot-auto-deploy": "*"
}

Be aware that not all plugins support this usage and will typically fallbackto including all scripts.

hubot-scripts

Before hubot plugin packages were adopted, most plugins were held in thehubot-scripts package. Some of these plugins have yet to bemigrated to their own packages. They can still be used but the setup is a bitdifferent.

To enable scripts from the hubot-scripts package, add the script name withextension as a double quoted string to the hubot-scripts.json file in thisrepo.

Persistence

If you are going to use the hubot-redis-brain package (strongly suggested),you will need to add the Redis to Go addon on Heroku which requires a verifiedaccount or you can create an account at Redis to Go and manuallyset the REDISTOGO_URL variable.

% heroku config:add REDISTOGO_URL="..."

If you don't need any persistence feel free to remove the hubot-redis-brainfrom external-scripts.json and you don't need to worry about redis at all.

Adapters

Adapters are the interface to the service you want your hubot to run on, suchas Campfire or IRC. There are a number of third party adapters that thecommunity have contributed. Check Hubot Adapters for theavailable ones.

If you would like to run a non-Campfire or shell adapter you will need to addthe adapter package as a dependency to the package.json file in thedependencies section.

Once you've added the dependency with npm install --save to install it youcan then run hubot with the adapter.

% bin/hubot -a <adapter>

Where <adapter> is the name of your adapter without the hubot- prefix.

Deployment

% heroku create --stack cedar
% git push heroku master

If your Heroku account has been verified you can run the following to enableand add the Redis to Go addon to your app.

Deploying to UNIX or Windows

Campfire Variables

If you are using the Campfire adapter you will need to set some environmentvariables. If not, refer to your adapter documentation for how to configure it,links to the adapters can be found on Hubot Adapters.

Create a separate Campfire user for your bot and get their token from the webUI.

% heroku config:add HUBOT_CAMPFIRE_TOKEN="..."

Get the numeric IDs of the rooms you want the bot to join, comma delimited. Ifyou want the bot to connect to https://mysubdomain.campfirenow.com/room/42and https://mysubdomain.campfirenow.com/room/1024 then you'd add it likethis:

% heroku config:add HUBOT_CAMPFIRE_ROOMS="42,1024"

Add the subdomain hubot should connect to. If you web URL looks likehttp://mysubdomain.campfirenow.com then you'd add it like this:

% heroku config:add HUBOT_CAMPFIRE_ACCOUNT="mysubdomain"

Restart the bot

You may want to get comfortable with heroku logs and heroku restart ifyou're having issues.