ri(1) Ruby API reference front end


[-Ti [-d directory ] ] [-f format ] [--list-doc-dirs ] [--no-standard-docs ] [-- [no- Bro system | site | gems | home Brc ] ] [-- [no- use-cache ] ] [--width = width ] [target ... ]


is a CLI front end for the Ruby API reference. You can search and read API reference for classes and methods with .

is a part of Ruby.

target can be one of the following forms:

for classes
for class methods
for instance methods
for both class and instance methods
for both class and instance methods

All class names may be abbreviated to their minimum unambiguous form. If a name is ambiguous, all valid options will be listed.

For example:

ri Fil
ri File
ri File.new
ri zip

Note that shell quoting may be required for method names containing punctuation:

ri 'Array.[]'
ri compact


Prints the version of .

Send output directly to stdout, rather than to a pager.

-d directory
--doc-dir = directory
List of directories from which to source documentation in addition to the standard directories. May be repeated.

--fmt FORMAT
--format = FORMAT
Format to use when displaying output:

ansi, bs, html, plain, simple

Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the pager or tell the pager to allow control characters.

This makes go into interactive mode.

When is in interactive mode it will allow the user to disambiguate lists of methods in case multiple methods match against a method search string. It also will allow the user to enter in a method name (with auto-completion, if readline is supported) when viewing a class.

List the directories from which ri will source documentation on stdout and exit.

Do not include documentation from the Ruby standard library, site_lib installed gems, or ~/.rdoc

Equivalent to specifying the options --no-system , --no-site , --no-gems and --no-home

-- [no- system ]
Include documentation from Ruby's standard library. Defaults to true.

-- [no- site ]

 Include documentation from libraries installed in site_lib. Defaults to true.

-- [no- gems ]
Include documentation from RubyGems. Defaults to true.

-- [no- home ]
Include documentation stored in ~/.rdoc. Defaults to true.

-- [no- use-cache ]
Whether or not to use 's cache. True by default.

-w width
--width = width
Set the width of the output.


Additional options.

Used as the name of pager program for displaying.

Path to user's home directory.


Caches recently referenced documents here.

Searches user-wide documents here.


    Security vulnerabilities should be reported via an email to Aq [email protected] Ns . Reported problems will be published after being fixed.

    And you can report other bugs and feature requests via the Ruby Issue Tracking System (http://bugs.ruby-lang.org). Do not report security vulnerabilities via the system because it publishes the vulnerabilities immediately.


Written by Dave Thomas Aq [email protected]