Skip to content

Help at the REPLλ︎

rebel readline provides tools to help you discover and use functions from clojure.core and any other libraries you add to the REPL.

:repl/help will show all the commands available for rebel readline

Tab to autocomplete the current characters into a function name. All functions that match the characters will be show, allowing quick discovery of functions available. Typing in the first few characters of a function and press

Clojure REPL rebel readling - autocompletion Clojure REPL rebel readling - autocompletion

Moving the cursor after the name of a function will show the signatures available, so a function can be called with the correct number and form of arguments.

Clojure REPL rebel readline - function signature help Clojure REPL rebel readline - function signature help

Ctrl+C+Ctrl+d on a function name shows the docstring to help understand the functions purpose.

Clojure REPL rebel readline - doc function showing a function docstring Clojure REPL rebel readline - doc function showing a function docstring

clojure.repl/doc function also shows the docstring of a function (clojure.repl/doc doc)

Ctrl+X Ctrl+a on a name shows all the possible matching functions to help you discover what is available. Tab through the list of matches, Enter to select a function

clojure repl rebel - apropos on function showing all variations clojure repl rebel - apropos on function showing all variations

Rebel Commandsλ︎

Type :repl/help or :repl followed by Tab to see a list of available commands.

Keybinding Description
:repl/help Prints the documentation for all available commands.
:repl/key-bindings search or list current key bindings
:repl/quit Quits the REPL
:repl/set-color-theme Change the color theme :dark-screen-theme :light-screen-theme
:repl/set-key-map Change key bindings to given key-map, :emacs :vicmd :viins
:repl/toggle-color Toggle ANSI text coloration on and off
:repl/toggle-completion Toggle the completion functionality on and off
:repl/toggle-eldoc Toggle the auto display of function signatures on and off
:repl/toggle-highlight Toggle readline syntax highlighting on and off
:repl/toggle-indent Toggle the automatic indenting of Clojure code on and off

Key-bindingsλ︎

Keybinding Description
Ctrl+c aborts editing the current line
Ctrl+d at the start of a line => sends an end of stream message
Tab word completion or code indent when cursor in whitespace at the start of line
Ctrl+x Ctrl+d Show documentation for word at point
Ctrl+x Ctrl+s Show source for word at point
Ctrl+x Ctrl+a Show apropos for word at point
Ctrl+x Ctrl+e Inline eval for SEXP before the point

Examine key-bindings with the :repl/key-bindings command.