Rh

Fast Ruby documentation lookup

Overview

Rh lets you easily look up Ruby documentation about classes, modules, and methods from the command line:

$ rh Array
$ rh Enumerable#chunk
$ rh Time.gm
$ rh with_index

If you're not sure where a method is defined, you can just enter it. If it's only defined in one class/module, that documentation will be shown. Otherwise, you'll get a choice:

$ rh cycle
Did you mean?
  0. Array#cycle
  1. Enumerable#cycle
Enter a number:

Everything from the core API and the standard library is supported, and documentation is shown on ruby-doc.org in a browser. Rh might eventually show documentation in the shell instead.

Rh shows documentation for the version of Ruby that's running it.

Installation

gem install rh

Usage

Formats

Classes/modules:

$ rh Array

Class methods:

$ rh Time.gm
$ rh Time::gm
$ rh .gm
$ rh ::gm

Instance methods:

$ rh Enumerable#chunk
$ rh '#chunk'

Class methods and instance methods:

$ rh parse

License

Rh is released under the MIT License. Please see the MIT-LICENSE file for details.