Hyungsuk Hong > Hubot-0.1.6 > Hubot

Download:
Hubot-0.1.6.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.1.6   Source   Latest Release: Hubot-0.2.7

NAME ^

Hubot - AnyEvent based https://github.com/github/hubot

SYNOPSIS ^

    $ echo '["help"]' > hubot-scripts.json
    $ hubot
    hubot> hubot help
    hubot> exit

DESCRIPTION ^

CONFIGURATION

describe scripts name to hubot-scripts.json

example)

    [
      "help",
      "tweet",
      "shorten",
      "ascii"
    ]

each scripts has each congiruation rules.

check it out perldoc Hubot::Scripts::<script>.

described order can affect the bot's action. if "shorten" is appear than "tweet", http://twitter.com/<username>/status/<tweetid> processed twice by "shorten" and "tweet". the secret is behind of `tweet` script. actually, Hubot::Message finish method.

if hubot-scripts.json is not exist, built-in scripts

"help", "tweet", "ascii", "roles"

are loaded automatically.

ADAPTERS ^

choose the adapter at runtime.

adapters are sharing all `Hubot::Scripts::*` extends scripts.

    $ hubot -a <adapter>

BUNDLE ADAPTERS

Hubot::Adapter::Shell

gives local shell prompt. good choice for development.

Hubot::Adapter::Irc
Hubot::Adapter::Campfire

BUNDLE SCRIPTS

Hubot::Scripts::help
    hubot: help
Hubot::Scripts::ascii
    ascii hello
Hubot::Scripts::shorten
    http://example.com
Hubot::Scripts::tweet
    http://twitter.com/KBO_Scores/status/256376098764505088
Hubot::Scripts::roles
    hubot: <user> is a <role>
    hubot: who is <user>
    hubot: <user> is not a <role>

SEE ALSO ^

https://github.com/github/hubot
https://github.com/github/hubot-scripts
Hubot::Robot
Hubot::Adapter
Hubot::Brain
Hubot::Listener
Hubot::Message
Hubot::Response
Hubot::User

AUTHOR ^

Hyungsuk Hong <hshong@perl.kr>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Hyungsuk Hong.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: