{"id":1298,"date":"2015-06-01T18:13:22","date_gmt":"2015-06-01T10:13:22","guid":{"rendered":"http:\/\/www.strongd.net\/?p=1298"},"modified":"2015-07-30T17:34:21","modified_gmt":"2015-07-30T09:34:21","slug":"getting-started-with-hubot","status":"publish","type":"post","link":"https:\/\/www.strongd.net\/?p=1298","title":{"rendered":"Getting Started With Hubot"},"content":{"rendered":"

You will need node.js<\/a> and npm<\/a>. Joyent has
\nan excellent blog post on how to get those installed<\/a>, so we’ll omit those details here.<\/p>\n

Once node and npm are ready, we can install the hubot generator:<\/p>\n

\n
%  npm install -g yo generator-hubot\r\n<\/code><\/pre>\n<\/div>\n
This will give us the hubot<\/code> yeoman<\/a> generator. Now we
\ncan make a new directory, and generate a new instance of hubot in it. For example, if
\nwe wanted to make a bot called myhubot:<\/p>\n
\n
% mkdir myhubot\r\n% cd myhubot\r\n% yo hubot\r\n<\/code><\/pre>\n<\/div>\n
At this point, you’ll be asked a few questions about who is creating the bot,
\nand which adapter<\/a> you’ll be using. Adapters are hubot’s way of
\nintegrating with different chat providers.<\/p>\n
If you are using git, the generated directory includes a .gitignore, so you can
\ninitialize and add everything:<\/p>\n
\n
% git init\r\n% git add .\r\n% git commit -m \"Initial commit\"\r\n<\/code><\/pre>\n<\/div>\n
If you’d prefer to automate your hubot build without being interactively
\nprompted for its configuration, you can add the following options
\nto the yo hubot<\/code> command to do so:<\/p>\n\n\n\n\n\n\n\n\n\n
Option<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
--owner=\"Bot Wrangler <bw@example.com>\"<\/code><\/td>\nBot owner, e.g. “Bot Wrangler bw@example.com<\/a>“<\/td>\n<\/tr>\n
--name=\"Hubot\"<\/code><\/td>\nBot name, e.g. “Hubot”<\/td>\n<\/tr>\n
--description=\"Delightfully aware robutt\"<\/code><\/td>\nBot description, e.g. “Delightfully aware robutt”<\/td>\n<\/tr>\n
--adapter=campfire<\/code><\/td>\nBot adapter, e.g. “campfire”<\/td>\n<\/tr>\n
--defaults<\/code><\/td>\nDeclare all defaults are set and no prompting required<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
You now have your own functional hubot! There’s a bin\/hubot<\/code>
\ncommand for convenience, to handle installing npm dependencies, loading scripts,
\nand then launching your hubot.<\/p>\n
Hubot needs Redis to persist data, so before you can start hubot on your own computer, you should have Redis installed on your localhost. If just want to test Hubot without Redis, then you can remove redis-brain.coffee<\/code> from hubot-scripts.json<\/code>.<\/p>\n
\n
% bin\/hubot\r\nHubot>\r\n<\/code><\/pre>\n<\/div>\n
This starts hubot using the shell adapter<\/a>, which
\nis mostly useful for development. Make note of Hubot><\/code>; this is the name your hubot will
\nrespond<\/code> to with commands. For example, to list available commands:<\/p>\n
\n
% bin\/hubot\r\nHubot> hubot: help\r\nhubot <keyword> tweet - Returns a link to a tweet about <keyword>\r\nhubot <user> is a badass guitarist - assign a role to a user\r\nhubot <user> is not a badass guitarist - remove a role from a user\r\nhubot animate me <query> - The same thing as `image me`, except adds a few parameters to try to return an animated GIF instead.\r\nhubot convert me <expression> to <units> - Convert expression to given units.\r\nhubot die - End hubot process\r\nhubot echo <text> - Reply back with <text>\r\nhubot fake event <event> - Triggers the <event> event for debugging reasons\r\nhubot help - Displays all of the help commands that Hubot knows about.\r\nhubot help <query> - Displays all help commands that match <query>.\r\nhubot image me <query> - The Original. Queries Google Images for <query> and returns a random top result.\r\nhubot map me <query> - Returns a map view of the area returned by `query`.\r\nhubot mustache me <query> - Searches Google Images for the specified query and mustaches it.\r\nhubot mustache me <url> - Adds a mustache to the specified URL.\r\nhubot ping - Reply with pong\r\nhubot show storage - Display the contents that are persisted in the brain\r\nhubot show users - Display all users that hubot knows about\r\nhubot the rules - Make sure hubot still knows the rules.\r\nhubot time - Reply with current time\r\nhubot translate me <phrase> - Searches for a translation for the <phrase> and then prints that bad boy out.\r\nhubot translate me from <source> into <target> <phrase> - Translates <phrase> from <source> into <target>. Both <source> and <target> are optional\r\nhubot who is <user> - see what roles a user has\r\nhubot youtube me <query> - Searches YouTube for the query and returns the video embed link.\r\nhubot pug bomb N - get N pugs\r\nhubot pug me - Receive a pug\r\nhubot ship it - Display a motivation squirrel\r\n<\/code><\/pre>\n<\/div>\n
You almost definitely will want to change your hubot’s name to add character. bin\/hubot takes a --name<\/code>:<\/p>\n
\n
% bin\/hubot --name myhubot\r\nmyhubot>\r\n<\/code><\/pre>\n<\/div>\n
Your hubot will now respond as myhubot<\/code>. This is
\ncase-insensitive, and can be prefixed with @<\/code> or suffixed with :<\/code>. These are equivalent:<\/p>\n
\n
MYHUBOT help\r\nmyhubot help\r\n@myhubot help\r\nmyhubot: help\r\n<\/code><\/pre>\n<\/div>\n
Scripting<\/h2>\n
Hubot’s power comes through scripting. Read more about scripting<\/a> for the deal on bending hubot to your will using code.<\/p>\n
There are many community-contributed scripts available through hubot-scripts<\/a>. To use scripts from it:<\/p>\n