irb 1.14.3 → 1.15.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f1a9b1cbe12db08853604fff0b28f7b66ae1e724d54580ce507e15feb9e0f63
-  data.tar.gz: ce18f088328360ab8d39c4c3902984f0110e704b5a6d953e171d8d35c7b545a8
+  metadata.gz: 7c3e1957674939d29308f3f534aa65b0a85557c1b7cd47ca6709fef260486eba
+  data.tar.gz: f60b6b8752639425dc0e8aec1443fdc88b82c9799e6c71edf4dd88945efbbd23
 SHA512:
-  metadata.gz: a3a46b3c4b9b03dd97175f71cb1a41b02482b996f63b98fa1128c91e741dd17eff1c5af6d314c6756050f4b0e92c398aed1a3ad7adac035d1df0c266e8bd8de0
-  data.tar.gz: 57a389d3e32a394e256beb720d9e124f0f48d9bddb26cc8f4913eba2bb7cdd258f30cda97c87cc3bd028f0501d6247a9cbc97eff7279652805d65cdadef67d4c
+  metadata.gz: fc15c91bd69233b5cbe962cec327c918805db5553c81c4ba450836d626ab56a3745fd04ca4e185470434bd1e69fe94bab9536bf3bf4704538bbf39681b2291ac
+  data.tar.gz: 4b655b0a770eb2524757b8033e5796892dd43944ee7157dd7523f31d4fe6ffe6fed49ca281faa4990ba2c0dd014e662b1fc54445ee80ea5aa135cf097102d005

data/.rdoc_options

@@ -0,0 +1,5 @@
+page_dir: doc
+warn_missing_rdoc_ref: true
+
+autolink_excluded_words:
+- IRB

