1# Key bindings
2
3Zed can be configured via a simple JSON file located at `~/.config/zed/keymap.json`.
4
5## Predefined keymaps
6
7We have a growing collection of pre-defined keymaps in [zed repository's keymaps folder](https://github.com/zed-industries/zed/tree/main/assets/keymaps). Our current keymaps include:
8
9- Atom
10- JetBrains
11- SublimeText
12- TextMate
13- VSCode (default)
14
15These keymaps can be set via the `base_keymap` setting in your `settings.json` file. Additionally, if you'd like to work from a clean slate, you can provide `"None"` to the setting.
16
17## Custom key bindings
18
19### Accessing custom key bindings
20
21You can open `keymap.json` via `โ` + `K`, `โ` + `S`, the command palette, or the `Zed > Settings > Open Key Bindings` application menu item.
22
23### Adding a custom key binding
24
25To customize key bindings, specify a context and the list of bindings to set. Re-mapping an existing binding will clobber the existing binding in favor of the custom one.
26
27An example of adding a set of custom key bindings:
28
29```json
30[
31 {
32 "context": "Editor",
33 "bindings": {
34 "ctrl-w": "editor::SelectLargerSyntaxNode",
35 "ctrl-shift-W": "editor::SelectSmallerSyntaxNode",
36 "ctrl-c": "editor::Cancel"
37 }
38 }
39]
40```
41
42You can see more examples in Zed's [`default.json`](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-macos.json)
43
44_There are some key bindings that can't be overridden; we are working on an issue surrounding this._
45
46### Keybinding syntax
47
48Zed has the ability to match against not just a single keypress, but a sequence of keys typed in order. Each key in the `"bindings"` map is a sequence of keypresses separated with a space.
49
50Each key press is a sequence of modifiers followed by a key. The modifiers are:
51
52- `ctrl-` The control key
53- `cmd-` On macOS, this is the command key
54- `alt-` On macOS, this is the option key
55- `shift-` The shift key
56- `fn-` The function key
57
58The keys can be any single unicode codepoint that your keyboard generates (for example `a`, `0`, `ยฃ` or `รง`).
59
60A few examples:
61
62```
63 "bindings": {
64 "cmd-k cmd-s": "zed::OpenKeymap", // matches โ-k then โ-s
65 "space e": "editor::Complete", // type space then e
66 "รง": "editor::Complete", // matches โฅ-c
67 }
68```
69
70NOTE: Keys on a keyboard are not always the same as the character they generate. For example `shift-e` actually types `E` (or `alt-c` types `รง`). Zed allows you to match against either the key and its modifiers or the character it generates. This means you can specify `alt-c` or `รง`, but not `alt-รง`. It is usually better to specify the key and its modifiers, as this will work better on different keyboard layouts.
71
72### Remapping keys
73
74A common request is to be able to map from one sequence of keys to another. As of Zed 0.124.0 you can do this with the `workspace::SendKeystrokes` action.
75
76```json
77[
78 {
79 "bindings": {
80 "alt-down": ["workspace::SendKeystrokes", "down down down down"],
81 "cmd-alt-c": [
82 "workspace::SendKeystrokes",
83 "cmd-shift-p copy relative path enter"
84 ],
85 "cmd-alt-r": ["workspace::SendKeystrokes", "cmd-p README enter"]
86 }
87 },
88 {
89 "context": "Editor && vim_mode == insert",
90 "bindings": {
91 "j k": ["workspace::SendKeystrokes", "escape"],
92 }
93 }
94]
95```
96
97There are some limitations to this, notably:
98
99- Any asynchronous operation will not happen until after all your key bindings have been dispatched. For example this means that while you can use a binding to open a file (as in the `cmd-alt-r` example) you cannot send further keystrokes and hope to have them interpreted by the new view.
100- - Other examples of asynchronous things are: communicating with a language server, changing the language of a buffer, anything that hits the network.
101- There is a limit of 100 simulated keys at a time, this is to avoid accidental infinite recursion if you trigger SendKeystrokes again inside your bindings.
102
103The argument to `SendKeystrokes` is a space-separated list of keystrokes (using the same syntax as above). Due to the way that keystrokes are parsed, any segment that is not recognized as a keypress will be sent verbatim to the currently focused input field.
104
105### All key bindings
106
107#### Global
108
109| **Command** | **Target** | **Default Shortcut** |
110| ------------------------- | ------------ | ----------------------- |
111| Toggle focus | Collab Panel | `โ + Shift + C` |
112| Toggle inlay hints | Editor | `Control + :` |
113| Cancel | Menu | `Control + C` |
114| Cancel | Menu | `Control + Escape` |
115| Cancel | Menu | `Escape` |
116| Cancel | Menu | `โ + Escape` |
117| Confirm | Menu | `Enter` |
118| Secondary confirm | Menu | `Control + Enter` |
119| Secondary confirm | Menu | `โ + Enter` |
120| Select first | Menu | `Page Up` |
121| Select first | Menu | `Shift + Page Down` |
122| Select first | Menu | `Shift + Page Up` |
123| Select first | Menu | `โ + Up` |
124| Select last | Menu | `Page Down` |
125| Select last | Menu | `โ + Down` |
126| Select next | Menu | `Control + N` |
127| Select next | Menu | `Down` |
128| Select prev | Menu | `Control + P` |
129| Select prev | Menu | `Up` |
130| Confirm input | Picker | `Alt + Enter` |
131| Confirm input | Picker | `โ + Alt + Enter` |
132| Use selected query | Picker | `Shift + Enter` |
133| Close window | Workspace | `โ + Shift + W` |
134| Follow next collaborator | Workspace | `Control + Alt + โ + F` |
135| Open | Workspace | `โ + O` |
136| Toggle zoom | Workspace | `Shift + Escape` |
137| Debug elements | Zed | `โ + Alt + I` |
138| Decrease buffer font size | Zed | `โ + ` |
139| Hide | Zed | `โ + H` |
140| Hide others | Zed | `Alt + โ + H` |
141| Increase buffer font size | Zed | `โ + +` |
142| Increase buffer font size | Zed | `โ + =` |
143| Minimize | Zed | `โ + M` |
144| Open settings | Zed | `โ + ,` |
145| Quit | Zed | `โ + Q` |
146| Reset buffer font size | Zed | `โ + 0` |
147| Toggle full screen | Zed | `Control + โ + F` |
148
149#### Editor
150
151| **Command** | **Target** | **Default Shortcut** |
152| -------------------------------- | ---------- | ------------------------------- |
153| Add selection above | Editor | `โ + Alt + Up` |
154| Add selection above | Editor | `โ + Control + P` |
155| Add selection below | Editor | `โ + Alt + Down` |
156| Add selection below | Editor | `โ + Control + N` |
157| Backspace | Editor | `Backspace` |
158| Backspace | Editor | `Control + H` |
159| Backspace | Editor | `Shift + Backspace` |
160| Cancel | Editor | `Escape` |
161| Confirm code action | Editor | `Enter` |
162| Confirm completion | Editor | `Enter` |
163| Confirm completion | Editor | `Tab` |
164| Confirm rename | Editor | `Enter` |
165| Context menu first | Editor | `Page Up` |
166| Context menu last | Editor | `Page Down` |
167| Context menu next | Editor | `Control + N` |
168| Context menu next | Editor | `Down` |
169| Context menu prev | Editor | `Control + P` |
170| Context menu prev | Editor | `Up` |
171| Copy | Editor | `โ + C` |
172| Cut | Editor | `โ + X` |
173| Cut to end of line | Editor | `Control + K` |
174| Delete | Editor | `Control + D` |
175| Delete | Editor | `Delete` |
176| Delete line | Editor | `โ + Shift + K` |
177| Delete to beginning of line | Editor | `โ + Backspace` |
178| Delete to end of line | Editor | `โ + Delete` |
179| Delete to next subword end | Editor | `Control + Alt + D` |
180| Delete to next subword end | Editor | `Control + Alt + Delete` |
181| Delete to next word end | Editor | `Alt + D` |
182| Delete to next word end | Editor | `Alt + Delete` |
183| Delete to previous subword start | Editor | `Control + Alt + Backspace` |
184| Delete to previous subword start | Editor | `Control + Alt + H` |
185| Delete to previous word start | Editor | `Alt + Backspace` |
186| Delete to previous word start | Editor | `Alt + H` |
187| Delete to previous word start | Editor | `Control + W` |
188| Display cursor names | Editor | `Control + โ + C` |
189| Duplicate line down | Editor | `Alt + Shift + Down` |
190| Duplicate line up | Editor | `Alt + Shift + Up` |
191| Find all references | Editor | `Alt + Shift + F12` |
192| Fold | Editor | `Alt + โ + [` |
193| Format | Editor | `โ + Shift + I` |
194| Go to definition | Editor | `F12` |
195| Go to definition split | Editor | `Alt + F12` |
196| Go to diagnostic | Editor | `F8` |
197| Go to implementation | Editor | `Shift + F12` |
198| Go to prev diagnostic | Editor | `Shift + F8` |
199| Go to type definition | Editor | `โ + F12` |
200| Go to type definition split | Editor | `Alt + โ + F12` |
201| Hover | Editor | `โ + K, โ + I` |
202| Indent | Editor | `โ + ]` |
203| Join lines | Editor | `Control + J` |
204| Move down | Editor | `Control + N` |
205| Move down | Editor | `Down` |
206| Move left | Editor | `Control + B` |
207| Move left | Editor | `Left` |
208| Move line down | Editor | `Alt + Down` |
209| Move line up | Editor | `Alt + Up` |
210| Move page down | Editor | `Control + V` |
211| Move page down | Editor | `Shift + Page Down` |
212| Move page up | Editor | `Alt + V` |
213| Move page up | Editor | `Shift + Page Up` |
214| Move right | Editor | `Control + F` |
215| Move right | Editor | `Right` |
216| Move to beginning | Editor | `โ + Up` |
217| Move to beginning of line | Editor | `Control + A` |
218| Move to beginning of line | Editor | `Home` |
219| Move to beginning of line | Editor | `โ + Left` |
220| Move to enclosing bracket | Editor | `Control + M` |
221| Move to end | Editor | `โ + Down` |
222| Move to end of line | Editor | `Control + E` |
223| Move to end of line | Editor | `End` |
224| Move to end of line | Editor | `โ + Right` |
225| Move to end of paragraph | Editor | `Control + Down` |
226| Move to next subword end | Editor | `Control + Alt + F` |
227| Move to next subword end | Editor | `Control + Alt + Right` |
228| Move to next word end | Editor | `Alt + F` |
229| Move to next word end | Editor | `Alt + Right` |
230| Move to previous subword start | Editor | `Control + Alt + B` |
231| Move to previous subword start | Editor | `Control + Alt + Left` |
232| Move to previous word start | Editor | `Alt + B` |
233| Move to previous word start | Editor | `Alt + Left` |
234| Move to start of paragraph | Editor | `Control + Up` |
235| Move up | Editor | `Control + P` |
236| Move up | Editor | `Up` |
237| Next screen | Editor | `Control + L` |
238| Outdent | Editor | `โ + [` |
239| Page down | Editor | `Page Down` |
240| Page up | Editor | `Page Up` |
241| Paste | Editor | `โ + V` |
242| Redo | Editor | `โ + Shift + Z` |
243| Redo selection | Editor | `โ + Shift + U` |
244| Rename | Editor | `F2` |
245| Reveal in finder | Editor | `Alt + โ + R` |
246| Revert selected hunks | Editor | `โ + Alt + Z` |
247| Select all | Editor | `โ + A` |
248| Select all matches | Editor | `โ + Shift + L` |
249| Select down | Editor | `Control + Shift + N` |
250| Select down | Editor | `Shift + Down` |
251| Select larger syntax node | Editor | `Control + Shift + Right` |
252| Select left | Editor | `Control + Shift + B` |
253| Select left | Editor | `Shift + Left` |
254| Select line | Editor | `โ + L` |
255| Select next | Editor | `โ + D` |
256| Select next | Editor | `โ + K, โ + D` |
257| Select previous | Editor | `Control + โ + D` |
258| Select previous | Editor | `โ + K, Control + โ + D` |
259| Select right | Editor | `Control + Shift + F` |
260| Select right | Editor | `Shift + Right` |
261| Select smaller syntax node | Editor | `Control + Shift + Left` |
262| Select to beginning | Editor | `โ + Shift + Up` |
263| Select to beginning of line | Editor | `Control + Shift + A` |
264| Select to beginning of line | Editor | `Shift + Home` |
265| Select to beginning of line | Editor | `โ + Shift + Left` |
266| Select to end | Editor | `โ + Shift + Down` |
267| Select to end of line | Editor | `Control + Shift + E` |
268| Select to end of line | Editor | `Shift + End` |
269| Select to end of line | Editor | `โ + Shift + Right` |
270| Select to end of paragraph | Editor | `Control + Shift + Down` |
271| Select to next subword end | Editor | `Control + Alt + Shift + F` |
272| Select to next subword end | Editor | `Control + Alt + Shift + Right` |
273| Select to next word end | Editor | `Alt + Shift + F` |
274| Select to next word end | Editor | `Alt + Shift + Right` |
275| Select to previous subword start | Editor | `Control + Alt + Shift + B` |
276| Select to previous subword start | Editor | `Control + Alt + Shift + Left` |
277| Select to previous word start | Editor | `Alt + Shift + B` |
278| Select to previous word start | Editor | `Alt + Shift + Left` |
279| Select to start of paragraph | Editor | `Control + Shift + Up` |
280| Select up | Editor | `Control + Shift + P` |
281| Select up | Editor | `Shift + Up` |
282| Show character palette | Editor | `Control + โ + Space` |
283| Show completions | Editor | `Control + Space` |
284| Show inline completion | Editor | `Alt + \` |
285| Tab | Editor | `Tab` |
286| Tab prev | Editor | `Shift + Tab` |
287| Toggle code actions | Editor | `โ + .` |
288| Toggle comments | Editor | `โ + /` |
289| Toggle git blame | Editor | `โ + Alt + G, B` |
290| Toggle line numbers | Editor | `โ + ;` |
291| Transpose | Editor | `Control + T` |
292| Undo | Editor | `โ + Z` |
293| Undo selection | Editor | `โ + U` |
294| Unfold lines | Editor | `Alt + โ + ]` |
295
296#### Editor (Full Only)
297
298| **Command** | **Target** | **Default Shortcut** |
299| -------------------------------- | ------------- | -------------------- |
300| Inline assist | Assistant | `Control + Enter` |
301| Quote selection | Assistant | `โ + >` |
302| Deploy | Buffer Search | `โ + Alt + F` |
303| Deploy | Buffer Search | `โ + E` |
304| Deploy | Buffer Search | `โ + F` |
305| Accept partial inline completion | Editor | `Alt + Right` |
306| Go to hunk | Editor | `โ + F8` |
307| Go to prev hunk | Editor | `โ + Shift + F8` |
308| Newline | Editor | `Enter` |
309| Newline | Editor | `Shift + Enter` |
310| Newline above | Editor | `โ + Shift + Enter` |
311| Newline below | Editor | `โ + Enter` |
312| Next inline completion | Editor | `Alt + ]` |
313| Open excerpts | Editor | `Alt + Enter` |
314| Open excerpts split | Editor | `โ + K, Enter` |
315| Previous inline completion | Editor | `Alt + [` |
316| Toggle soft wrap | Editor | `Alt + Z` |
317| Toggle | Go To Line | `Control + G` |
318| Toggle | Outline | `โ + Shift + O` |
319
320#### Editor (Auto Height Only)
321
322| **Command** | **Target** | **Default Shortcut** |
323| ------------- | ---------- | ------------------------- |
324| Newline | Editor | `Control + Enter` |
325| Newline | Editor | `Shift + Enter` |
326| Newline below | Editor | `Control + Shift + Enter` |
327
328#### Pane
329
330| **Command** | **Target** | **Default Shortcut** |
331| ----------------------------- | -------------- | ----------------------- |
332| Activate item 1 | Pane | `Control + 1` |
333| Activate item 2 | Pane | `Control + 2` |
334| Activate item 3 | Pane | `Control + 3` |
335| Activate item 4 | Pane | `Control + 4` |
336| Activate item 5 | Pane | `Control + 5` |
337| Activate item 6 | Pane | `Control + 6` |
338| Activate item 7 | Pane | `Control + 7` |
339| Activate item 8 | Pane | `Control + 8` |
340| Activate item 9 | Pane | `Control + 9` |
341| Activate last item | Pane | `Control + 0` |
342| Activate next item | Pane | `Alt + โ + Right` |
343| Activate next item | Pane | `โ + }` |
344| Activate prev item | Pane | `Alt + โ + Left` |
345| Activate prev item | Pane | `โ + {` |
346| Close active item | Pane | `โ + W` |
347| Close all items | Pane | `โ + K, โ + W` |
348| Close clean items | Pane | `โ + K, U` |
349| Close inactive items | Pane | `Alt + โ + T` |
350| Go back | Pane | `Control + ` |
351| Go forward | Pane | `Control + _` |
352| Reopen closed item | Pane | `โ + Shift + T` |
353| Split down | Pane | `โ + K, Down` |
354| Split left | Pane | `โ + K, Left` |
355| Split right | Pane | `โ + K, Right` |
356| Split up | Pane | `โ + K, Up` |
357| Toggle filters | Project Search | `Alt + โ + F` |
358| Toggle focus | Project Search | `โ + F` |
359| Toggle focus | Project Search | `โ + Shift + F` |
360| Activate regex mode | Search | `Alt + โ + G` |
361| Activate text mode | Search | `Alt + โ + X` |
362| Cycle mode | Search | `Alt + Tab` |
363| Select all matches | Search | `Alt + Enter` |
364| Select next match | Search | `โ + G` |
365| Select prev match | Search | `โ + Shift + G` |
366| Toggle case sensitive | Search | `Alt + โ + C` |
367| Toggle replace | Search | `โ + Shift + H` |
368| Toggle whole word | Search | `Alt + โ + W` |
369| Close inactive tabs and panes | Workspace | `Control + Alt + โ + W` |
370
371#### Buffer Search Bar
372
373| **Command** | **Target** | **Default Shortcut** |
374| ---------------------- | ------------- | -------------------- |
375| Dismiss | Buffer Search | `Escape` |
376| Focus editor | Buffer Search | `Tab` |
377| Cycle mode | Search | `Alt + Tab` |
378| Focus search | Search | `โ + F` |
379| Next history query | Search | `Down` |
380| Previous history query | Search | `Up` |
381| Replace all | Search | `โ + Enter` |
382| Replace next | Search | `Enter` |
383| Select all matches | Search | `Alt + Enter` |
384| Select next match | Search | `Enter` |
385| Select prev match | Search | `Shift + Enter` |
386| Toggle replace | Search | `โ + Alt + F` |
387
388#### Workspace
389
390| **Command** | **Target** | **Default Shortcut** |
391| -------------------------------- | ----------------- | ----------------------- |
392| Toggle focus | Assistant | `โ + ?` |
393| Open recent | Branches | `Alt + โ + B` |
394| Toggle | Command Palette | `โ + Shift + P` |
395| Deploy | Diagnostics | `โ + Shift + M` |
396| Toggle | File Finder | `โ + P` |
397| Toggle | Language Selector | `โ + K, M` |
398| Deploy search | Pane | `โ + Shift + F` |
399| Deploy search | Pane | `โ + Shift + H` |
400| Toggle focus | Project Panel | `โ + Shift + E` |
401| Toggle | Project Symbols | `โ + T` |
402| Open recent | Projects | `Alt + โ + O` |
403| Toggle | Tab Switcher | `Control + Shift + Tab` |
404| Toggle | Tab Switcher | `Control + Tab` |
405| Rerun | Task | `Alt + T` |
406| Spawn | Task | `Alt + Shift + T` |
407| Toggle focus | Terminal Panel | ``Control + ` `` |
408| Toggle | Theme Selector | `โ + K, โ + T` |
409| Activate pane 1 | Workspace | `โ + 1` |
410| Activate pane 2 | Workspace | `โ + 2` |
411| Activate pane 3 | Workspace | `โ + 3` |
412| Activate pane 4 | Workspace | `โ + 4` |
413| Activate pane 5 | Workspace | `โ + 5` |
414| Activate pane 6 | Workspace | `โ + 6` |
415| Activate pane 7 | Workspace | `โ + 7` |
416| Activate pane 8 | Workspace | `โ + 8` |
417| Activate pane 9 | Workspace | `โ + 9` |
418| Activate pane in direction down | Workspace | `โ + K, โ + Down` |
419| Activate pane in direction left | Workspace | `โ + K, โ + Left` |
420| Activate pane in direction right | Workspace | `โ + K, โ + Right` |
421| Activate pane in direction up | Workspace | `โ + K, โ + Up` |
422| Close all docks | Workspace | `Alt + โ + Y` |
423| New file | Workspace | `โ + N` |
424| New terminal | Workspace | `Control + ~` |
425| New window | Workspace | `โ + Shift + N` |
426| Save | Workspace | `โ + S` |
427| Save all | Workspace | `โ + Alt + S` |
428| Save as | Workspace | `โ + Shift + S` |
429| Save without format | Workspace | `โ + K, S` |
430| Swap pane in direction | Workspace | `โ + K, Shift + Down` |
431| Swap pane in direction | Workspace | `โ + K, Shift + Left` |
432| Swap pane in direction | Workspace | `โ + K, Shift + Right` |
433| Swap pane in direction | Workspace | `โ + K, Shift + Up` |
434| Toggle bottom dock | Workspace | `โ + J` |
435| Toggle left dock | Workspace | `โ + B` |
436| Toggle right dock | Workspace | `โ + R` |
437| Unfollow | Workspace | `Escape` |
438| Open keymap | Zed | `โ + K, โ + S` |
439
440#### Project Panel
441
442| **Command** | **Target** | **Default Shortcut** |
443| ----------------------- | ------------- | --------------------- |
444| Collapse selected entry | Project Panel | `Left` |
445| Copy | Project Panel | `โ + C` |
446| Copy path | Project Panel | `โ + Alt + C` |
447| Copy relative path | Project Panel | `Alt + โ + Shift + C` |
448| Cut | Project Panel | `โ + X` |
449| Delete | Project Panel | `Backspace` |
450| Delete | Project Panel | `Delete` |
451| Delete | Project Panel | `โ + Backspace` |
452| Delete | Project Panel | `โ + Delete` |
453| Expand selected entry | Project Panel | `Right` |
454| New directory | Project Panel | `Alt + โ + N` |
455| New file | Project Panel | `โ + N` |
456| New search in directory | Project Panel | `Alt + Shift + F` |
457| Open | Project Panel | `Space` |
458| Paste | Project Panel | `โ + V` |
459| Rename | Project Panel | `Enter` |
460| Rename | Project Panel | `F2` |
461| Reveal in finder | Project Panel | `Alt + โ + R` |
462
463#### Project Search Bar
464
465| **Command** | **Target** | **Default Shortcut** |
466| ---------------------- | -------------- | -------------------- |
467| Search in new | Project Search | `โ + Enter` |
468| Toggle focus | Project Search | `Escape` |
469| Activate regex mode | Search | `Alt + โ + G` |
470| Activate text mode | Search | `Alt + โ + X` |
471| Cycle mode | Search | `Alt + Tab` |
472| Focus search | Search | `โ + Shift + F` |
473| Next history query | Search | `Down` |
474| Previous history query | Search | `Up` |
475| Replace all | Search | `โ + Enter` |
476| Replace next | Search | `Enter` |
477| Toggle replace | Search | `โ + Shift + H` |
478
479#### Terminal
480
481| **Command** | **Target** | **Default Shortcut** |
482| --------------------------- | ---------- | --------------------- |
483| Clear | Terminal | `โ + K` |
484| Copy | Terminal | `โ + C` |
485| Delete line | Terminal | `โ + Backspace` |
486| Move to beginning of line | Terminal | `โ + Left` |
487| Move to end of line | Terminal | `โ + Right` |
488| Move to next word end | Terminal | `Alt + Right` |
489| Move to previous word start | Terminal | `Alt + Left` |
490| Paste | Terminal | `โ + V` |
491| Show character palette | Terminal | `Control + โ + Space` |
492
493#### Assistant Editor
494
495| **Command** | **Target** | **Default Shortcut** |
496| ------------------ | ---------- | -------------------- |
497| Assist | Assistant | `โ + Enter` |
498| Cycle message role | Assistant | `Control + R` |
499| Quote selection | Assistant | `โ + >` |
500| Split | Assistant | `Shift + Enter` |
501| Save | Workspace | `โ + S` |