Code Monkey home page Code Monkey logo

hubot-help's Introduction

Hubot Help Plugin

Build Status Coverage Status

A hubot script to show available hubot commands

See src/help.js for full documentation.

Installation

In hubot project repo, run:

npm install hubot-help --save

Then add hubot-help to your external-scripts.json:

["hubot-help"]

Configuration

You can set various environment variables to tune up the behavior of thios help plugin:

  • HUBOT_HELP_REPLY_IN_PRIVATE (set to any value) will force calls to hubot help to be answered in private
  • HUBOT_HELP_DISABLE_HTTP (set to any value) will disable the web interface for help
  • HUBOT_HELP_HIDDEN_COMMANDS comma-separated list of commands that will not be displayed in help

Development

For tests:

npm test

Sample Interaction

 user> hubot help
hubot> hubot help - Displays all of the help commands that this bot knows about.
hubot> hubot help <query> - Displays all help commands that match <query>.

hubot-help's People

Contributors

gr2m avatar mose avatar bartfeenstra avatar therealklanni avatar erikzaadi avatar joiggama avatar alindeman avatar 178inaba avatar bkeepers avatar emedvedev avatar technicalpickles avatar jcbantuelle avatar treby avatar ianfixes avatar mlcarey321 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.