data/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to IRB
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ruby/irb](https://github.com/ruby/irb).
+
+## Set up the environment
+
+1. Fork the project to your GitHub account.
+2. Clone the fork with `git clone git@github.com:[your_username]/irb.git`.
+3. Run `bundle install`.
+4. Run `bundle exec rake` to make sure tests pass locally.
+
+## Run integration tests
+
+If your changes affect component rendering, such as the autocompletion's dialog/dropdown, you may need to run IRB's integration tests, known as `yamatanooroti`.
+
+Before running these tests, ensure that you have `libvterm` installed. If you're using Homebrew, you can install it by running:
+
+```bash
+brew install libvterm
+```
+
+After installing `libvterm`, you can run the integration tests using the following commands:
+
+```bash
+WITH_VTERM=1 bundle install
+WITH_VTERM=1 bundle exec rake test test_yamatanooroti
+```
+
+## Update documentation
+
+IRB's documentation is generated by [RDoc](https://ruby.github.io/rdoc/) and published to [ruby.github.io/irb](https://ruby.github.io/irb/). Most of the documentation source lives under the `doc/` directory.
+
+Run the following command to generate the documentation site locally.
+
+```bash
+bundle exec rake rdoc
+bundle exec rake rerdoc # to force regeneration
+```
+
+Follow the output message to open the documentation site in your browser.
+
+> [!Note]
+>
+> Please ensure that the changes are rendered correctly on the documentation site.
+> RDoc's Markdown support is limited, so the rendered result on GitHub might differ from what’s rendered on [https://ruby.github.io/irb](https://ruby.github.io/irb).
+
+We welcome any improvements to the documentation, including:
+
+- Fixing typos and grammatical errors.
+- Adding missing documentation for features.
+- Adding missing documentation for configuration options.
+- Adding demo images/gifs for features.

data/EXTEND_IRB.md

@@ -0,0 +1,3 @@
+# Extend IRB
+
+This page has been moved to the [IRB Extension Guide](https://ruby.github.io/irb/EXTEND_IRB_md.html).

data/Gemfile

@@ -22,6 +22,10 @@ gem "rubocop"
 gem "tracer" if !is_truffleruby
 gem "debug", github: "ruby/debug", platforms: [:mri, :mswin]
 
+gem "rdoc", ">= 6.11.0"
+
 if RUBY_VERSION >= "3.0.0" && !is_truffleruby
+  # TODO: Remove this after rbs is released with tsort in its dependencies
+  gem "rbs", github: "ruby/rbs" if RUBY_VERSION >= "3.2"
   gem "repl_type_completor"
 end

data/README.md

@@ -1,33 +1,14 @@
 # IRB
 
 [![Gem Version](https://badge.fury.io/rb/irb.svg)](https://badge.fury.io/rb/irb)
+[![Static Badge](https://img.shields.io/badge/RDoc-flat?style=flat&label=documentation&link=https%3A%2F%2Fruby.github.io%2Firb%2F)](https://ruby.github.io/irb/)
 [![build](https://github.com/ruby/irb/actions/workflows/test.yml/badge.svg)](https://github.com/ruby/irb/actions/workflows/test.yml)
 
+
 IRB stands for "interactive Ruby" and is a tool to interactively execute Ruby expressions read from the standard input.
 
 The `irb` command from your shell will start the interpreter.
 
-- [Installation](#installation)
-- [Usage](#usage)
-  - [The `irb` Executable](#the-irb-executable)
-  - [The `binding.irb` Breakpoint](#the-bindingirb-breakpoint)
-- [Commands](#commands)
-- [Debugging with IRB](#debugging-with-irb)
-  - [More about `debug.gem`](#more-about-debuggem)
-  - [Advantages Over `debug.gem`'s Console](#advantages-over-debuggems-console)
-- [Type Based Completion](#type-based-completion)
-  - [How to Enable IRB::TypeCompletor](#how-to-enable-irbtypecompletor)
-  - [Advantage over Default IRB::RegexpCompletor](#advantage-over-default-irbregexpcompletor)
-  - [Difference between Steep's Completion](#difference-between-steeps-completion)
-- [Configuration](#configuration)
-  - [Environment Variables](#environment-variables)
-- [Documentation](#documentation)
-- [Extending IRB](#extending-irb)
-- [Development](#development)
-- [Contributing](#contributing)
-- [Releasing](#releasing)
-- [License](#license)
-
 ## Installation
 
 > [!Note]
@@ -58,7 +39,7 @@ $ gem install irb
 
 > [!Note]
 >
-> We're working hard to match Pry's variety of powerful features in IRB, and you can track our progress or find contribution ideas in [this document](https://github.com/ruby/irb/blob/master/COMPARED_WITH_PRY.md).
+> We're working hard to match Pry's variety of powerful features in IRB, and you can track our progress or find contribution ideas in [this document](https://ruby.github.io/irb/COMPARED_WITH_PRY_md.html).
 
 ### The `irb` Executable
 
@@ -105,310 +86,32 @@ irb(main):002:0> exit
 Hello World
 ```
 
-## Commands
-
-The following commands are available on IRB. You can get the same output from the `help` command.
-
-```txt
-Help
-  help           List all available commands. Use `help <command>` to get information about a specific command.
-
-IRB
-  context        Displays current configuration.
-  exit           Exit the current irb session.
-  exit!          Exit the current process.
-  irb_load       Load a Ruby file.
-  irb_require    Require a Ruby file.
-  source         Loads a given file in the current session.
-  irb_info       Show information about IRB.
-  history        Shows the input history. `-g [query]` or `-G [query]` allows you to filter the output.
-  disable_irb    Disable binding.irb.
-
-Workspace
-  cwws           Show the current workspace.
-  chws           Change the current workspace to an object.
-  workspaces     Show workspaces.
-  pushws         Push an object to the workspace stack.
-  popws          Pop a workspace from the workspace stack.
-  cd             Move into the given object or leave the current context.
-
-Multi-irb (DEPRECATED)
-  irb            Start a child IRB.
-  jobs           List of current sessions.
-  fg             Switches to the session of the given number.
-  kill           Kills the session with the given number.
-
-Debugging
-  debug          Start the debugger of debug.gem.
-  break          Start the debugger of debug.gem and run its `break` command.
-  catch          Start the debugger of debug.gem and run its `catch` command.
-  next           Start the debugger of debug.gem and run its `next` command.
-  delete         Start the debugger of debug.gem and run its `delete` command.
-  step           Start the debugger of debug.gem and run its `step` command.
-  continue       Start the debugger of debug.gem and run its `continue` command.
-  finish         Start the debugger of debug.gem and run its `finish` command.
-  backtrace      Start the debugger of debug.gem and run its `backtrace` command.
-  info           Start the debugger of debug.gem and run its `info` command.
-
-Misc
-  edit           Open a file or source location.
-  measure        `measure` enables the mode to measure processing time. `measure :off` disables it.
-
-Context
-  show_doc       Look up documentation with RI.
-  ls             Show methods, constants, and variables.
-  show_source    Show the source code of a given method, class/module, or constant.
-  whereami       Show the source code around binding.irb again.
-
-Helper methods
-  conf           Returns the current IRB context.
-
-Aliases
-  $              Alias for `show_source`
-  @              Alias for `whereami`
-```
-
-## Debugging with IRB
-
-### Getting Started
-
-- In `binding.irb`, use the `debug` command to start a `irb:rdbg` session with access to all `debug.gem` commands.
-- Use `RUBY_DEBUG_IRB_CONSOLE=1` environment variable to make `debug.gem` use IRB as the debugging console.
-
-### Details
-
-Starting from version 1.8.0, IRB boasts a powerful integration with `debug.gem`, providing a debugging experience akin to `pry-byebug`.
-
-After hitting a `binding.irb` breakpoint, you can activate the debugger with the `debug` command. Alternatively, if the `debug` method happens to already be defined in the current scope, you can call `irb_debug`.
-
-```shell
-From: test.rb @ line 3 :
-
-    1:
-    2: def greet(word)
- => 3:   binding.irb
-    4:   puts "Hello #{word}"
-    5: end
-    6:
-    7: greet("World")
-
-irb(main):001> debug
-irb:rdbg(main):002>
-```
-
-Once activated, the prompt's header changes from `irb` to `irb:rdbg`, enabling you to use any of `debug.gem`'s [commands](https://github.com/ruby/debug#debug-command-on-the-debug-console):
-
-```shell
-irb:rdbg(main):002> info # use info command to see available variables
-%self = main
-_ = nil
-word = "World"
-irb:rdbg(main):003> next # use next command to move to the next line
-[1, 7] in test.rb
-     1|
-     2| def greet(word)
-     3|   binding.irb
-=>   4|   puts "Hello #{word}"
-     5| end
-     6|
-     7| greet("World")
-=>#0    Object#greet(word="World") at test.rb:4
-  #1    <main> at test.rb:7
-irb:rdbg(main):004>
-```
-
-Simultaneously, you maintain access to IRB's commands, such as `show_source`:
-
-```shell
-irb:rdbg(main):004> show_source greet
-
-From: test.rb:2
-
-def greet(word)
-  binding.irb
-  puts "Hello #{word}"
-end
-```
-
-### More about `debug.gem`
+### Debugging
 
-`debug.gem` offers many advanced debugging features that simple REPLs can't provide, including:
+You can use IRB as a debugging console with `debug.gem` with these options:
 
-- Step-debugging
-- Frame navigation
-- Setting breakpoints with commands
-- Thread control
-- ...and many more
+- In `binding.irb`, use the `debug` command to start an `irb:rdbg` session with access to all `debug.gem` commands.
+- Use the `RUBY_DEBUG_IRB_CONSOLE=1` environment variable to make `debug.gem` use IRB as the debugging console.
 
-To learn about these features, please refer to `debug.gem`'s [commands list](https://github.com/ruby/debug#debug-command-on-the-debug-console).
-
-In the `irb:rdbg` session, the `help` command will also display all commands from `debug.gem`.
-
-### Advantages Over `debug.gem`'s Console
-
-This integration offers several benefits over `debug.gem`'s native console:
-
-1. Access to handy IRB commands like `show_source` or `show_doc`.
-2. Support for multi-line input.
-3. Symbol shortcuts such as `@` (`whereami`) and `$` (`show_source`).
-4. Autocompletion.
-5. Customizable prompt.
-
-However, there are also some limitations to be aware of:
-
-1. `binding.irb` doesn't support `pre` and `do` arguments like [`binding.break`](https://github.com/ruby/debug#bindingbreak-method).
-2. As IRB [doesn't currently support remote-connection](https://github.com/ruby/irb/issues/672), it can't be used with `debug.gem`'s remote debugging feature.
-3. Access to the previous return value via the underscore `_` is not supported.
-
-## Type Based Completion
-
-IRB's default completion `IRB::RegexpCompletor` uses Regexp. IRB has another experimental completion `IRB::TypeCompletor` that uses type analysis.
-
-### How to Enable IRB::TypeCompletor
-
-Install [ruby/repl_type_completor](https://github.com/ruby/repl_type_completor/) with:
-```
-$ gem install repl_type_completor
-```
-Or add these lines to your project's Gemfile.
-```ruby
-gem 'irb'
-gem 'repl_type_completor', group: [:development, :test]
-```
-
-Now you can use type based completion by:
-
-Running IRB with the `--type-completor` option
-```
-$ irb --type-completor
-```
-
-Or writing this line to IRB's rc-file (e.g. `~/.irbrc`)
-```ruby
-IRB.conf[:COMPLETOR] = :type # default is :regexp
-```
+To learn more about debugging with IRB, see [Debugging with IRB](https://ruby.github.io/irb/#label-Debugging+with+IRB).
 
-Or setting the environment variable `IRB_COMPLETOR`
-```ruby
-ENV['IRB_COMPLETOR'] = 'type'
-IRB.start
-```
-
-To check if it's enabled, type `irb_info` into IRB and see the `Completion` section.
-```
-irb(main):001> irb_info
-...
-# Enabled
-Completion: Autocomplete, ReplTypeCompletor: 0.1.0, Prism: 0.18.0, RBS: 3.3.0
-# Not enabled
-Completion: Autocomplete, RegexpCompletor
-...
-```
-If you have `sig/` directory or `rbs_collection.lock.yaml` in current directory, IRB will load it.
-
-### Advantage over Default IRB::RegexpCompletor
-
-IRB::TypeCompletor can autocomplete chained methods, block parameters and more if type information is available.
-These are some examples IRB::RegexpCompletor cannot complete.
-
-```ruby
-irb(main):001> 'Ruby'.upcase.chars.s # Array methods (sample, select, shift, size)
-```
-
-```ruby
-irb(main):001> 10.times.map(&:to_s).each do |s|
-irb(main):002>   s.up # String methods (upcase, upcase!, upto)
-```
-
-```ruby
-irb(main):001> class User < ApplicationRecord
-irb(main):002>   def foo
-irb(main):003>     sa # save, save!
-```
-
-As a trade-off, completion calculation takes more time than IRB::RegexpCompletor.
-
-### Difference between Steep's Completion
-
-Compared with Steep, IRB::TypeCompletor has some difference and limitations.
-```ruby
-[0, 'a'].sample.
-# Steep completes intersection of Integer methods and String methods
-# IRB::TypeCompletor completes both Integer and String methods
-```
-
-Some features like type narrowing is not implemented.
-```ruby
-def f(arg = [0, 'a'].sample)
-  if arg.is_a?(String)
-    arg. # Completes both Integer and String methods
-```
+## Documentation
 
-Unlike other static type checker, IRB::TypeCompletor uses runtime information to provide better completion.
-```ruby
-irb(main):001> a = [1]
-=> [1]
-irb(main):002> a.first. # Completes Integer methods
-```
+https://ruby.github.io/irb/ provides a comprehensive guide to IRB's features and usage.
 
 ## Configuration
 
-### Environment Variables
-
-- `NO_COLOR`: Assigning a value to it disables IRB's colorization.
-- `IRB_USE_AUTOCOMPLETE`: Setting it to `false` disables IRB's autocompletion.
-- `IRB_COMPLETOR`: Configures IRB's auto-completion behavior, allowing settings for either `regexp` or `type`.
-- `VISUAL`: Its value would be used to open files by the `edit` command.
-- `EDITOR`: Its value would be used to open files by the `edit` command if `VISUAL` is unset.
-- `IRBRC`: The file specified would be evaluated as IRB's rc-file.
-- `XDG_CONFIG_HOME`: If it is set and `IRBRC` is unset, the file `$XDG_CONFIG_HOME/irb/irbrc` would be evaluated as IRB's rc-file.
-- `RI_PAGER`: The command specified would be used as a pager.
-- `PAGER`: The command specified would be used as a pager if `RI_PAGER` is unset.
-- `IRB_LANG`, `LC_MESSAGES`, `LC_ALL`, `LANG`: The first of these that is set would be used as the locale value.
-
-## Documentation
-
-https://ruby.github.io/irb/
+See the [Configuration page](https://ruby.github.io/irb/Configurations_md.html) in the documentation.
 
 ## Extending IRB
 
 IRB `v1.13.0` and later versions allows users/libraries to extend its functionality through official APIs.
 
-For more information, please visit [EXTEND_IRB.md](./EXTEND_IRB.md).
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For more information, please visit the [IRB Extension Guide](https://ruby.github.io/irb/EXTEND_IRB_md.html).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/irb.
-
-### Set up the environment
-
-1. Fork the project to your GithHub account
-2. Clone the fork with `git clone git@github.com:[your_username]/irb.git`
-3. Run `bundle install`
-4. Run `bundle exec rake` to make sure tests pass locally
-
-### Run integration tests
-
-If your changes affect component rendering, such as the autocompletion's dialog/dropdown, you may need to run IRB's integration tests, known as `yamatanooroti`.
-
-Before running these tests, ensure that you have `libvterm` installed. If you're using Homebrew, you can install it by running:
-
-```bash
-brew install libvterm
-```
-
-After installing `libvterm`, you can run the integration tests using the following commands:
-
-```bash
-WITH_VTERM=1 bundle install
-WITH_VTERM=1 bundle exec rake test test_yamatanooroti
-```
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
 
 ## Releasing
 

data/doc/COMMAND_LINE_OPTIONS.md

@@ -0,0 +1,69 @@
+# Index of Command-Line Options
+
+These are the IRB command-line options, with links to explanatory text:
+
+- `-d`: Set `$DEBUG` and {$VERBOSE}[rdoc-ref:IRB@Verbosity]
+  to `true`.
+- `-E _ex_[:_in_]`: Set initial external (ex) and internal (in)
+  {encodings}[rdoc-ref:IRB@Encodings] (same as `ruby -E`).
+- `-f`: Don't initialize from {configuration file}[rdoc-ref:IRB@Configuration+File].
+- `-I _dirpath_`: Specify {$LOAD_PATH directory}[rdoc-ref:IRB@Load+Modules]
+  (same as `ruby -I`).
+- `-r _load-module_`: Require {load-module}[rdoc-ref:IRB@Load+Modules]
+  (same as `ruby -r`).
+- `-U`: Set external and internal {encodings}[rdoc-ref:IRB@Encodings] to UTF-8.
+- `-w`: Suppress {warnings}[rdoc-ref:IRB@Warnings] (same as `ruby -w`).
+- `-W[_level_]`: Set {warning level}[rdoc-ref:IRB@Warnings];
+  0=silence, 1=medium, 2=verbose (same as `ruby -W`).
+- `--autocomplete`: Use {auto-completion}[rdoc-ref:IRB@Automatic+Completion].
+- `--back-trace-limit _n_`: Set a {backtrace limit}[rdoc-ref:IRB@Tracer];
+  display at most the top `n` and bottom `n` entries.
+- `--colorize`: Use {color-highlighting}[rdoc-ref:IRB@Color+Highlighting]
+  for input and output.
+- `--context-mode _n_`: Select method to create Binding object
+  for new {workspace}[rdoc-ref:IRB@Commands]; `n` in range `0..4`.
+- `--echo`: Print ({echo}[rdoc-ref:IRB@Return-Value+Printing+-28Echoing-29])
+  return values.
+- `--extra-doc-dir _dirpath_`:
+  Add a {documentation directory}[rdoc-ref:IRB@RI+Documentation+Directories]
+  for the documentation dialog.
+- `--inf-ruby-mode`: Set prompt mode to {:INF_RUBY}[rdoc-ref:IRB@Pre-Defined+Prompts]
+  (appropriate for `inf-ruby-mode` on Emacs);
+  suppresses --multiline and --singleline.
+- `--inspect`: Use method `inspect` for printing ({echoing}[rdoc-ref:IRB@Return-Value+Printing+-28Echoing-29])
+  return values.
+- `--multiline`: Use the multiline editor as the {input method}[rdoc-ref:IRB@Input+Method].
+- `--noautocomplete`: Don't use {auto-completion}[rdoc-ref:IRB@Automatic+Completion].
+- `--nocolorize`: Don't use {color-highlighting}[rdoc-ref:IRB@Color+Highlighting]
+  for input and output.
+- `--noecho`: Don't print ({echo}[rdoc-ref:IRB@Return-Value+Printing+-28Echoing-29])
+  return values.
+- `--noecho-on-assignment`: Don't print ({echo}[rdoc-ref:IRB@Return-Value+Printing+-28Echoing-29])
+  result on assignment.
+- `--noinspect`: Don't se method `inspect` for printing ({echoing}[rdoc-ref:IRB@Return-Value+Printing+-28Echoing-29])
+  return values.
+- `--nomultiline`: Don't use the multiline editor as the {input method}[rdoc-ref:IRB@Input+Method].
+- `--noprompt`: Don't print {prompts}[rdoc-ref:IRB@Prompt+and+Return+Formats].
+- `--noscript`:  Treat the first command-line argument as a normal
+  {command-line argument}[rdoc-ref:IRB@Initialization+Script],
+  and include it in `ARGV`.
+- `--nosingleline`: Don't use the singleline editor as the {input method}[rdoc-ref:IRB@Input+Method].
+- `--noverbose`: Don't print {verbose}[rdoc-ref:IRB@Verbosity] details.
+- `--prompt _mode_`, `--prompt-mode _mode_`:
+  Set {prompt and return formats}[rdoc-ref:IRB@Prompt+and+Return+Formats];
+  `mode` may be a {pre-defined prompt}[rdoc-ref:IRB@Pre-Defined+Prompts]
+  or the name of a {custom prompt}[rdoc-ref:IRB@Custom+Prompts].
+- `--script`: Treat the first command-line argument as the path to an
+  {initialization script}[rdoc-ref:IRB@Initialization+Script],
+  and omit it from `ARGV`.
+- `--simple-prompt`, `--sample-book-mode`:
+  Set prompt mode to {:SIMPLE}[rdoc-ref:IRB@Pre-Defined+Prompts].
+- `--singleline`: Use the singleline editor as the {input method}[rdoc-ref:IRB@Input+Method].
+- `--tracer`: Use {Tracer}[rdoc-ref:IRB@Tracer] to print a stack trace for each input command.
+- `--truncate-echo-on-assignment`: Print ({echo}[rdoc-ref:IRB@Return-Value+Printing+-28Echoing-29])
+  truncated result on assignment.
+- `--verbose`Print {verbose}[rdoc-ref:IRB@Verbosity] details.
+- `-v`, `--version`: Print the {IRB version}[rdoc-ref:IRB@Version].
+- `-h`, `--help`: Print the {IRB help text}[rdoc-ref:IRB@Help].
+- `--`: Separate options from {arguments}[rdoc-ref:IRB@Command-Line+Arguments]
+  on the command-line.

data/doc/COMPARED_WITH_PRY.md

@@ -0,0 +1,22 @@
+# Comparison with Pry
+
+👋 IRB is on a mission to match feature parity with Pry. This document is here to help us track the similarities and differences between the two.
+
+Feel free to chip in and update this table - we appreciate your help!
+
+| Feature                   | Pry                                                                                                                  | IRB                                                                                                                                                    | Note                                                                                           |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
+| Supported Rubies          | `>= 2.0`                                                                                                             | `>= 2.7`                                                                                                                                               |                                                                                                |
+| Source code browsing      | `show-source`                                                                                                        | `show_source`                                                                                                                                          | IRB's `show_source` can't display C source. See [#664](https://github.com/ruby/irb/issues/664) |
+| Document browsing         | `ri`                                                                                                                 | `show_doc`                                                                                                                                             |                                                                                                |
+| Live help system          | `help` or `command_name --help`                                                                                      | `help`                                                                                                                                                 | IRB doesn't support detailed descriptions for individual commands yet                          |
+| Open methods in editors   | `edit`                                                                                                               | `edit`                                                                                                                                                 |                                                                                                |
+| Syntax highlighting       | Yes                                                                                                                  | Yes                                                                                                                                                    |                                                                                                |
+| Command shell integration | Yes                                                                                                                  | No                                                                                                                                                     | Currently, there's no plan to support such features in IRB                                     |
+| Navigation                | - `cd object` to enter `object` <br/> - `cd ..` to leave the current object <br/> - `nesting` to list nesting levels | - `pushws object` <br/> - `popws` <br/> - `workspaces` <br /> - `cd object`/`cd ..` (since [1.14.0](https://github.com/ruby/irb/releases/tag/v1.14.0)) | We plan to refine IRB's commands in the future                                                 |
+| Runtime invocation        | `binding.pry`                                                                                                        | `binding.irb`                                                                                                                                          |                                                                                                |
+| Command system            | Yes                                                                                                                  | No                                                                                                                                                     | Planned in #513 and #588                                                                       |
+| Input history             | [Comprehensive support](https://github.com/pry/pry/wiki/History)                                                     | Supports retrieving previous input and the `history` command                                                                                           | The history command doesn't support as many flags yet, but contributions are welcome.          |
+| Pager support             | Command output and return value                                                                                      | Command output and return value                                                                                                                        |                                                                                                |
+| Debugger integration      | With `byebug` through [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) gem                               | Supports [`irb:rdbg`](https://github.com/ruby/irb#debugging-with-irb) sessions                                                                         |                                                                                                |
+| Rails console             | Through [`pry-rails`](https://github.com/pry/pry-rails) gem                                                          | Rails' default                                                                                                                                         | Rails console with IRB doesn't have commands like `show-routes` or `show-models`               |