Key mappings

Key mappings can be modified or extended by defining them in the configuration file.

Each key mapping is associated with a specific pane and becomes active when that pane has focus. The global section applies to all panes and is evaluated first.

[global]
key_bindings = [
  { key = "q", command = "quit" },
  { key = "?", command = "help_modal_toggle" },
]

[explorer]
key_bindings = [
  { key = "k", command = "explorer_up" },
  { key = "j", command = "explorer_down" },
]

Key sequence syntax#

A key can be a single character, a named key, a modified key or a sequence of keystrokes. Sequences are written as a multi-character string and only fire when all keys are pressed in order with nothing in between. This makes it possible to define vim- or Helix-style bindings like gg.

[note_editor]
key_bindings = [
  { key = "gg", command = "note_editor_scroll_to_top" },
  { key = "G",  command = "note_editor_scroll_to_bottom" },
]

An uppercase letter like G is shorthand for shift+g. Shift is implied automatically.

Named keys in sequences#

A multi-character string splits into one keystroke per character, so a named key like space or enter cannot start a sequence directly (<space>f would otherwise read as the keys s p a c e ...). Wrap a named or modified key in <...> to group it into a single keystroke. This enables Helix-style leader bindings:

[global]
key_bindings = [
  { key = "<space>f",       command = "vault_selector_modal_toggle" },
  { key = "<space><space>", command = "help_modal_toggle" },
  { key = "<ctrl+w>q",      command = "quit" },
]

< and > are reserved for this syntax; bind the literal keys with <lt> and <gt>.

Leader key#

<leader> is a placeholder for a prefix key of your choosing, so a whole set of bindings can be moved to a different prefix by changing one line. It defaults to <space> and is set at the top level of the configuration file:

leader = ","

[global]
key_bindings = [
  { key = "<leader>f", command = "explorer_toggle" },
]

The leader applies to the defaults as well as to your own bindings, so the above turns Space v into ,v, Space d into ,d, and binds ,f on top.

The leader may be any key, including a modified one (leader = "ctrl+w") or a sequence (leader = "gs"), and it may appear more than once in a binding (<leader><leader>). It cannot refer to itself: leader = "<leader>" is an error.

Available commands#

Global commands#

Splash commands#

Explorer commands#

Outline commands#

Note editor commands#

note_editor_cursor_up and note_editor_cursor_down move by whole line, so a soft-wrapped line counts once. note_editor_cursor_screen_up and note_editor_cursor_screen_down move by visible row instead, which matches vim gk and gj.

note_editor_follow_link travels to the note a wiki-link names and creates that note when it does not exist. On a plain URL it opens your browser.

Experimental editor commands#

note_editor_experimental_set_edit_mode, note_editor_experimental_set_read_mode and note_editor_experimental_exit_mode are deprecated aliases of the _view and _exit commands above. They still work but will be removed in the next major version.

Vim mode motions#

These commands need vim_mode = true in [note_editor]. They act in Normal mode. The key in brackets is the default binding from the vim preset.

Vim mode operators and edits#

Theme selector modal commands#

Debug log commands#

Input modal commands#

Help modal commands#

Vault selector modal commands#