Skip to content

hubot-js/gear-help

Repository files navigation

gear-help

Build Status npm Coverage Status Code Climate dependencies Status devDependencies Status

A Hubot Gear for enable help and show available commands

This is a gear to add to hubot.js the ability to show help with available commands. If you do not know the hubot.js or do not know what they are gears like this click here for more details.

hubot-help-gif

Usage

When hubot.js starts you can ask for help. The help command will show commands from all active gears.

hubot help

hubot-private-help

Help should be asked directly to the hubot. If you ask help in channel, will receive a warning.

hubot-public-help

Development setup

  • Fork and clone this project
  • In the main directory run npm installto install dependencies.
  • Write your code.
  • To run tests use npm test command

Meta

Robson Bittencourt - @rluizv - [email protected]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/hubot-js/gear-help