Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.34 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.34 KB

Hubot Team npm version

Create and manage the members of a team using Hubot.

Installation

Add hubot-team to your package.json file:

"dependencies": {
  ...
  "hubot-team": "latest"
}

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

["hubot-team"]

Run npm install hubot-team

Configuration

Some commands require an admin role to be run (i.e. clear team list). The admins can be specified through the HUBOT_TEAM_ADMIN environment variable, as a comma separated list of usernames.

Commands

hubot create <team_name> team               # create team called <team_name>
hubot (delete|remove) <team_name> team      # delete team called <team_name>
hubot list teams                            # list all existing teams
hubot (<team_name>) team +1                 # add me to the team
hubot (<team_name>) team -1                 # remove me from the team
hubot (<team_name>) team add (me|<user>)    # add me or <user> to team
hubot (<team_name>) team remove (me|<user>) # remove me or <user> from team
hubot (<team_name>) team (list|show)        # list the people in the team
hubot (<team_name>) team (empty|clear)      # clear team list
hubot (<team_name>) team count              # list the current size of the team

All commands that have the <team_name> in parantheses can ommit it. For example:

hubot team +1

would work just fine, adding the current user to the default team. Note: when adding and removing users without the <team_name> label, those users are included in a team that does not show up when running hubot list teams.

Contributing

If you are interested to make hubot-team better, fork this repository, check the list of open issues (old issues list can be found here) for some suggestions to get started, and submit a pull request.

Feel free to add yourself to the CONTRIBUTORS list while submitting a pull request.

License

© 2014 Mihai Cîrlănaru

See LICENSE for more details.