Skip to content

Instantly share code, notes, and snippets.

@shalecraig
Created October 20, 2014 22:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save shalecraig/af9965a192e21a7a2c74 to your computer and use it in GitHub Desktop.
Save shalecraig/af9965a192e21a7a2c74 to your computer and use it in GitHub Desktop.
Help page shown in pry :D
Help
help Show a list of commands or information about a specific command
Context
cd Move into a new context (object or scope).
find-method Recursively search for a method within a Class/Module or the current namespace.
ls Show the list of vars and methods in the current scope.
pry-backtrace Show the backtrace for the Pry session.
raise-up Raise an exception out of the current pry instance.
reset Reset the REPL to a clean state.
whereami Show code surrounding the current context.
wtf? Show the backtrace of the most recent exception.
Editing
! Clear the input buffer.
amend-line Amend a line of input in multi-line mode.
edit Invoke the default editor on a file.
hist Show and replay Readline history.
play Playback a string variable or a method or a file as input.
show-input Show the contents of the input buffer for the current multi-line expression.
Introspection
ri View ri documentation.
show-doc Show the documentation for a method or class.
show-source Show the source for a method or class.
stat View method information and set _file_ and _dir_ locals.
Gems
gem-cd Change working directory to specified gem's directory.
gem-install Install a gem and refresh the gem cache.
gem-list List and search installed gems.
gem-open Opens the working directory of the gem in your editor
Commands
import-set Import a Pry command set.
install-command Install a disabled command.
Aliases
!!! Alias for `exit-program`
!!@ Alias for `exit-all`
$ Alias for `show-source`
? Alias for `show-doc`
breakpoint Alias for `break`
breaks Alias for `breakpoints`
c Alias for `continue`
clipit Alias for `gist --clip`
f Alias for `finish`
file-mode Alias for `shell-mode`
history Alias for `hist`
jist Alias for `gist`
n Alias for `next`
quit Alias for `exit`
quit-program Alias for `exit-program`
reload-method Alias for `reload-code`
s Alias for `step`
show-method Alias for `show-source`
Input and Output
.<shell command> All text following a '.' is forwarded to the shell.
cat Show code from a file, Pry's input buffer, or the last exception.
fix-indent Correct the indentation for contents of the input buffer
save-file Export to a file using content from the REPL.
shell-mode Toggle shell mode. Bring in pwd prompt and file completion.
Misc
gist Playback a string variable or a method or a file as input.
pry-version Show Pry version.
reload-code Reload the source file that contains the specified code object.
simple-prompt Toggle the simple prompt.
toggle-color Toggle syntax highlighting.
Navigating Pry
!pry Start a Pry session on current self.
disable-pry Stops all future calls to pry and exits the current session.
exit Pop the previous binding.
exit-all End the current Pry session.
exit-program End the current program.
jump-to Jump to a binding further up the stack.
nesting Show nesting information.
switch-to Start a new subsession on a binding in the current stack.
pry-byebug (v1.3.2)
break Set or edit a breakpoint.
breakpoints List defined breakpoints.
continue Continue program execution and end the Pry session.
finish Execute until current stack frame returns.
next Execute the next line within the current stack frame.
step Step execution into the next line or method.
pry-rescue (v1.4.0)
cd-cause Move to the exception that caused this exception to happen
try-again Re-try the code that caused this exception
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment