1# Completions
2
3Zed supports two sources for completions:
4
51. "Code Completions" provided by Language Servers (LSPs) automatically installed by Zed or via [Zed Language Extensions](languages.md).
62. "Edit Predictions" provided by Zed's own Zeta model or by external providers like [GitHub Copilot](#github-copilot) or [Supermaven](#supermaven).
7
8## Language Server Code Completions {#code-completions}
9
10When there is an appropriate language server available, Zed will provide completions of variable names, functions, and other symbols in the current file. You can disable these by adding the following to your Zed `settings.json` file:
11
12```json
13"show_completions_on_input": false
14```
15
16You can manually trigger completions with `ctrl-space` or by triggering the `editor::ShowCompletions` action from the command palette.
17
18For more information, see:
19
20- [Configuring Supported Languages](./configuring-languages.md)
21- [List of Zed Supported Languages](./languages.md).
22
23## Edit Predictions {#edit-predictions}
24
25Zed has built-in support for predicting multiple edits at a time [via Zeta](https://huggingface.co/zed-industries/zeta), Zed's open-source and open-data model.
26Edit predictions appear as you type, and most of the time, you can accept them by pressing `tab`.
27
28### Configuring Zeta
29
30Zed's Edit Prediction was initially introduced via a banner on the title bar.
31Clicking on it would take you to a modal with a button ("Enable Edit Prediction") that sets `zed` as your `edit_prediction_provider`.
32
33
34
35But, if you haven't come across the banner, start using Zed's Edit Prediction by adding this to your settings:
36
37```json
38"features": {
39 "edit_prediction_provider": "zed"
40},
41```
42
43### Switching modes
44
45Zed's Edit Prediction comes with two different display modes:
46
471. `eager` (default): predictions are displayed inline as long as it doesn't conflict with language server completions
482. `subtle`: predictions only appear inline when holding a modifier key (`alt` by default)
49
50Toggle between them via the `mode` key:
51
52```json
53"edit_predictions": {
54 "mode": "eager" | "subtle"
55},
56```
57
58### Conflict With Other `tab` Actions {#edit-predictions-conflict}
59
60By default, when `tab` would normally perform a different action, Zed requires a modifier key to accept predictions:
61
621. When the language server completions menu is visible.
632. When your cursor isn't at the right indentation level.
64
65In these cases, `alt-tab` is used instead to accept the prediction. When the language server completions menu is open, holding `alt` first will cause it to temporarily disappear in order to preview the prediction within the buffer.
66
67On Linux, `alt-tab` is often used by the window manager for switching windows, so `alt-l` is provided as the default binding for accepting predictions. `tab` and `alt-tab` also work, but aren't displayed by default.
68
69{#action editor::AcceptPartialEditPrediction} ({#kb editor::AcceptPartialEditPrediction}) can be used to accept the current edit prediction up to the next word boundary.
70
71See the [Configuring GitHub Copilot](#github-copilot) and [Configuring Supermaven](#supermaven) sections below for configuration of other providers. Only text insertions at the current cursor are supported for these providers, whereas the Zeta model provides multiple predictions including deletions.
72
73## Configuring Edit Prediction Keybindings {#edit-predictions-keybinding}
74
75By default, `tab` is used to accept edit predictions. You can use another keybinding by inserting this in your keymap:
76
77```json
78{
79 "context": "Editor && edit_prediction",
80 "bindings": {
81 // Here we also allow `alt-enter` to accept the prediction
82 "alt-enter": "editor::AcceptEditPrediction"
83 }
84}
85```
86
87When there's a [conflict with the `tab` key](#edit-predictions-conflict), Zed uses a different context to accept keybindings (`edit_prediction_conflict`). If you want to use a different one, you can insert this in your keymap:
88
89```json
90{
91 "context": "Editor && edit_prediction_conflict",
92 "bindings": {
93 "ctrl-enter": "editor::AcceptEditPrediction" // Example of a modified keybinding
94 }
95}
96```
97
98If your keybinding contains a modifier (`ctrl` in the example above), it will also be used to preview the edit prediction and temporarily hide the language server completion menu.
99
100You can also bind this action to keybind without a modifier. In that case, Zed will use the default modifier (`alt`) to preview the edit prediction.
101
102```json
103{
104 "context": "Editor && edit_prediction_conflict",
105 "bindings": {
106 // Here we bind tab to accept even when there's a language server completion
107 // or the cursor isn't at the correct indentation level
108 "tab": "editor::AcceptEditPrediction"
109 }
110}
111```
112
113To maintain the use of the modifier key for accepting predictions when there is a language server completions menu, but allow `tab` to accept predictions regardless of cursor position, you can specify the context further with `showing_completions`:
114
115```json
116{
117 "context": "Editor && edit_prediction_conflict && !showing_completions",
118 "bindings": {
119 // Here we don't require a modifier unless there's a language server completion
120 "tab": "editor::AcceptEditPrediction"
121 }
122}
123```
124
125### Keybinding Example: Always Use Alt-Tab
126
127The keybinding example below causes `alt-tab` to always be used instead of sometimes using `tab`. You might want this in order to have just one keybinding to use for accepting edit predictions, since the behavior of `tab` varies based on context.
128
129```json
130 {
131 "context": "Editor && edit_prediction",
132 "bindings": {
133 "alt-tab": "editor::AcceptEditPrediction"
134 }
135 },
136 // Bind `tab` back to its original behavior.
137 {
138 "context": "Editor",
139 "bindings": {
140 "tab": "editor::Tab"
141 }
142 },
143 {
144 "context": "Editor && showing_completions",
145 "bindings": {
146 "tab": "editor::ComposeCompletion"
147 }
148 },
149```
150
151If `"vim_mode": true` is set within `settings.json`, then additional bindings are needed after the above to return `tab` to its original behavior:
152
153```json
154 {
155 "context": "(VimControl && !menu) || vim_mode == replace || vim_mode == waiting",
156 "bindings": {
157 "tab": "vim::Tab"
158 }
159 },
160 {
161 "context": "vim_mode == literal",
162 "bindings": {
163 "tab": ["vim::Literal", ["tab", "\u0009"]]
164 }
165 },
166```
167
168### Keybinding Example: Displaying Tab and Alt-Tab on Linux
169
170While `tab` and `alt-tab` are supported on Linux, `alt-l` is displayed instead. If your window manager does not reserve `alt-tab`, and you would prefer to use `tab` and `alt-tab`, include these bindings in `keymap.json`:
171
172```json
173 {
174 "context": "Editor && edit_prediction",
175 "bindings": {
176 "tab": "editor::AcceptEditPrediction",
177 // Optional: This makes the default `alt-l` binding do nothing.
178 "alt-l": null
179 }
180 },
181 {
182 "context": "Editor && edit_prediction_conflict",
183 "bindings": {
184 "alt-tab": "editor::AcceptEditPrediction",
185 // Optional: This makes the default `alt-l` binding do nothing.
186 "alt-l": null
187 }
188 },
189```
190
191### Missing keybind {#edit-predictions-missing-keybinding}
192
193Zed requires at least one keybinding for the {#action editor::AcceptEditPrediction} action in both the `Editor && edit_prediction` and `Editor && edit_prediction_conflict` contexts ([learn more above](#edit-predictions-keybinding)).
194
195If you have previously bound the default keybindings to different actions in the global context, you will not be able to preview or accept edit predictions. For example:
196
197```json
198[
199 // Your keymap
200 {
201 "bindings": {
202 // Binds `alt-tab` to a different action globally
203 "alt-tab": "menu::SelectNext"
204 }
205 }
206]
207```
208
209To fix this, you can specify your own keybinding for accepting edit predictions:
210
211```json
212[
213 // ...
214 {
215 "context": "Editor && edit_prediction_conflict",
216 "bindings": {
217 "alt-l": "editor::AcceptEditPrediction"
218 }
219 }
220]
221```
222
223If you would like to use the default keybinding, you can free it up by either moving yours to a more specific context or changing it to something else.
224
225## Disabling Automatic Edit Prediction
226
227To disable predictions that appear automatically as you type, set this within `settings.json`:
228
229```json
230{
231 "show_edit_predictions": false
232}
233```
234
235You can trigger edit predictions manually by executing {#action editor::ShowEditPrediction} ({#kb editor::ShowEditPrediction}).
236
237You can also add this as a language-specific setting in your `settings.json` to disable edit predictions for a specific language:
238
239```json
240{
241 "language": {
242 "python": {
243 "show_edit_predictions": false
244 }
245 }
246}
247```
248
249## Configuring GitHub Copilot {#github-copilot}
250
251To use GitHub Copilot, set this within `settings.json`:
252
253```json
254{
255 "features": {
256 "edit_prediction_provider": "copilot"
257 }
258}
259```
260
261You should be able to sign-in to GitHub Copilot by clicking on the Copilot icon in the status bar and following the setup instructions.
262
263Copilot can provide multiple completion alternatives, and these can be navigated with the following actions:
264
265- {#action editor::NextEditPrediction} ({#kb editor::NextEditPrediction}): To cycle to the next edit prediction
266- {#action editor::PreviousEditPrediction} ({#kb editor::PreviousEditPrediction}): To cycle to the previous edit prediction
267
268## Configuring Supermaven {#supermaven}
269
270To use Supermaven, set this within `settings.json`:
271
272```json
273{
274 "features": {
275 "edit_prediction_provider": "supermaven"
276 }
277}
278```
279
280You should be able to sign-in to Supermaven by clicking on the Supermaven icon in the status bar and following the setup instructions.
281
282## See also
283
284You may also use the Assistant Panel or the Inline Assistant to interact with language models, see the [assistant](assistant/assistant.md) documentation for more information.