Module Hirb
In: lib/hirb.rb
lib/hirb/util.rb
lib/hirb/version.rb
lib/hirb/menu.rb
lib/hirb/import_object.rb
lib/hirb/pager.rb
lib/hirb/dynamic_view.rb
lib/hirb/views.rb
lib/hirb/string.rb
lib/hirb/console.rb
lib/hirb/formatter.rb
lib/hirb/helpers/table.rb
lib/hirb/helpers.rb
lib/hirb/view.rb

Most of Hirb‘s functionality is in Hirb::View. For a tutorial on configuring and creating views see Hirb::View. For a tutorial on dynamic views see Hirb::DynamicView.

Config Files

Hirb can have multiple config files defined by config_files(). These config files have the following top level keys:

*:output*
This hash is used by the formatter object. See Hirb::Formatter.config for its format.
*:width*
Width of the terminal/console. Defaults to Hirb::View::DEFAULT_WIDTH or possibly autodetected when Hirb is enabled.
*:height*
Height of the terminal/console. Defaults to Hirb::View::DEFAULT_HEIGHT or possibly autodetected when Hirb is enabled.
*:formatter*
Boolean which determines if the formatter is enabled. Defaults to true.
*:pager*
Boolean which determines if the pager is enabled. Defaults to true.
*:pager_command*
Command to be used for paging. Command can have options after it i.e. ‘less -r’. Defaults to common pagers i.e. less and more if detected.
*:ignore_errors*
Boolean which ignores internal view errors and continues with original view (i.e. inspect for irb). Defaults to false.

Methods

Classes and Modules

Module Hirb::Console
Module Hirb::DynamicView
Module Hirb::ObjectMethods
Module Hirb::String
Module Hirb::Util
Module Hirb::View
Module Hirb::Views
Class Hirb::Formatter
Class Hirb::Menu
Class Hirb::Pager

Constants

VERSION = '0.6.2'

Attributes

config  [RW] 
config_files  [RW] 

Public Class methods

Array of config files which are merged sequentially to produce config. Defaults to config/hirb.yml and ~/.hirb_yml

Disables view functionality. See Hirb::View.disable for details.

Enables view functionality. See Hirb::View.enable for details.

[Validate]