Saltar al contenido principal

Key Bindings

MacOS

ActionKey
Open configurationCommand + Comma (,)
Toggle VI ModeAlt + Shift + Space
CopyCommand + C
PasteCommand + V
Create new windowCommand + N
Create new tabCommand + T
Move to next tabControl + Tab or Command + Shift + RightBracket (])
Move to previous tabControl + Shift + Tab or Command + Shift + LeftBracket ([)
Increase font sizeCommand + Plus (+)
Decrease font sizeCommand + Minus (-)
Reset font sizeCommand + 0
Minimize windowCommand + M
QuitCommand + Q
Close tabCommand + W
Select the first tabCommand + 1
Select the second tabCommand + 2
Select the third tabCommand + 3
Select the fourth tabCommand + 4
Select the fifth tabCommand + 5
Select the sixth tabCommand + 6
Select the seventh tabCommand + 7
Select the eighth tabCommand + 8
Select the last tabCommand + 9

Windows

ActionKey
Open configurationControl + Shift + Comma (,)
Toggle VI ModeAlt + Shift + Space
CopyControl + Shift + C
PasteControl + Shift + V
Create new windowControl + Shift + N
Create new tabControl + Shift + T
Move to next tabControl + Tab or Control + Shift + RightBracket (])
Move to previous tabControl + Shift + Tab Control + Shift + LeftBracket ([)
Increase font sizeControl + Plus (+)
Decrease font sizeControl + Minus (-)
Reset font sizeControl + 0
Close tab or quitControl + Shift + W

Linux and BSD

ActionKey
Open configurationControl + Shift + Comma (,)
Toggle VI ModeAlt + Shift + Space
CopyControl + Shift + C
PasteControl + Shift + V
Create new windowControl + Shift + N
Create new tabControl + Shift + T
Move to next tabControl + Tab or Control + Shift + RightBracket (])
Move to previous tabControl + Shift + Tab or Control + Shift + LeftBracket ([)
Increase font sizeControl + Plus (+)
Decrease font sizeControl + Minus (-)
Reset font sizeControl + 0
Close tab or quitControl + Shift + W

Custom key bindings

Rio allows you to add new keybindings and overwrite any default key bindings.

Keybinds are built using the following trigger fields:

NameDescription
keyThe key pressed
withModifier keys
modeTerminal mode

Whom can be be combined with the following effect fields:

NameDescription
actionPredefined Rio actions
bytesWrite byte sequence
textWrite text sequence
[bindings]
keys = [
{ key = "q", with = "super", action = "Quit" },
# Bytes[27, 91, 53, 126] is equivalent to "\x1b[5~"
{ key = "home", with = "super | shift", bytes = [27, 91, 53, 126] },
# Remove existing keybind
{ key = "v", with = "control | shift", action = "none" },
]

Key

Each value in key binding will specify an identifier of the key pressed:

  • a-z
  • 0-9
  • F1-F24
  • tab esc
  • home space delete insert pageup pagedown end back
  • up down left right
  • @ colon . return [ ] ; \\ + , / = - *
  • numpadenter numpadadd numpadcomma numpaddivide numpadequals numpadsubtract numpadmultiply
  • numpad1 numpad2 numpad3 numpad4 numpad5 numpad6 numpad7 numpad8 numpad9 numpad0

Action

Execute a predefined action in Rio terminal.

Basic Actions

ActionDescription
None
ReceiveChar
ToggleVIMode
PastePaste command
Copy
OpenConfigEditor
ResetFontSize
IncreaseFontSize
DecreaseFontSize
Run(string)Example: Running command Run(code) or Run(code ~/.config/rio/config.toml)
PasteSelection
ClearSelection

Window Actions

ActionDescription
CreateWindow
Quit

Pane Actions

ActionDescription
SplitHorizontally
SplitVertically
ClosePane

Tab Actions

ActionDescription
CreateTab
CloseTab
SelectPrevTab
SelectNextTab
SelectLastTab
SelectTab(tab_index)Example: Select first tab SelectTab(0), second tab SelectTab(1)

Scroll Actions

ActionDescription
Scroll(int)Example: Scroll up 8 lines Scroll(8) or scroll down 5 lines Scroll(-5)
ScrollPageUp
ScrollPageDown
ScrollHalfPageUp
ScrollHalfPageDown
ScrollToTop
ScrollToBottom

Bytes

Send a byte sequence to the running application.

The bytes field writes the specified string to the terminal. This makes it possible to pass escape sequences, like PageUp ("\x1b[5~"). Note that applications use terminfo to map escape sequences back to keys. It is therefore required to update the terminfo when changing an escape sequence.

With

Key modifiers to filter binding actions

  • none
  • control
  • option
  • super
  • shift
  • alt

Multiple modifiers can be combined using | like this:

with = "control | shift"

Mode

There is currently four different modes:

  • vi
  • alt (Alt screen)
  • appcursor
  • appkeypad

~ can be prefixed to disable the keybind while in that mode.

[bindings]
keys = [
# Enable VI mode on escape, when not in VI mode.
{ key = "esc", mode = "~vi", action = "ToggleVIMode" },
]

Text

text can be used to write specific text on key press:

[bindings]
keys = [
# Write `Rio is awesome!` on `Control + r`
{ key = "r", with = "control", text = "Rio is awesome!" },
]

Overwriting

Bindings are always filled by default, but will be replaced when a new binding with the same triggers is defined. To unset a default binding, it can be mapped to the ReceiveChar action. Alternatively, you can use None for a no-op if you do not wish to receive input characters for that binding.

The example below will disable window creation binding in the macos:

[bindings]
keys = [
{ key = "n", with = "super", action = "ReceiveChar" }
]

ReceiveChar will treat the binding as non existent and simply receive the input and put the character into the terminal.

Optionally you can ignore/disable completely a binding using None. In the example below, whenever you use key "n" along with "super" key nothing will happen.

[bindings]
keys = [
{ key = "n", with = "super", action = "None" }
]

If you are missing a key binding that you believe that should be a default in the platform that you are using, feel free to open an issue.