Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

"help" plugin similar to Hubot's hubot-help module? #1275

Closed
jefftougas opened this issue Mar 5, 2018 · 2 comments
Closed

"help" plugin similar to Hubot's hubot-help module? #1275

jefftougas opened this issue Mar 5, 2018 · 2 comments

Comments

@jefftougas
Copy link

Is there some plugin or mechanism available within the botkit community for getting botkit to print out available command syntax documentation in response to "help" messages? I've used https://github.com/hubotio/hubot-help with hubot in the past, but my searching for a botkit equivalent didn't yield anything.

I acknowledge that building some equivalent help registry would be pretty easy without an external plugin - I was just wondering if there was a packaged solution for this problem already.

@peterswimm
Copy link
Contributor

I am not aware of a publically available method, but you can do this in Botkit Studio using the controller.studio.getScripts() function:
https://github.com/howdyai/botkit/blob/master/docs/readme-studio.md#controllerstudiogetscripts

The alternative to using studio is similar to what you are getting at, using a middleware handler to return responses based on "help" and a block of text or menu of your available commands "help COMMAND" type syntax.

@jefftougas
Copy link
Author

Cool, thanks. I can work with that.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants