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

A Hubot gear for enable help and show available commands.
https://github.com/hubot-js/gear-help

chatbot chatops hubot-gear hubot-js

Last synced: 4 days ago
JSON representation

A Hubot gear for enable help and show available commands.

• Host: GitHub
• URL: https://github.com/hubot-js/gear-help
• Owner: hubot-js
• License: mit
• Created: 2016-08-18T01:57:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-17T02:18:00.000Z (over 6 years ago)
• Last Synced: 2024-11-13T01:36:21.059Z (2 months ago)
• Topics: chatbot, chatops, hubot-gear, hubot-js
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/gear-help
• Size: 89.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gear-help

[![Build Status](https://travis-ci.org/hubot-js/gear-help.svg?branch=master)](https://travis-ci.org/hubot-js/gear-help)  [![npm](https://img.shields.io/npm/v/gear-help.svg)](https://www.npmjs.com/package/gear-help)   [![Coverage Status](https://coveralls.io/repos/github/hubot-js/gear-help/badge.svg?branch=master)](https://coveralls.io/github/hubot-js/gear-help?branch=master)   [![Code Climate](https://img.shields.io/codeclimate/github/hubot-js/gear-help.svg)](https://codeclimate.com/github/hubot-js/gear-help)  [![dependencies Status](https://david-dm.org/hubot-js/gear-help/status.svg)](https://david-dm.org/hubot-js/gear-help)  [![devDependencies Status](https://david-dm.org/hubot-js/gear-help/dev-status.svg)](https://david-dm.org/hubot-js/gear-help?type=dev)

> A Hubot Gear for enable help and show available commands 

This is a gear to add to [hubot.js](https://github.com/hubot-js/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](https://github.com/hubot-js/hubot.js/blob/master/README.md) for more details.

![hubot-help-gif](media/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](media/help.png)

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

![hubot-public-help](media/private-help.png)

## Development setup

- Fork and clone this project

- In the main directory run ```npm install```to 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](LICENSE) for more information.

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