This is a version of GitHub's Campfire bot, hubot. He's pretty cool.
You'll probably never have to hack on this repo directly.
Instead this repo provides a library that's distributed by
npm that you
simply require in your project. Follow the instructions below and get your own
hubot ready to deploy.
Getting your own
Download the latest version of hubot.
Then follow the instructions in the README in the extracted
Adapters are the interface to the service you want your hubot to run on. This can be something like Campfire or IRC. There are a number of third party adapters that the community have contributed. Check the hubot wiki for the available ones and how to create your own.
Please submit issues and pull requests for third party adapters to the adapter repo, not this repo (unless it's the Campfire or Shell adapter).
Hubot ships with a number of default scripts, but there's a growing number of
extras in the hubot-scripts repository.
hubot-scripts is a
way to share scripts with the entire community.
Check out the README for more help on installing individual scripts.
This functionality allows users to enable scripts from
npm packages which
don't have to be included in the
To enable to functionality you can follow the following steps.
- Add the packages as dependencies into your
npm installto make sure those packages are installed
To enable third-party scripts that you've added you will need to add the package
name as a double quoted string to the
external-scripts.json file for your
Creating a script package
Creating a script package for hubot is very simple. Start by creating a normal
npm package. Make sure you add a main file for the entry point (e.g.
In this entry point file you're going to have to export a function that hubot
will use to load the scripts in your package. Below is a simple example for
loading each script in a
./scripts directory in your package.
Fs = require 'fs' Path = require 'path' module.exports = (robot) -> path = Path.resolve __dirname, 'scripts' Fs.exists path, (exists) -> if exists robot.loadFile path, file for file in Fs.readdirSync(path)
After you've built your
npm package you can publish it to npmjs.
Hubot has a HTTP listener which listens on the port specified by the
You can specify routes to listen on in your scripts by using the
module.exports = (robot) -> robot.router.get "/hubot/version", (req, res) -> res.end robot.version
There are functions for GET, POST, PUT and DELETE, which all take a route and callback function that accepts a request and a response.
In addition, if you set
CONNECT_STATIC, the HTTP listener will serve static
files from this directory.
Testing hubot locally
Install all of the required dependencies by running
It's easy to test scripts locally with an interactive shell:
% export PATH="node_modules/.bin:$PATH" % bin/hubot
... and to run unit tests:
% make test