Skip to content

Key binding reference

Edit client.toml. See Keyboard and menus for first examples.

Per-platform shortcuts

[bindings]
FocusLeft = { macos = "Alt+H", windows = "Ctrl+Alt+H" }

Platforms: macos, windows, linux, android, ios. Omitted platforms keep their defaults.

Actions to bind

Task Action names
Tabs NewTab, NextTab, PreviousTab, SelectTab1–SelectTab9, OpenTabMenu
Panes SplitRight, SplitDown, SplitLeft, SplitUp, ClosePane, RenamePane
Focus FocusLeft, FocusDown, FocusUp, FocusRight
Fit panes FitPane, FitMainArea, ResizeToFitMain
Windows and sessions NewWindow, CloseWindow, NewSession, NextSession, PreviousSession, LastSession, CloseSession
Agents NextAgent, PreviousAgent
Side panels ToggleSidePanels, ToggleFiletree, ToggleFiletreeFocus, StatusLine
Browser NewChromium
Copy and search Copy, Paste, Search, QuickSelect, CopyMode, CopyLastOutput
Prompts PreviousPrompt, NextPrompt
Scroll ScrollPageUp, ScrollPageDown, ScrollTop, ScrollBottom
Font size IncreaseFontSize, DecreaseFontSize, ResetFontSize
Effects SettleEffects, ReleaseEffectHolds, ToggleSnow
Checkpoints SaveCheckpoint, SaveCheckpointAndQuit
Diagnostics ShowPaneStatus, ShowResourceMonitor, ShowMessages, ShowNotifications, ShowInfo

Sending text and ignoring keys

[bindings]
SendText = [
  { key = "Shift+Enter", text = "\u001b\r" },
  { key = "Cmd+Left", text = "\u0001" },
]
Ignore = ["F1"]
  • SendText sends the specified text to the focused terminal.
  • Ignore discards the key. Unlike [], it does not pass it to the terminal.
  • Both use direct shortcuts, not prefix sequences.

Conditional shortcuts

A false condition passes the key through to the terminal.

Use when to let a program handle the key while the condition is false.

[bindings]
PreviousPrompt = { key = "Shift+Up", when = "prompt" }
ScrollTop = { key = "Shift+Home", when = "!alt_screen" }
Condition Shortcut works when…
prompt The shell is waiting for input; requires shell integration
alt_screen A program uses the alternate screen
!alt_screen A program is not using the alternate screen
  • Applies to terminal actions, not app actions or prefix sequences.
  • Prompt-jump shortcuts use when = "prompt" by default.
  • Replacing a conditional binding with a plain string removes the condition.
Action Extra fields
SwitchWorld path: "flat-2d", "flat-3d", an installed world id, or a plugin path
NewChromium Optional url and browser profile
SetEffectsProfile profile: effects profile name
OpenPanel name: registered mod panel ID
SendText text: text to send
Separator No extra fields

Use os = ["macos", "windows"] to limit an entry to those platforms. Leave os out to show it everywhere.

See running actions and jumping to panes.