mirror of
https://github.com/jesseduffield/lazygit.git
synced 2026-06-20 01:19:23 +02:00
Document custom keybinding syntax
The previous version only enumerated the supported (non-rune) bindings. Replace it with a description of the syntax: how to spell single-rune keys, special keys, and modified keys; how to combine modifiers; the keyword forms for `<space>`, `<minus>`, `<plus>`; and which combinations are rejected because terminals can't deliver them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Stefan Haller
@@ -1,63 +1,96 @@
|
||||
## Possible keybindings
|
||||
| Put in | You will get |
|
||||
|---------------|----------------|
|
||||
| `<f1>` | F1 |
|
||||
| `<f2>` | F2 |
|
||||
| `<f3>` | F3 |
|
||||
| `<f4>` | F4 |
|
||||
| `<f5>` | F5 |
|
||||
| `<f6>` | F6 |
|
||||
| `<f7>` | F7 |
|
||||
| `<f8>` | F8 |
|
||||
| `<f9>` | F9 |
|
||||
| `<f10>` | F10 |
|
||||
| `<f11>` | F11 |
|
||||
| `<f12>` | F12 |
|
||||
| `<insert>` | Insert |
|
||||
| `<delete>` | Delete |
|
||||
| `<home>` | Home |
|
||||
| `<end>` | End |
|
||||
| `<pgup>` | Pgup |
|
||||
| `<pgdown>` | Pgdn |
|
||||
| `<up>` | ArrowUp |
|
||||
| `<s-up>` | ShiftArrowUp |
|
||||
| `<down>` | ArrowDown |
|
||||
| `<s-down>` | ShiftArrowDown |
|
||||
| `<left>` | ArrowLeft |
|
||||
| `<right>` | ArrowRight |
|
||||
| `<tab>` | Tab |
|
||||
| `<backtab>` | Backtab |
|
||||
| `<enter>` | Enter |
|
||||
| `<a-enter>` | AltEnter |
|
||||
| `<esc>` | Esc |
|
||||
| `<backspace>` | Backspace |
|
||||
| `<c-space>` | CtrlSpace |
|
||||
| `<c-/>` | CtrlSlash |
|
||||
| `<space>` | Space |
|
||||
| `<c-a>` | CtrlA |
|
||||
| `<c-b>` | CtrlB |
|
||||
| `<c-c>` | CtrlC |
|
||||
| `<c-d>` | CtrlD |
|
||||
| `<c-e>` | CtrlE |
|
||||
| `<c-f>` | CtrlF |
|
||||
| `<c-g>` | CtrlG |
|
||||
| `<c-j>` | CtrlJ |
|
||||
| `<c-k>` | CtrlK |
|
||||
| `<c-l>` | CtrlL |
|
||||
| `<c-n>` | CtrlN |
|
||||
| `<c-o>` | CtrlO |
|
||||
| `<c-p>` | CtrlP |
|
||||
| `<c-q>` | CtrlQ |
|
||||
| `<c-r>` | CtrlR |
|
||||
| `<c-s>` | CtrlS |
|
||||
| `<c-t>` | CtrlT |
|
||||
| `<c-u>` | CtrlU |
|
||||
| `<c-v>` | CtrlV |
|
||||
| `<c-w>` | CtrlW |
|
||||
| `<c-x>` | CtrlX |
|
||||
| `<c-y>` | CtrlY |
|
||||
| `<c-z>` | CtrlZ |
|
||||
| `<c-4>` | Ctrl4 |
|
||||
| `<c-5>` | Ctrl5 |
|
||||
| `<c-6>` | Ctrl6 |
|
||||
| `<c-8>` | Ctrl8 |
|
||||
## Custom Keybindings
|
||||
|
||||
A keybinding is one of:
|
||||
|
||||
- A single printable character, e.g. `q`, `?`, `5`. Uppercase letters mean
|
||||
shift+letter — write `A`, not `<s-a>`.
|
||||
- A special key name in angle brackets, e.g. `<enter>`, `<f1>`, `<up>`.
|
||||
- A key with modifiers in angle brackets, e.g. `<c-c>` (Ctrl+C), `<c-s-up>`
|
||||
(Ctrl+Shift+Up).
|
||||
- The literal string `<disabled>` to disable a binding.
|
||||
|
||||
### Modifiers
|
||||
|
||||
Prefix a key with one or more modifiers, joined by `-`:
|
||||
|
||||
| Prefix | Long form | Modifier |
|
||||
| ------ | --------- | ----------------------------------------------------------------------------------------- |
|
||||
| `c-` | `ctrl-` | Ctrl |
|
||||
| `a-` | `alt-` | Alt |
|
||||
| `s-` | `shift-` | Shift |
|
||||
| `m-` | `meta-` | Depends on terminal; typically ⌘ on macOS or Super/Win key, when the terminal forwards it |
|
||||
|
||||
You can also use `+` instead of `-` as the separator. Modifiers may appear in
|
||||
any order, and short and long forms can be mixed. The whole binding should be
|
||||
wrapped in angle brackets when it has any modifiers. The following all express
|
||||
the same binding:
|
||||
|
||||
- `<c-s-up>`
|
||||
- `<ctrl-shift-up>`
|
||||
- `<ctrl+shift+up>`
|
||||
- `<s-c-up>`
|
||||
|
||||
### Special key names
|
||||
|
||||
| Put in | You will get |
|
||||
| --------------------------------------- | ------------------- |
|
||||
| `<f1>` – `<f12>` | F1 – F12 |
|
||||
| `<insert>` | Insert |
|
||||
| `<delete>` | Delete |
|
||||
| `<home>` | Home |
|
||||
| `<end>` | End |
|
||||
| `<pgup>` | PageUp |
|
||||
| `<pgdown>` | PageDown |
|
||||
| `<up>` | ArrowUp |
|
||||
| `<down>` | ArrowDown |
|
||||
| `<left>` | ArrowLeft |
|
||||
| `<right>` | ArrowRight |
|
||||
| `<tab>` | Tab |
|
||||
| `<backtab>` | Shift+Tab |
|
||||
| `<enter>` | Enter |
|
||||
| `<esc>` | Escape |
|
||||
| `<backspace>` | Backspace |
|
||||
| `<space>` | Space |
|
||||
| `<mouse wheel up>`/`<mouse wheel down>` | Mouse wheel up/down |
|
||||
|
||||
These can be combined with modifiers, e.g. `<c-up>`, `<c-s-f1>`, `<a-enter>`.
|
||||
|
||||
### Special characters with modifiers
|
||||
|
||||
`<minus>` and `<plus>` are keyword forms for `-` and `+` when combined with a
|
||||
modifier (e.g. `<c-minus>` for Ctrl+`-`). Without modifiers, write `-` and `+`
|
||||
directly. `<space>` is the keyword for the space character.
|
||||
|
||||
### Combinations that are rejected
|
||||
|
||||
These look reasonable but can't actually be delivered by a terminal:
|
||||
|
||||
- `<s-a>` (shift alone on a rune) — terminals fold shift into the rune itself,
|
||||
so shift+a arrives as `A`. Write `A` instead.
|
||||
- `<c-A>`, `<a-A>`, etc. (modifier on an uppercase ASCII letter) — write
|
||||
`<c-s-a>` instead.
|
||||
|
||||
### Terminal compatibility
|
||||
|
||||
Support for combinations of modifiers, and in general keybindings beyond plain
|
||||
letters and ctrl+letter, require a newer terminal protocol that not all
|
||||
terminals support.
|
||||
|
||||
Terminals that are known to have good support include: Ghostty, kitty,
|
||||
WezTerm, foot, Konsole, Alacritty, iTerm2, Windows Terminal.
|
||||
|
||||
The default terminal on macOS (Terminal.app) does not; I recommend to switch to
|
||||
either Ghostty or iTerm2 as a replacement (or one of the others above).
|
||||
|
||||
On Windows, a popular terminal is the MinTTY console that comes with Git for
|
||||
Windows; this also doesn't support the newer protocol. The recommended
|
||||
replacement is Windows Terminal, which is very good these days, and Git Bash
|
||||
runs just fine in it.
|
||||
|
||||
Inside **tmux** or **screen**, extended keys are stripped unless the multiplexer
|
||||
is configured to forward them. For tmux 3.2+:
|
||||
|
||||
`
|
||||
set -g extended-keys on
|
||||
set -as terminal-features 'xterm*:extkeys'
|
||||
`
|
||||
|
||||
Reference in New Issue
Block a user