hubot-manpages

A Hubot script for searching, and viewing examples in a collection of simplified, and community-driven man pages (powered by http://tldr-pages.github.io/).

Usage no npm install needed!

<script type="module">
  import hubotManpages from 'https://cdn.skypack.dev/hubot-manpages';
</script>

README

hubot-manpages

Build Status devDependency Status

A Hubot script for searching, and viewing examples in a collection of simplified, and community-driven man pages (powered by http://tldr-pages.github.io/).

See src/manpages.coffee for full documentation.

Installation via NPM

  1. Install the hubot-manpages module as a Hubot dependency by running:

    npm install --save hubot-manpages

  2. Enable the module by adding the hubot-manpages entry to your external-scripts.json file:

    [
    "hubot-manpages"
]

  3. Run your bot and see below for available config / commands

Commands

Command Listener ID Description
hubot mp search command manpages.search Returns tldr man page / examples for command
hubot mp random manpages.random Returns a random tldr man page / examples for a command

Sample Interaction

user1>> hubot mp search alias
hubot>>

    # alias

    > Creates an alias for a word when used.
    > As the first word of a command.

    - Create a generic alias:

    `alias {{word}}="{{command}}"`

    - Remove an aliased command:

    `unalias {{word}}`

    - Full list of aliased words:

    `alias -p`

    - Turn rm an interative command:

    `alias {{rm}}="{{rm -i}}"`

    - Override la as ls -a:

    `alias {{la}}="{{ls -a}}"`
hubot>> user1: Original `alias` (common) tldr man page: https://github.com/tldr-pages/tldr/blob/master/pages/common/alias.md