Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
DEPRECATED, see https://github.com/github/hubot-scripts/issues/1113 for details - optional scripts for hubot, opt in via hubot-scripts.json
CoffeeScript JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
src/scripts
test
.gitignore
CHANGELOG.md
LICENSE.md
Makefile
README.md
package.json

README.md

hubot-scripts

These are a collection of community scripts for Hubot, a chat bot for your company.

Installing

Once you have Hubot installed, you can drop new scripts from this repository right into your generated Hubot installation. Just put them in scripts, add the new scripts to the hubot-scripts.json file, restart your robot, and you're good to go.

All the scripts in this repository are located in src/scripts.

Writing

Want to write your own Hubot script? The best way is to take a look at an existing script and see how things are set up. Hubot scripts are written in CoffeeScript, a higher-level implementation of JavaScript.

You'll also want to add tests for your script; no one likes untested code. It makes Hubot sad.

Additionally, it's extremely helpful to add TomDoc to the top of each file. (Check out an example). We'll pull out the commands from those lines and display them in the generic, robot-wide hubot help command.

Please note we're no longer including external dependencies in the package.json, so should you wish to include them please include the package name and required version in the TomDoc comments at the top of your script.

Discovering

The Script Catalog

Something went wrong with that request. Please try again.