https://github.com/hellosign/hubot-advanced-help
A hubot help replacement that supports #hashtags
https://github.com/hellosign/hubot-advanced-help
Last synced: 5 days ago
JSON representation
A hubot help replacement that supports #hashtags
- Host: GitHub
- URL: https://github.com/hellosign/hubot-advanced-help
- Owner: hellosign
- Created: 2015-08-11T19:53:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T17:09:44.000Z (over 1 year ago)
- Last Synced: 2025-10-31T13:07:03.542Z (3 months ago)
- Language: CoffeeScript
- Size: 16.6 KB
- Stars: 1
- Watchers: 55
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hubot-advanced-help
A hubot help replacement that supports #hashtags
See [`src/advanced-help.coffee`](src/advanced-help.coffee) for full documentation.
## Installation
In hubot project repo, run:
`npm install hubot-advanced-help --save`
Then add **hubot-advanced-help** to your `external-scripts.json`:
```json
[
"hubot-advanced-help"
]
```
## Configuration
No further configuration besides `external-scripts.json` is required in order to get hubot-advanced-help to work.
However, you can optionally disable this script with the environment variable `HUBOT_ADVANCED_HELP_DISABLE`:
```shell
HUBOT_ADVANCED_HELP_DISABLE="true" bin/hubot
```
This is helpful if you want to dynamically control usage of hubot-advanced-help.
Remember that you still need to use `external-scripts.json` regardless of whether the env variable is used.
## Sample Interaction
```
user1>> hubot tags
hubot>> #foo, #bar, #baz, #some-tag
user1>> hubot help #some-tag
hubot>> this is a command tagged with #some-tag
user1>> hubot e.g. #some-tag
hubot>> this is an example tagged with #some-tag
```