Skip to content

Files

Latest commit

author
Franklin Henderson
Dec 19, 2014
3f54b20 · Dec 19, 2014

History

History
62 lines (35 loc) · 1.4 KB

README.md

File metadata and controls

62 lines (35 loc) · 1.4 KB

Pairbot

Build Status

A simple hubot script to support pair programming.

The initial use case is pretty specific:

As a developer pairing with another developer (my pair), both on an IRC channel, I'd like to get messages that mention me forwarded to my pair, so that I can see them.

But there might be other use cases in the future.

See src/pairbot.coffee for full documentation.

Installation

Add hubot-pairbot to your package.json file:

"dependencies": {
    "hubot-pairbot": ">=0.0.0"
}

Add hubot-pairbot to your external-scripts.json:

["hubot-pairbot"]

Run npm install hubot-pairbot

Commands

Most commands have multiple aliases and abbreviations. See the commands object src/pairbot.coffee for details.

start pairing with <pair>

Registers a pairing. Messages sent to the user will be forwarded to the pair. Note that only one pairing per user is supported.

stop pairing

Removes the pairing registation. Messages will no longer be forwarded.

list pairs

See all the current pairings known to pairbot.

clear pairs

Removes all registrations. Use with caution.

help

Quick list of available commands.

Sample Interaction

coming soon.