# hubot-even-better-help > A friendlier help command Latest version **0.1.1** (published 2017-10-30) · MIT license · 0 weekly downloads ## Install ```sh npm install hubot-even-better-help pnpm add hubot-even-better-help yarn add hubot-even-better-help bun add hubot-even-better-help ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2017-10-30 | | First published | 2017-10-30 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | Gordon Burgett | | Maintainers | aservies | | Keywords | hubot, hubot-scripts | ## Links - npm: https://www.npmjs.com/package/hubot-even-better-help - Repository: https://github.com/AlexandreServies/hubot-even-better-help - Homepage: https://github.com/AlexandreServies/hubot-even-better-help#readme - Issues: https://github.com/AlexandreServies/hubot-even-better-help/issues - npm.io page: https://npm.io/package/hubot-even-better-help ## Dependencies (2) - [stopwords](https://npm.io/package/stopwords.md) ^0.0.5 - [coffee-script](https://npm.io/package/coffee-script.md) ~1.6 ## Recent versions - 0.1.1 (latest) — 2017-10-30 ## README # hubot-even-better-help [![Build Status](https://travis-ci.org/AlexandreServies/hubot-even-better-help.svg?branch=master)](https://travis-ci.org/AlexandreServies/hubot-even-better-help) [![npm version](https://badge.fury.io/js/hubot-even-better-help.svg)](https://badge.fury.io/js/hubot-even-better-help) ### A much more friendly help command. hubot-even-better-help provides a better help experience than the out-of-the-box hubot standard help. Command options are organized by the script in which they are found, which reduces noise when a user is trying to figure out what hubot can do. ``` bob > hubot help hubot> bob: I can do a lot of things! Which would you like to know more about? You can say: * hubot help hangouts - Create hangouts with Hubot. * hubot help meme - Get a meme from http://memecaptain.com/ * hubot help pugme - Pugme is the most important thing in life * hubot help maps - Interacts with the Google Maps API. * hubot help rules - Make sure that hubot knows the rules. * hubot help rss-reader - Hubot RSS Reader * hubot help youtube - YouTube video search * hubot help shipit - Rodent Motivation Or you can see all commands by typing `hubot help all`. ``` The user can dive in deeper by specifying the name of the script or module in which the commands are defined: ``` bob > hubot help meme hubot> bob: Get a meme from http://memecaptain.com/ * hubot (SUCCESS|NAILED IT) - Meme: Success kid w/ top caption * hubot ALL the - Meme: ALL THE THINGS * hubot TOO DAMN - Meme: THE RENT IS TOO DAMN HIGH guy * hubot , EVERYWHERE - Meme: Generates Buzz Lightyear * hubot , AND IT'S GONE - Meme: Bank Teller * hubot , BITCH PLEASE - Meme: Yao Ming * hubot , COURAGE - Meme: Courage Wolf * hubot Aliens guy - Meme: Aliens guy * hubot All your are belong to - Meme: All your are belong to * hubot Brace yourself - Meme: Ned Stark braces for * hubot I don't always but when i do - Meme: The Most Interesting man in the World * hubot IF THAT'D BE GREAT - Meme: Generates Lumberg * hubot IF YOU GONNA HAVE A BAD TIME - Meme: Ski Instructor * hubot IF YOU TROLLFACE - Meme: Troll Face * hubot If , ? - Meme: Philosoraptor * hubot Iron Price - Meme: To get ? Pay the iron price! * hubot MUCH (SO|VERY) - Meme: Generates Doge * hubot Not sure if or - Meme: Futurama Fry * hubot ONE DOES NOT SIMPLY - Meme: Boromir * hubot WHAT IF I TOLD YOU - Meme: Morpheus "What if I told you" * hubot WTF - Meme: Picard WTF * hubot Y U NO - Meme: Y U NO GUY w/ bottom caption * hubot Yo dawg so - Meme: Yo Dawg * hubot khanify - Meme: Has Shatner yell your phrase * hubot pun | bad joke eel / - Meme: Bad joke eel * hubot pun | bad joke eel ? - Meme: Bad joke eel ``` The module also responds to mentions or greetings in order to introduce itself, so that new users can discover hubot and learn what it can do ``` *sally has entered the room bob > Hi sally! Welcome to the chat. If you need help with anything you can always ask hubot. hubot> Hi, I'm hubot. Nice to meet you! You can ask me a question by typing my name, or even direct messaging me! Try it now by typing this: `hubot help` sally> hi hubot hubot> Hiya! Want to ask me a question? Just type `hubot help` ``` hubot-even-better-help accomplishes all this by re-implementing the parsing logic of Hubot. Normally Hubot parses the header files of scripts and then combines all the commands in one array. hubot-even-better-help instead maintains an associative array of module names to commands, and combines them on the fly. This allows to to reduce a lot of noise when you start including a significant number of modules, or those modules like "hubot-memes" which have a lot of commands. ## Installation In hubot project repo, run: `npm install hubot-even-better-help --save` Then add **hubot-even-better-help** to your `external-scripts.json`: ```json ["hubot-even-better-help"] ``` --- _Source: https://npm.io/package/hubot-even-better-help · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._