Configuration

Run on REPL startup

If you decide you like Rebugger, you can add lines such as the following to your ~/.julia/config/startup.jl file:

atreplinit() do repl
    try
        @eval using Revise
        @async Revise.wait_steal_repl_backend()
    catch
        @warn "Could not load Revise."
    end

    try
        @eval using Rebugger
    catch
        @warn "Could not load Rebugger."
    end
end

Customize keybindings

As described in Keyboard shortcuts, it's possible that Rebugger's default keybindings don't work for you. You can work around problems by changing them to keys of your own choosing.

To add your own keybindings, use Rebugger.add_keybindings(action=keybinding, ...). This can be done during a running Rebugger session. Here is an example that maps the "step in" action to the key "F6" and "capture stacktrace" to "F7"

julia> Rebugger.add_keybindings(stepin="\e[17~", stacktrace="\e[18~")

To make your keybindings permanent, change the "Rebugger" section of your startup.jl file to something like:

atreplinit() do repl
    ...

    try
        @eval using Rebugger
        # Activate Rebugger's key bindings
        Rebugger.keybindings[:stepin] = "\e[17~"      # Add the keybinding F6 to step into a function.
        Rebugger.keybindings[:stacktrace] = "\e[18~"  # Add the keybinding F7 to capture a stacktrace.
    catch
        @warn "Could not load Rebugger."
    end
end

Note

Besides the obvious, one reason to insert the keybindings into the startup.jl, has to do with the order in which keybindings are added to the REPL and whether any "stale" bindings that might have side effects are still present. Doing it before atreplinit means that there won't be any stale bindings.

But how to find out the cryptic string that corresponds to the keybinding you want? Use Julia's read() function:

julia> str = read(stdin, String)
^[[17~"\e[17~"  # Press F6, followed by Ctrl+D, Ctrl+D

julia> str
"\e[17~"

After calling read(), press the keybinding that you want. Then, press Ctrl+D twice to terminate the input. The value of str is the cryptic string you are looking for.

If you want to know whether your key binding is already taken, the REPL documentation as well as any documentation on your operating system, desktop environment, and/or terminal program can be useful references.