☰

HelpMe

A command line tool for helping you out

Usage

Install

If you haven’t installed it yet, do that first.

Usage

See general help

$ helpme --help
usage: helpme [-h] [--debug] [--version] [--quiet]
              {list,config,github,uservoice} ...

HelpMe Command Line Tool

optional arguments:
  -h, --help            show this help message and exit
  --debug               use verbose logging to debug.
  --version             show version and exit.
  --quiet               suppress additional output.

actions:
  actions for HelpMe Command Line Tool

  {list,config,github,uservoice}
                        helpme actions
    list                show installed helpers
    config              configure a helper

List

List the helpers installed

$ helpme list
Helpers Installed:
github
uservoice

Interactive help from a specific helper (e.g., Github helper):

$ helpme github

Config

If you want to generate a configuration file in your $HOME without calling a helper:

$ helpme config

If you already have a file, it will not be written over.

Read more about the Github Helper.

Related pages