# hubot-help

> A hubot script to show available hubot commands

Latest version **2.1.5** (published 2024-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install hubot-help
pnpm add hubot-help
yarn add hubot-help
bun add hubot-help
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.5 |
| Published | 2024-04-09 |
| First published | 2014-08-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 18 |
| Dependencies | 0 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 38 |
| Author | Josh Nichols |
| Maintainers | therealklanni, technicalpickles, alindeman, michaelansel, hubotbot |
| Keywords | hubot, hubot-scripts |

## Links

- npm: https://www.npmjs.com/package/hubot-help
- Repository: https://github.com/hubotio/hubot-help
- Homepage: https://github.com/hubotio/hubot-help#readme
- Issues: https://github.com/hubotio/hubot-help/issues
- npm.io page: https://npm.io/package/hubot-help

## Recent versions

- 2.1.5 (latest) — 2024-04-09
- 2.0.0 (next) — 2023-06-09
- 2.1.4 — 2023-11-12
- 2.1.3 — 2023-11-12
- 2.1.2 — 2023-09-13
- 2.1.1 — 2023-07-13
- 2.1.0 — 2023-06-09
- 2.0.2 — 2023-06-09
- 2.0.1 — 2023-06-09
- 1.1.1 — 2023-06-03
- 1.1.0 — 2023-05-21
- 1.0.1 — 2017-06-29
- 1.0.0 — 2017-06-29
- 0.2.2 — 2017-06-27
- 0.2.0 — 2016-05-05
- … 3 more at https://npm.io/package/hubot-help/versions

## README

Hubot Help Plugin
==================

![Build Status](https://github.com/hubotio/hubot-help/actions/workflows/pipeline.yml/badge.svg)

A hubot script to show available hubot commands

See [`src/help.js`](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`:

```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>.
```

---
_Source: https://npm.io/package/hubot-help · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
