git.iko.soy/helix
on bbbbfa9 help sign in
helix/book/src/keymap.md
209 lines 11 kB history raw
1# Keymap
3## Normal mode
5### Movement
7> NOTE: `f`, `F`, `t` and `T` are not confined to the current line.
9| Key | Description |
10| ----- | ----------- |
11| `h`, `Left` | Move left |
12| `j`, `Down` | Move down |
13| `k`, `Up` | Move up |
14| `l`, `Right` | Move right |
15| `w` | Move next word start |
16| `b` | Move previous word start |
17| `e` | Move next word end |
18| `W` | Move next WORD start |
19| `B` | Move previous WORD start |
20| `E` | Move next WORD end |
21| `t` | Find 'till next char |
22| `f` | Find next char |
23| `T` | Find 'till previous char |
24| `F` | Find previous char |
25| `Home` | Move to the start of the line |
26| `End` | Move to the end of the line |
27| `PageUp` | Move page up |
28| `PageDown` | Move page down |
29| `Ctrl-u` | Move half page up |
30| `Ctrl-d` | Move half page down |
31| `Ctrl-i` | Jump forward on the jumplist TODO: conflicts tab |
32| `Ctrl-o` | Jump backward on the jumplist |
33| `v` | Enter [select (extend) mode](#select--extend-mode) |
34| `g` | Enter [goto mode](#goto-mode) |
35| `m` | Enter [match mode](#match-mode) |
36| `:` | Enter command mode |
37| `z` | Enter [view mode](#view-mode) |
38| `Ctrl-w` | Enter [window mode](#window-mode) (maybe will be remove for spc w w later) |
39| `Space` | Enter [space mode](#space-mode) |
40| `K` | Show documentation for the item under the cursor |
42### Changes
44| Key | Description |
45| ----- | ----------- |
46| `r` | Replace with a character |
47| `R` | Replace with yanked text |
48| `i` | Insert before selection |
49| `a` | Insert after selection (append) |
50| `I` | Insert at the start of the line |
51| `A` | Insert at the end of the line |
52| `o` | Open new line below selection |
53| `o` | Open new line above selection |
54| `u` | Undo change |
55| `U` | Redo change |
56| `y` | Yank selection |
57| `p` | Paste after selection |
58| `P` | Paste before selection |
59| `>` | Indent selection |
60| `<` | Unindent selection |
61| `=` | Format selection |
62| `d` | Delete selection |
63| `c` | Change selection (delete and enter insert mode) |
65### Selection manipulation
67| Key | Description |
68| ----- | ----------- |
69| `s` | Select all regex matches inside selections |
70| `S` | Split selection into subselections on regex matches |
71| `Alt-s` | Split selection on newlines |
72| `;` | Collapse selection onto a single cursor |
73| `Alt-;` | Flip selection cursor and anchor |
74| `%` | Select entire file |
75| `x` | Select current line, if already selected, extend to next line |
76| | Expand selection to parent syntax node TODO: pick a key |
77| `J` | join lines inside selection |
78| `K` | keep selections matching the regex TODO: overlapped by hover help |
79| `Space` | keep only the primary selection TODO: overlapped by space mode |
80| `Ctrl-c` | Comment/uncomment the selections |
82### Search
84> TODO: The search implementation isn't ideal yet -- we don't support searching
85in reverse, or searching via smartcase.
87| Key | Description |
88| ----- | ----------- |
89| `/` | Search for regex pattern |
90| `n` | Select next search match |
91| `N` | Add next search match to selection |
92| `*` | Use current selection as the search pattern |
94### Diagnostics
96> NOTE: `[` and `]` will likely contain more pair mappings in the style of
97> [vim-unimpaired](https://github.com/tpope/vim-unimpaired)
99| Key | Description |
100| ----- | ----------- |
101| `[d` | Go to previous diagnostic |
102| `]d` | Go to next diagnostic |
103| `[D` | Go to first diagnostic in document |
104| `]D` | Go to last diagnostic in document |
106## Select / extend mode
108I'm still pondering whether to keep this mode or not. It changes movement
109commands to extend the existing selection instead of replacing it.
111> NOTE: It's a bit confusing at the moment because extend hasn't been
112> implemented for all movement commands yet.
114## View mode
116View mode is intended for scrolling and manipulating the view without changing
117the selection.
119| Key | Description |
120| ----- | ----------- |
121| `z` , `c` | Vertically center the line |
122| `t` | Align the line to the top of the screen |
123| `b` | Align the line to the bottom of the screen |
124| `m` | Align the line to the middle of the screen (horizontally) |
125| `j` | Scroll the view downwards |
126| `k` | Scroll the view upwards |
128## Goto mode
130Jumps to various locations.
132> NOTE: Some of these features are only available with the LSP present.
134| Key | Description |
135| ----- | ----------- |
136| `g` | Go to the start of the file |
137| `e` | Go to the end of the file |
138| `h` | Go to the start of the line |
139| `l` | Go to the end of the line |
140| `s` | Go to first non-whitespace character of the line |
141| `t` | Go to the top of the screen |
142| `m` | Go to the middle of the screen |
143| `b` | Go to the bottom of the screen |
144| `d` | Go to definition |
145| `y` | Go to type definition |
146| `r` | Go to references |
147| `i` | Go to implementation |
148| `a` | Go to the last accessed/alternate file |
150## Match mode
152Enter this mode using `m` from normal mode. See the relavant section
153in [Usage](./usage.md) for an explanation about [surround](./usage.md#surround)
154and [textobject](./usage.md#textobject) usage.
156| Key | Description |
157| ----- | ----------- |
158| `m` | Goto matching bracket |
159| `s` `<char>` | Surround current selection with `<char>` |
160| `r` `<from><to>` | Replace surround character `<from>` with `<to>` |
161| `d` `<char>` | Delete surround character `<char>` |
162| `a` `<object>` | Select around textobject |
163| `i` `<object>` | Select inside textobject |
165## Object mode
167TODO: Mappings for selecting syntax nodes (a superset of `[`).
169## Window mode
171This layer is similar to vim keybindings as kakoune does not support window.
173| Key | Description |
174| ----- | ------------- |
175| `w`, `Ctrl-w` | Switch to next window |
176| `v`, `Ctrl-v` | Vertical right split |
177| `h`, `Ctrl-h` | Horizontal bottom split |
178| `q`, `Ctrl-q` | Close current window |
180## Space mode
182This layer is a kludge of mappings I had under leader key in neovim.
184| Key | Description |
185| ----- | ----------- |
186| `f` | Open file picker |
187| `b` | Open buffer picker |
188| `s` | Open symbol picker (current document) |
189| `w` | Enter [window mode](#window-mode) |
190| `space` | Keep primary selection TODO: it's here because space mode replaced it |
191| `p` | paste system clipboard after selections |
192| `P` | paste system clipboard before selections |
193| `y` | join and yank selections to clipboard |
194| `Y` | yank main selection to clipboard |
195| `R` | replace selections by clipboard contents |
197# Picker
199Keys to use within picker.
201| Key | Description |
202| ----- | ------------- |
203| `Up`, `Ctrl-p` | Previous entry |
204| `Down`, `Ctrl-n` | Next entry |
205| `Ctrl-space` | Filter options |
206| `Enter` | Open selected |
207| `Ctrl-h` | Open horizontally |
208| `Ctrl-v` | Open vertically |
209| `Escape`, `Ctrl-c` | Close picker |