1# Configuring Zed
2
3Zed is designed to be configured: we want to fit your workflow and preferences exactly. We provide default settings that are designed to be a comfortable starting point for as many people as possible, but we hope you will enjoy tweaking it to make it feel incredible.
4
5In addition to the settings described here, you may also want to change your [theme](./themes.md), configure your [key bindings](./key-bindings.md), set up [tasks](./tasks.md) or install [extensions](https://github.com/zed-industries/extensions).
6
7## Settings files
8
9<!--
10TBD: Settings files. Rewrite with "remote settings" in mind (e.g. `local settings` on the remote host).
11Consider renaming `zed: Open Local Settings` to `zed: Open Project Settings`.
12
13TBD: Add settings documentation about how settings are merged as overlays. E.g. project>local>default. Note how settings that are maps are merged, but settings that are arrays are replaced and must include the defaults.
14-->
15
16Your settings file can be opened with {#kb zed::OpenSettings}. By default it is located at `~/.config/zed/settings.json`, though if you have XDG_CONFIG_HOME in your environment on Linux it will be at `$XDG_CONFIG_HOME/zed/settings.json` instead.
17
18This configuration is merged with any local configuration inside your projects. You can open the project settings by running {#action zed::OpenProjectSettings} from the command palette. This will create a `.zed` directory containing`.zed/settings.json`.
19
20Although most projects will only need one settings file at the root, you can add more local settings files for subdirectories as needed. Not all settings can be set in local files, just those that impact the behavior of the editor and language tooling. For example you can set `tab_size`, `formatter` etc. but not `theme`, `vim_mode` and similar.
21
22The syntax for configuration files is a super-set of JSON that allows `//` comments.
23
24## Default settings
25
26You can find the default settings for your current Zed by running {#action zed::OpenDefaultSettings} from the command palette.
27
28Extensions that provide language servers may also provide default settings for those language servers.
29
30# Settings
31
32## Active Pane Modifiers
33
34- Description: Styling settings applied to the active pane.
35- Setting: `active_pane_modifiers`
36- Default:
37
38```json
39{
40 "active_pane_modifiers": {
41 "border_size": 0.0,
42 "inactive_opacity": 1.0
43 }
44}
45```
46
47### Border size
48
49- Description: Size of the border surrounding the active pane. When set to 0, the active pane doesn't have any border. The border is drawn inset.
50- Setting: `border_size`
51- Default: `0.0`
52
53**Options**
54
55Non-negative `float` values
56
57### Inactive Opacity
58
59- Description: Opacity of inactive panels. When set to 1.0, the inactive panes have the same opacity as the active one. If set to 0, the inactive panes content will not be visible at all. Values are clamped to the [0.0, 1.0] range.
60- Setting: `inactive_opacity`
61- Default: `1.0`
62
63**Options**
64
65`float` values
66
67## Bottom Dock Layout
68
69- Description: Control the layout of the bottom dock, relative to the left and right docks.
70- Setting: `bottom_dock_layout`
71- Default: `"contained"`
72
73**Options**
74
751. Contain the bottom dock, giving the full height of the window to the left and right docks.
76
77```json
78{
79 "bottom_dock_layout": "contained"
80}
81```
82
832. Give the bottom dock the full width of the window, truncating the left and right docks.
84
85```json
86{
87 "bottom_dock_layout": "full"
88}
89```
90
913. Left align the bottom dock, truncating the left dock and giving the right dock the full height of the window.
92
93```json
94{
95 "bottom_dock_layout": "left_aligned"
96}
97```
98
994. Right align the bottom dock, giving the left dock the full height of the window and truncating the right dock.
100
101```json
102{
103 "bottom_dock_layout": "right_aligned"
104}
105```
106
107## Agent Font Size
108
109- Description: The font size for text in the agent panel. Inherits the UI font size if unset.
110- Setting: `agent_font_size`
111- Default: `null`
112
113**Options**
114
115`integer` values from `6` to `100` pixels (inclusive)
116
117## Allow Rewrap
118
119- Description: Controls where the {#action editor::Rewrap} action is allowed in the current language scope
120- Setting: `allow_rewrap`
121- Default: `"in_comments"`
122
123**Options**
124
1251. Allow rewrap in comments only:
126
127```json
128{
129 "allow_rewrap": "in_comments"
130}
131```
132
1332. Allow rewrap everywhere:
134
135```json
136{
137 "allow_rewrap": "everywhere"
138}
139```
140
1413. Never allow rewrap:
142
143```json
144{
145 "allow_rewrap": "never"
146}
147```
148
149Note: This setting has no effect in Vim mode, as rewrap is already allowed everywhere.
150
151## Auto Indent
152
153- Description: Whether indentation should be adjusted based on the context whilst typing. This can be specified on a per-language basis.
154- Setting: `auto_indent`
155- Default: `true`
156
157**Options**
158
159`boolean` values
160
161## Auto Indent On Paste
162
163- Description: Whether indentation of pasted content should be adjusted based on the context
164- Setting: `auto_indent_on_paste`
165- Default: `true`
166
167**Options**
168
169`boolean` values
170
171## Auto Install extensions
172
173- Description: Define extensions to be autoinstalled or never be installed.
174- Setting: `auto_install_extension`
175- Default: `{ "html": true }`
176
177**Options**
178
179You can find the names of your currently installed extensions by listing the subfolders under the [extension installation location](./extensions/installing-extensions.md#installation-location):
180
181On macOS:
182
183```sh
184ls ~/Library/Application\ Support/Zed/extensions/installed/
185```
186
187On Linux:
188
189```sh
190ls ~/.local/share/zed/extensions/installed
191```
192
193Define extensions which should be installed (`true`) or never installed (`false`).
194
195```json
196{
197 "auto_install_extensions": {
198 "html": true,
199 "dockerfile": true,
200 "docker-compose": false
201 }
202}
203```
204
205## Autosave
206
207- Description: When to automatically save edited buffers.
208- Setting: `autosave`
209- Default: `off`
210
211**Options**
212
2131. To disable autosave, set it to `off`:
214
215```json
216{
217 "autosave": "off"
218}
219```
220
2212. To autosave when focus changes, use `on_focus_change`:
222
223```json
224{
225 "autosave": "on_focus_change"
226}
227```
228
2293. To autosave when the active window changes, use `on_window_change`:
230
231```json
232{
233 "autosave": "on_window_change"
234}
235```
236
2374. To autosave after an inactivity period, use `after_delay`:
238
239```json
240{
241 "autosave": {
242 "after_delay": {
243 "milliseconds": 1000
244 }
245 }
246}
247```
248
249Note that a save will be triggered when an unsaved tab is closed, even if this is earlier than the configured inactivity period.
250
251## Autoscroll on Clicks
252
253- Description: Whether to scroll when clicking near the edge of the visible text area.
254- Setting: `autoscroll_on_clicks`
255- Default: `false`
256
257**Options**
258
259`boolean` values
260
261## Auto Signature Help
262
263- Description: Show method signatures in the editor, when inside parentheses
264- Setting: `auto_signature_help`
265- Default: `false`
266
267**Options**
268
269`boolean` values
270
271### Show Signature Help After Edits
272
273- Description: Whether to show the signature help after completion or a bracket pair inserted. If `auto_signature_help` is enabled, this setting will be treated as enabled also.
274- Setting: `show_signature_help_after_edits`
275- Default: `false`
276
277**Options**
278
279`boolean` values
280
281## Auto Update
282
283- Description: Whether or not to automatically check for updates.
284- Setting: `auto_update`
285- Default: `true`
286
287**Options**
288
289`boolean` values
290
291## Base Keymap
292
293- Description: Base key bindings scheme. Base keymaps can be overridden with user keymaps.
294- Setting: `base_keymap`
295- Default: `VSCode`
296
297**Options**
298
2991. VS Code
300
301```json
302{
303 "base_keymap": "VSCode"
304}
305```
306
3072. Atom
308
309```json
310{
311 "base_keymap": "Atom"
312}
313```
314
3153. JetBrains
316
317```json
318{
319 "base_keymap": "JetBrains"
320}
321```
322
3234. None
324
325```json
326{
327 "base_keymap": "None"
328}
329```
330
3315. Sublime Text
332
333```json
334{
335 "base_keymap": "SublimeText"
336}
337```
338
3396. TextMate
340
341```json
342{
343 "base_keymap": "TextMate"
344}
345```
346
347## Buffer Font Family
348
349- Description: The name of a font to use for rendering text in the editor.
350- Setting: `buffer_font_family`
351- Default: `.ZedMono`. This currently aliases to [Lilex](https://lilex.myrt.co).
352
353**Options**
354
355The name of any font family installed on the user's system, or `".ZedMono"`.
356
357## Buffer Font Features
358
359- Description: The OpenType features to enable for text in the editor.
360- Setting: `buffer_font_features`
361- Default: `null`
362- Platform: macOS and Windows.
363
364**Options**
365
366Zed supports all OpenType features that can be enabled or disabled for a given buffer or terminal font, as well as setting values for font features.
367
368For example, to disable font ligatures, add the following to your settings:
369
370```json
371{
372 "buffer_font_features": {
373 "calt": false
374 }
375}
376```
377
378You can also set other OpenType features, like setting `cv01` to `7`:
379
380```json
381{
382 "buffer_font_features": {
383 "cv01": 7
384 }
385}
386```
387
388## Buffer Font Fallbacks
389
390- Description: Set the buffer text's font fallbacks, this will be merged with the platform's default fallbacks.
391- Setting: `buffer_font_fallbacks`
392- Default: `null`
393- Platform: macOS and Windows.
394
395**Options**
396
397For example, to use `Nerd Font` as a fallback, add the following to your settings:
398
399```json
400{
401 "buffer_font_fallbacks": ["Nerd Font"]
402}
403```
404
405## Buffer Font Size
406
407- Description: The default font size for text in the editor.
408- Setting: `buffer_font_size`
409- Default: `15`
410
411**Options**
412
413`integer` values from `6` to `100` pixels (inclusive)
414
415## Buffer Font Weight
416
417- Description: The default font weight for text in the editor.
418- Setting: `buffer_font_weight`
419- Default: `400`
420
421**Options**
422
423`integer` values between `100` and `900`
424
425## Buffer Line Height
426
427- Description: The default line height for text in the editor.
428- Setting: `buffer_line_height`
429- Default: `"comfortable"`
430
431**Options**
432
433`"standard"`, `"comfortable"` or `{ "custom": float }` (`1` is compact, `2` is loose)
434
435## Centered Layout
436
437- Description: Configuration for the centered layout mode.
438- Setting: `centered_layout`
439- Default:
440
441```json
442"centered_layout": {
443 "left_padding": 0.2,
444 "right_padding": 0.2,
445}
446```
447
448**Options**
449
450The `left_padding` and `right_padding` options define the relative width of the
451left and right padding of the central pane from the workspace when the centered layout mode is activated. Valid values range is from `0` to `0.4`.
452
453## Close on File Delete
454
455- Description: Whether to automatically close editor tabs when their corresponding files are deleted from disk.
456- Setting: `close_on_file_delete`
457- Default: `false`
458
459**Options**
460
461`boolean` values
462
463When enabled, this setting will automatically close tabs for files that have been deleted from the file system. This is particularly useful for workflows involving temporary or scratch files that are frequently created and deleted. When disabled (default), deleted files remain open with a strikethrough through their tab title.
464
465Note: Dirty files (files with unsaved changes) will not be automatically closed even when this setting is enabled, ensuring you don't lose unsaved work.
466
467## Confirm Quit
468
469- Description: Whether or not to prompt the user to confirm before closing the application.
470- Setting: `confirm_quit`
471- Default: `false`
472
473**Options**
474
475`boolean` values
476
477## Diagnostics Max Severity
478
479- Description: Which level to use to filter out diagnostics displayed in the editor
480- Setting: `diagnostics_max_severity`
481- Default: `null`
482
483**Options**
484
4851. Allow all diagnostics (default):
486
487```json
488{
489 "diagnostics_max_severity": null
490}
491```
492
4932. Show only errors:
494
495```json
496{
497 "diagnostics_max_severity": "error"
498}
499```
500
5013. Show errors and warnings:
502
503```json
504{
505 "diagnostics_max_severity": "warning"
506}
507```
508
5094. Show errors, warnings, and information:
510
511```json
512{
513 "diagnostics_max_severity": "information"
514}
515```
516
5175. Show all including hints:
518
519```json
520{
521 "diagnostics_max_severity": "hint"
522}
523```
524
525## Disable AI
526
527- Description: Whether to disable all AI features in Zed
528- Setting: `disable_ai`
529- Default: `false`
530
531**Options**
532
533`boolean` values
534
535## Direnv Integration
536
537- Description: Settings for [direnv](https://direnv.net/) integration. Requires `direnv` to be installed.
538 `direnv` integration make it possible to use the environment variables set by a `direnv` configuration to detect some language servers in `$PATH` instead of installing them.
539 It also allows for those environment variables to be used in tasks.
540- Setting: `load_direnv`
541- Default: `"direct"`
542
543**Options**
544
545There are two options to choose from:
546
5471. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
5482. `direct`: Use `direnv export json` to load direnv. This will load direnv directly without relying on the shell hook and might cause some inconsistencies. This allows direnv to work with any shell.
549
550## Double Click In Multibuffer
551
552- Description: What to do when multibuffer is double clicked in some of its excerpts (parts of singleton buffers)
553- Setting: `double_click_in_multibuffer`
554- Default: `"select"`
555
556**Options**
557
5581. Behave as a regular buffer and select the whole word (default):
559
560```json
561{
562 "double_click_in_multibuffer": "select"
563}
564```
565
5662. Open the excerpt clicked as a new buffer in the new tab:
567
568```json
569{
570 "double_click_in_multibuffer": "open"
571}
572```
573
574For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
575
576## Drop Target Size
577
578- Description: Relative size of the drop target in the editor that will open dropped file as a split pane (0-0.5). For example, 0.25 means if you drop onto the top/bottom quarter of the pane a new vertical split will be used, if you drop onto the left/right quarter of the pane a new horizontal split will be used.
579- Setting: `drop_target_size`
580- Default: `0.2`
581
582**Options**
583
584`float` values between `0` and `0.5`
585
586## Edit Predictions
587
588- Description: Settings for edit predictions.
589- Setting: `edit_predictions`
590- Default:
591
592```json
593 "edit_predictions": {
594 "disabled_globs": [
595 "**/.env*",
596 "**/*.pem",
597 "**/*.key",
598 "**/*.cert",
599 "**/*.crt",
600 "**/.dev.vars",
601 "**/secrets.yml"
602 ]
603 }
604```
605
606**Options**
607
608### Disabled Globs
609
610- Description: A list of globs for which edit predictions should be disabled for. This list adds to a pre-existing, sensible default set of globs. Any additional ones you add are combined with them.
611- Setting: `disabled_globs`
612- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/.dev.vars", "**/secrets.yml"]`
613
614**Options**
615
616List of `string` values.
617
618## Edit Predictions Disabled in
619
620- Description: A list of language scopes in which edit predictions should be disabled.
621- Setting: `edit_predictions_disabled_in`
622- Default: `[]`
623
624**Options**
625
626List of `string` values
627
6281. Don't show edit predictions in comments:
629
630```json
631"disabled_in": ["comment"]
632```
633
6342. Don't show edit predictions in strings and comments:
635
636```json
637"disabled_in": ["comment", "string"]
638```
639
6403. Only in Go, don't show edit predictions in strings and comments:
641
642```json
643{
644 "languages": {
645 "Go": {
646 "edit_predictions_disabled_in": ["comment", "string"]
647 }
648 }
649}
650```
651
652## Current Line Highlight
653
654- Description: How to highlight the current line in the editor.
655- Setting: `current_line_highlight`
656- Default: `all`
657
658**Options**
659
6601. Don't highlight the current line:
661
662```json
663"current_line_highlight": "none"
664```
665
6662. Highlight the gutter area:
667
668```json
669"current_line_highlight": "gutter"
670```
671
6723. Highlight the editor area:
673
674```json
675"current_line_highlight": "line"
676```
677
6784. Highlight the full line:
679
680```json
681"current_line_highlight": "all"
682```
683
684## Selection Highlight
685
686- Description: Whether to highlight all occurrences of the selected text in an editor.
687- Setting: `selection_highlight`
688- Default: `true`
689
690## Rounded Selection
691
692- Description: Whether the text selection should have rounded corners.
693- Setting: `rounded_selection`
694- Default: `true`
695
696## Cursor Blink
697
698- Description: Whether or not the cursor blinks.
699- Setting: `cursor_blink`
700- Default: `true`
701
702**Options**
703
704`boolean` values
705
706## Cursor Shape
707
708- Description: Cursor shape for the default editor.
709- Setting: `cursor_shape`
710- Default: `bar`
711
712**Options**
713
7141. A vertical bar:
715
716```json
717"cursor_shape": "bar"
718```
719
7202. A block that surrounds the following character:
721
722```json
723"cursor_shape": "block"
724```
725
7263. An underline / underscore that runs along the following character:
727
728```json
729"cursor_shape": "underline"
730```
731
7324. An box drawn around the following character:
733
734```json
735"cursor_shape": "hollow"
736```
737
738## Gutter
739
740- Description: Settings for the editor gutter
741- Setting: `gutter`
742- Default:
743
744```json
745{
746 "gutter": {
747 "line_numbers": true,
748 "runnables": true,
749 "breakpoints": true,
750 "folds": true,
751 "min_line_number_digits": 4
752 }
753}
754```
755
756**Options**
757
758- `line_numbers`: Whether to show line numbers in the gutter
759- `runnables`: Whether to show runnable buttons in the gutter
760- `breakpoints`: Whether to show breakpoints in the gutter
761- `folds`: Whether to show fold buttons in the gutter
762- `min_line_number_digits`: Minimum number of characters to reserve space for in the gutter
763
764## Hide Mouse
765
766- Description: Determines when the mouse cursor should be hidden in an editor or input box.
767- Setting: `hide_mouse`
768- Default: `on_typing_and_movement`
769
770**Options**
771
7721. Never hide the mouse cursor:
773
774```json
775"hide_mouse": "never"
776```
777
7782. Hide only when typing:
779
780```json
781"hide_mouse": "on_typing"
782```
783
7843. Hide on both typing and cursor movement:
785
786```json
787"hide_mouse": "on_typing_and_movement"
788```
789
790## Snippet Sort Order
791
792- Description: Determines how snippets are sorted relative to other completion items.
793- Setting: `snippet_sort_order`
794- Default: `inline`
795
796**Options**
797
7981. Place snippets at the top of the completion list:
799
800```json
801"snippet_sort_order": "top"
802```
803
8042. Place snippets normally without any preference:
805
806```json
807"snippet_sort_order": "inline"
808```
809
8103. Place snippets at the bottom of the completion list:
811
812```json
813"snippet_sort_order": "bottom"
814```
815
8164. Do not show snippets in the completion list at all:
817
818```json
819"snippet_sort_order": "none"
820```
821
822## Editor Scrollbar
823
824- Description: Whether or not to show the editor scrollbar and various elements in it.
825- Setting: `scrollbar`
826- Default:
827
828```json
829"scrollbar": {
830 "show": "auto",
831 "cursors": true,
832 "git_diff": true,
833 "search_results": true,
834 "selected_text": true,
835 "selected_symbol": true,
836 "diagnostics": "all",
837 "axes": {
838 "horizontal": true,
839 "vertical": true,
840 },
841},
842```
843
844### Show Mode
845
846- Description: When to show the editor scrollbar.
847- Setting: `show`
848- Default: `auto`
849
850**Options**
851
8521. Show the scrollbar if there's important information or follow the system's configured behavior:
853
854```json
855"scrollbar": {
856 "show": "auto"
857}
858```
859
8602. Match the system's configured behavior:
861
862```json
863"scrollbar": {
864 "show": "system"
865}
866```
867
8683. Always show the scrollbar:
869
870```json
871"scrollbar": {
872 "show": "always"
873}
874```
875
8764. Never show the scrollbar:
877
878```json
879"scrollbar": {
880 "show": "never"
881}
882```
883
884### Cursor Indicators
885
886- Description: Whether to show cursor positions in the scrollbar.
887- Setting: `cursors`
888- Default: `true`
889
890**Options**
891
892`boolean` values
893
894### Git Diff Indicators
895
896- Description: Whether to show git diff indicators in the scrollbar.
897- Setting: `git_diff`
898- Default: `true`
899
900**Options**
901
902`boolean` values
903
904### Search Results Indicators
905
906- Description: Whether to show buffer search results in the scrollbar.
907- Setting: `search_results`
908- Default: `true`
909
910**Options**
911
912`boolean` values
913
914### Selected Text Indicators
915
916- Description: Whether to show selected text occurrences in the scrollbar.
917- Setting: `selected_text`
918- Default: `true`
919
920**Options**
921
922`boolean` values
923
924### Selected Symbols Indicators
925
926- Description: Whether to show selected symbol occurrences in the scrollbar.
927- Setting: `selected_symbol`
928- Default: `true`
929
930**Options**
931
932`boolean` values
933
934### Diagnostics
935
936- Description: Which diagnostic indicators to show in the scrollbar.
937- Setting: `diagnostics`
938- Default: `all`
939
940**Options**
941
9421. Show all diagnostics:
943
944```json
945{
946 "diagnostics": "all"
947}
948```
949
9502. Do not show any diagnostics:
951
952```json
953{
954 "diagnostics": "none"
955}
956```
957
9583. Show only errors:
959
960```json
961{
962 "diagnostics": "error"
963}
964```
965
9664. Show only errors and warnings:
967
968```json
969{
970 "diagnostics": "warning"
971}
972```
973
9745. Show only errors, warnings, and information:
975
976```json
977{
978 "diagnostics": "information"
979}
980```
981
982### Axes
983
984- Description: Forcefully enable or disable the scrollbar for each axis
985- Setting: `axes`
986- Default:
987
988```json
989"scrollbar": {
990 "axes": {
991 "horizontal": true,
992 "vertical": true,
993 },
994}
995```
996
997#### Horizontal
998
999- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
1000- Setting: `horizontal`
1001- Default: `true`
1002
1003**Options**
1004
1005`boolean` values
1006
1007#### Vertical
1008
1009- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
1010- Setting: `vertical`
1011- Default: `true`
1012
1013**Options**
1014
1015`boolean` values
1016
1017## Minimap
1018
1019- Description: Settings related to the editor's minimap, which provides an overview of your document.
1020- Setting: `minimap`
1021- Default:
1022
1023```json
1024{
1025 "minimap": {
1026 "show": "never",
1027 "thumb": "always",
1028 "thumb_border": "left_open",
1029 "current_line_highlight": null
1030 }
1031}
1032```
1033
1034### Show Mode
1035
1036- Description: When to show the minimap in the editor.
1037- Setting: `show`
1038- Default: `never`
1039
1040**Options**
1041
10421. Always show the minimap:
1043
1044```json
1045{
1046 "show": "always"
1047}
1048```
1049
10502. Show the minimap if the editor's scrollbars are visible:
1051
1052```json
1053{
1054 "show": "auto"
1055}
1056```
1057
10583. Never show the minimap:
1059
1060```json
1061{
1062 "show": "never"
1063}
1064```
1065
1066### Thumb Display
1067
1068- Description: When to show the minimap thumb (the visible editor area) in the minimap.
1069- Setting: `thumb`
1070- Default: `always`
1071
1072**Options**
1073
10741. Show the minimap thumb when hovering over the minimap:
1075
1076```json
1077{
1078 "thumb": "hover"
1079}
1080```
1081
10822. Always show the minimap thumb:
1083
1084```json
1085{
1086 "thumb": "always"
1087}
1088```
1089
1090### Thumb Border
1091
1092- Description: How the minimap thumb border should look.
1093- Setting: `thumb_border`
1094- Default: `left_open`
1095
1096**Options**
1097
10981. Display a border on all sides of the thumb:
1099
1100```json
1101{
1102 "thumb_border": "full"
1103}
1104```
1105
11062. Display a border on all sides except the left side:
1107
1108```json
1109{
1110 "thumb_border": "left_open"
1111}
1112```
1113
11143. Display a border on all sides except the right side:
1115
1116```json
1117{
1118 "thumb_border": "right_open"
1119}
1120```
1121
11224. Display a border only on the left side:
1123
1124```json
1125{
1126 "thumb_border": "left_only"
1127}
1128```
1129
11305. Display the thumb without any border:
1131
1132```json
1133{
1134 "thumb_border": "none"
1135}
1136```
1137
1138### Current Line Highlight
1139
1140- Description: How to highlight the current line in the minimap.
1141- Setting: `current_line_highlight`
1142- Default: `null`
1143
1144**Options**
1145
11461. Inherit the editor's current line highlight setting:
1147
1148```json
1149{
1150 "minimap": {
1151 "current_line_highlight": null
1152 }
1153}
1154```
1155
11562. Highlight the current line in the minimap:
1157
1158```json
1159{
1160 "minimap": {
1161 "current_line_highlight": "line"
1162 }
1163}
1164```
1165
1166or
1167
1168```json
1169{
1170 "minimap": {
1171 "current_line_highlight": "all"
1172 }
1173}
1174```
1175
11763. Do not highlight the current line in the minimap:
1177
1178```json
1179{
1180 "minimap": {
1181 "current_line_highlight": "gutter"
1182 }
1183}
1184```
1185
1186or
1187
1188```json
1189{
1190 "minimap": {
1191 "current_line_highlight": "none"
1192 }
1193}
1194```
1195
1196## Editor Tab Bar
1197
1198- Description: Settings related to the editor's tab bar.
1199- Settings: `tab_bar`
1200- Default:
1201
1202```json
1203"tab_bar": {
1204 "show": true,
1205 "show_nav_history_buttons": true,
1206 "show_tab_bar_buttons": true
1207}
1208```
1209
1210### Show
1211
1212- Description: Whether or not to show the tab bar in the editor.
1213- Setting: `show`
1214- Default: `true`
1215
1216**Options**
1217
1218`boolean` values
1219
1220### Navigation History Buttons
1221
1222- Description: Whether or not to show the navigation history buttons.
1223- Setting: `show_nav_history_buttons`
1224- Default: `true`
1225
1226**Options**
1227
1228`boolean` values
1229
1230### Tab Bar Buttons
1231
1232- Description: Whether or not to show the tab bar buttons.
1233- Setting: `show_tab_bar_buttons`
1234- Default: `true`
1235
1236**Options**
1237
1238`boolean` values
1239
1240## Editor Tabs
1241
1242- Description: Configuration for the editor tabs.
1243- Setting: `tabs`
1244- Default:
1245
1246```json
1247"tabs": {
1248 "close_position": "right",
1249 "file_icons": false,
1250 "git_status": false,
1251 "activate_on_close": "history",
1252 "show_close_button": "hover",
1253 "show_diagnostics": "off"
1254},
1255```
1256
1257### Close Position
1258
1259- Description: Where to display close button within a tab.
1260- Setting: `close_position`
1261- Default: `right`
1262
1263**Options**
1264
12651. Display the close button on the right:
1266
1267```json
1268{
1269 "close_position": "right"
1270}
1271```
1272
12732. Display the close button on the left:
1274
1275```json
1276{
1277 "close_position": "left"
1278}
1279```
1280
1281### File Icons
1282
1283- Description: Whether to show the file icon for a tab.
1284- Setting: `file_icons`
1285- Default: `false`
1286
1287### Git Status
1288
1289- Description: Whether or not to show Git file status in tab.
1290- Setting: `git_status`
1291- Default: `false`
1292
1293### Activate on close
1294
1295- Description: What to do after closing the current tab.
1296- Setting: `activate_on_close`
1297- Default: `history`
1298
1299**Options**
1300
13011. Activate the tab that was open previously:
1302
1303```json
1304{
1305 "activate_on_close": "history"
1306}
1307```
1308
13092. Activate the right neighbour tab if present:
1310
1311```json
1312{
1313 "activate_on_close": "neighbour"
1314}
1315```
1316
13173. Activate the left neighbour tab if present:
1318
1319```json
1320{
1321 "activate_on_close": "left_neighbour"
1322}
1323```
1324
1325### Show close button
1326
1327- Description: Controls the appearance behavior of the tab's close button.
1328- Setting: `show_close_button`
1329- Default: `hover`
1330
1331**Options**
1332
13331. Show it just upon hovering the tab:
1334
1335```json
1336{
1337 "show_close_button": "hover"
1338}
1339```
1340
13412. Show it persistently:
1342
1343```json
1344{
1345 "show_close_button": "always"
1346}
1347```
1348
13493. Never show it, even if hovering it:
1350
1351```json
1352{
1353 "show_close_button": "hidden"
1354}
1355```
1356
1357### Show Diagnostics
1358
1359- Description: Whether to show diagnostics indicators in tabs. This setting only works when file icons are active and controls which files with diagnostic issues to mark.
1360- Setting: `show_diagnostics`
1361- Default: `off`
1362
1363**Options**
1364
13651. Do not mark any files:
1366
1367```json
1368{
1369 "show_diagnostics": "off"
1370}
1371```
1372
13732. Only mark files with errors:
1374
1375```json
1376{
1377 "show_diagnostics": "errors"
1378}
1379```
1380
13813. Mark files with errors and warnings:
1382
1383```json
1384{
1385 "show_diagnostics": "all"
1386}
1387```
1388
1389### Show Inline Code Actions
1390
1391- Description: Whether to show code action button at start of buffer line.
1392- Setting: `inline_code_actions`
1393- Default: `true`
1394
1395**Options**
1396
1397`boolean` values
1398
1399### Drag And Drop Selection
1400
1401- Description: Whether to allow drag and drop text selection in buffer. `delay` is the milliseconds that must elapse before drag and drop is allowed. Otherwise, a new text selection is created.
1402- Setting: `drag_and_drop_selection`
1403- Default:
1404
1405```json
1406"drag_and_drop_selection": {
1407 "enabled": true,
1408 "delay": 300
1409}
1410```
1411
1412## Editor Toolbar
1413
1414- Description: Whether or not to show various elements in the editor toolbar.
1415- Setting: `toolbar`
1416- Default:
1417
1418```json
1419"toolbar": {
1420 "breadcrumbs": true,
1421 "quick_actions": true,
1422 "selections_menu": true,
1423 "agent_review": true,
1424 "code_actions": false
1425},
1426```
1427
1428**Options**
1429
1430Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
1431
1432## Use System Tabs
1433
1434- Description: Whether to allow windows to tab together based on the user’s tabbing preference (macOS only).
1435- Setting: `use_system_window_tabs`
1436- Default: `false`
1437
1438**Options**
1439
1440This setting enables integration with macOS’s native window tabbing feature. When set to `true`, Zed windows can be grouped together as tabs in a single macOS window, following the system-wide tabbing preferences set by the user (such as "Always", "In Full Screen", or "Never"). This setting is only available on macOS.
1441
1442## Enable Language Server
1443
1444- Description: Whether or not to use language servers to provide code intelligence.
1445- Setting: `enable_language_server`
1446- Default: `true`
1447
1448**Options**
1449
1450`boolean` values
1451
1452## Ensure Final Newline On Save
1453
1454- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
1455- Setting: `ensure_final_newline_on_save`
1456- Default: `true`
1457
1458**Options**
1459
1460`boolean` values
1461
1462## Expand Excerpt Lines
1463
1464- Description: The default number of lines to expand excerpts in the multibuffer by
1465- Setting: `expand_excerpt_lines`
1466- Default: `5`
1467
1468**Options**
1469
1470Positive `integer` values
1471
1472## Excerpt Context Lines
1473
1474- Description: The number of lines of context to provide when showing excerpts in the multibuffer.
1475- Setting: `excerpt_context_lines`
1476- Default: `2`
1477
1478**Options**
1479
1480Positive `integer` value between 1 and 32. Values outside of this range will be clamped to this range.
1481
1482## Extend Comment On Newline
1483
1484- Description: Whether to start a new line with a comment when a previous line is a comment as well.
1485- Setting: `extend_comment_on_newline`
1486- Default: `true`
1487
1488**Options**
1489
1490`boolean` values
1491
1492## Status Bar
1493
1494- Description: Control various elements in the status bar. Note that some items in the status bar have their own settings set elsewhere.
1495- Setting: `status_bar`
1496- Default:
1497
1498```json
1499"status_bar": {
1500 "active_language_button": true,
1501 "cursor_position_button": true
1502},
1503```
1504
1505## LSP
1506
1507- Description: Configuration for language servers.
1508- Setting: `lsp`
1509- Default: `null`
1510
1511**Options**
1512
1513The following settings can be overridden for specific language servers:
1514
1515- `initialization_options`
1516- `settings`
1517
1518To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1519
1520Some options are passed via `initialization_options` to the language server. These are for options which must be specified at language server startup and when changed will require restarting the language server.
1521
1522For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1523
1524```json
1525"lsp": {
1526 "rust-analyzer": {
1527 "initialization_options": {
1528 "check": {
1529 "command": "clippy" // rust-analyzer.check.command (default: "check")
1530 }
1531 }
1532 }
1533}
1534```
1535
1536While other options may be changed at a runtime and should be placed under `settings`:
1537
1538```json
1539"lsp": {
1540 "yaml-language-server": {
1541 "settings": {
1542 "yaml": {
1543 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1544 }
1545 }
1546 }
1547}
1548```
1549
1550## Global LSP Settings
1551
1552- Description: Configuration for global LSP settings that apply to all language servers
1553- Setting: `global_lsp_settings`
1554- Default:
1555
1556```json
1557{
1558 "global_lsp_settings": {
1559 "button": true
1560 }
1561}
1562```
1563
1564**Options**
1565
1566- `button`: Whether to show the LSP status button in the status bar
1567
1568## LSP Highlight Debounce
1569
1570- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1571- Setting: `lsp_highlight_debounce`
1572- Default: `75`
1573
1574## Features
1575
1576- Description: Features that can be globally enabled or disabled
1577- Setting: `features`
1578- Default:
1579
1580```json
1581{
1582 "features": {
1583 "edit_prediction_provider": "zed"
1584 }
1585}
1586```
1587
1588### Edit Prediction Provider
1589
1590- Description: Which edit prediction provider to use
1591- Setting: `edit_prediction_provider`
1592- Default: `"zed"`
1593
1594**Options**
1595
15961. Use Zeta as the edit prediction provider:
1597
1598```json
1599{
1600 "features": {
1601 "edit_prediction_provider": "zed"
1602 }
1603}
1604```
1605
16062. Use Copilot as the edit prediction provider:
1607
1608```json
1609{
1610 "features": {
1611 "edit_prediction_provider": "copilot"
1612 }
1613}
1614```
1615
16163. Use Supermaven as the edit prediction provider:
1617
1618```json
1619{
1620 "features": {
1621 "edit_prediction_provider": "supermaven"
1622 }
1623}
1624```
1625
16264. Turn off edit predictions across all providers
1627
1628```json
1629{
1630 "features": {
1631 "edit_prediction_provider": "none"
1632 }
1633}
1634```
1635
1636## Format On Save
1637
1638- Description: Whether or not to perform a buffer format before saving.
1639- Setting: `format_on_save`
1640- Default: `on`
1641
1642**Options**
1643
16441. `on`, enables format on save obeying `formatter` setting:
1645
1646```json
1647{
1648 "format_on_save": "on"
1649}
1650```
1651
16522. `off`, disables format on save:
1653
1654```json
1655{
1656 "format_on_save": "off"
1657}
1658```
1659
1660## Formatter
1661
1662- Description: How to perform a buffer format.
1663- Setting: `formatter`
1664- Default: `auto`
1665
1666**Options**
1667
16681. To use the current language server, use `"language_server"`:
1669
1670```json
1671{
1672 "formatter": "language_server"
1673}
1674```
1675
16762. Or to use an external command, use `"external"`. Specify the name of the formatting program to run, and an array of arguments to pass to the program. The buffer's text will be passed to the program on stdin, and the formatted output should be written to stdout. For example, the following command would strip trailing spaces using [`sed(1)`](https://linux.die.net/man/1/sed):
1677
1678```json
1679{
1680 "formatter": {
1681 "external": {
1682 "command": "sed",
1683 "arguments": ["-e", "s/ *$//"]
1684 }
1685 }
1686}
1687```
1688
16893. External formatters may optionally include a `{buffer_path}` placeholder which at runtime will include the path of the buffer being formatted. Formatters operate by receiving file content via standard input, reformatting it and then outputting it to standard output and so normally don't know the filename of what they are formatting. Tools like Prettier support receiving the file path via a command line argument which can then used to impact formatting decisions.
1690
1691WARNING: `{buffer_path}` should not be used to direct your formatter to read from a filename. Your formatter should only read from standard input and should not read or write files directly.
1692
1693```json
1694 "formatter": {
1695 "external": {
1696 "command": "prettier",
1697 "arguments": ["--stdin-filepath", "{buffer_path}"]
1698 }
1699 }
1700```
1701
17024. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1703
1704```json
1705{
1706 "formatter": {
1707 "code_actions": {
1708 // Use ESLint's --fix:
1709 "source.fixAll.eslint": true,
1710 // Organize imports on save:
1711 "source.organizeImports": true
1712 }
1713 }
1714}
1715```
1716
17175. Or to use multiple formatters consecutively, use an array of formatters:
1718
1719```json
1720{
1721 "formatter": [
1722 { "language_server": { "name": "rust-analyzer" } },
1723 {
1724 "external": {
1725 "command": "sed",
1726 "arguments": ["-e", "s/ *$//"]
1727 }
1728 }
1729 ]
1730}
1731```
1732
1733Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1734If any of the formatters fails, the subsequent ones will still be executed.
1735
1736## Code Actions On Format
1737
1738- Description: The code actions to perform with the primary language server when formatting the buffer.
1739- Setting: `code_actions_on_format`
1740- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
1741
1742**Examples**
1743
1744<!--
1745TBD: Add Python Ruff source.organizeImports example
1746-->
1747
17481. Organize imports on format in TypeScript and TSX buffers:
1749
1750```json
1751{
1752 "languages": {
1753 "TypeScript": {
1754 "code_actions_on_format": {
1755 "source.organizeImports": true
1756 }
1757 },
1758 "TSX": {
1759 "code_actions_on_format": {
1760 "source.organizeImports": true
1761 }
1762 }
1763 }
1764}
1765```
1766
17672. Run ESLint `fixAll` code action when formatting:
1768
1769```json
1770{
1771 "languages": {
1772 "JavaScript": {
1773 "code_actions_on_format": {
1774 "source.fixAll.eslint": true
1775 }
1776 }
1777 }
1778}
1779```
1780
17813. Run only a single ESLint rule when using `fixAll`:
1782
1783```json
1784{
1785 "languages": {
1786 "JavaScript": {
1787 "code_actions_on_format": {
1788 "source.fixAll.eslint": true
1789 }
1790 }
1791 },
1792 "lsp": {
1793 "eslint": {
1794 "settings": {
1795 "codeActionOnSave": {
1796 "rules": ["import/order"]
1797 }
1798 }
1799 }
1800 }
1801}
1802```
1803
1804## Auto close
1805
1806- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1807- Setting: `use_autoclose`
1808- Default: `true`
1809
1810**Options**
1811
1812`boolean` values
1813
1814## Always Treat Brackets As Autoclosed
1815
1816- Description: Controls how the editor handles the autoclosed characters.
1817- Setting: `always_treat_brackets_as_autoclosed`
1818- Default: `false`
1819
1820**Options**
1821
1822`boolean` values
1823
1824**Example**
1825
1826If the setting is set to `true`:
1827
18281. Enter in the editor: `)))`
18292. Move the cursor to the start: `^)))`
18303. Enter again: `)))`
1831
1832The result is still `)))` and not `))))))`, which is what it would be by default.
1833
1834## File Scan Exclusions
1835
1836- Setting: `file_scan_exclusions`
1837- Description: Files or globs of files that will be excluded by Zed entirely. They will be skipped during file scans, file searches, and not be displayed in the project file tree. Overrides `file_scan_inclusions`.
1838- Default:
1839
1840```json
1841"file_scan_exclusions": [
1842 "**/.git",
1843 "**/.svn",
1844 "**/.hg",
1845 "**/.jj",
1846 "**/CVS",
1847 "**/.DS_Store",
1848 "**/Thumbs.db",
1849 "**/.classpath",
1850 "**/.settings"
1851],
1852```
1853
1854Note, specifying `file_scan_exclusions` in settings.json will override the defaults (shown above). If you are looking to exclude additional items you will need to include all the default values in your settings.
1855
1856## File Scan Inclusions
1857
1858- Setting: `file_scan_inclusions`
1859- Description: Files or globs of files that will be included by Zed, even when ignored by git. This is useful for files that are not tracked by git, but are still important to your project. Note that globs that are overly broad can slow down Zed's file scanning. `file_scan_exclusions` takes precedence over these inclusions.
1860- Default:
1861
1862```json
1863"file_scan_inclusions": [".env*"],
1864```
1865
1866## File Types
1867
1868- Setting: `file_types`
1869- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1870- Default:
1871
1872```json
1873"file_types": {
1874 "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1875 "Shell Script": [".env.*"]
1876}
1877```
1878
1879**Examples**
1880
1881To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1882
1883```json
1884{
1885 "file_types": {
1886 "C++": ["c"],
1887 "TOML": ["MyLockFile"],
1888 "Dockerfile": ["Dockerfile*"]
1889 }
1890}
1891```
1892
1893## Diagnostics
1894
1895- Description: Configuration for diagnostics-related features.
1896- Setting: `diagnostics`
1897- Default:
1898
1899```json
1900{
1901 "diagnostics": {
1902 "include_warnings": true,
1903 "inline": {
1904 "enabled": false
1905 },
1906 "update_with_cursor": false,
1907 "primary_only": false,
1908 "use_rendered": false
1909 }
1910}
1911```
1912
1913### Inline Diagnostics
1914
1915- Description: Whether or not to show diagnostics information inline.
1916- Setting: `inline`
1917- Default:
1918
1919```json
1920{
1921 "diagnostics": {
1922 "inline": {
1923 "enabled": false,
1924 "update_debounce_ms": 150,
1925 "padding": 4,
1926 "min_column": 0,
1927 "max_severity": null
1928 }
1929 }
1930}
1931```
1932
1933**Options**
1934
19351. Enable inline diagnostics.
1936
1937```json
1938{
1939 "diagnostics": {
1940 "inline": {
1941 "enabled": true
1942 }
1943 }
1944}
1945```
1946
19472. Delay diagnostic updates until some time after the last diagnostic update.
1948
1949```json
1950{
1951 "diagnostics": {
1952 "inline": {
1953 "enabled": true,
1954 "update_debounce_ms": 150
1955 }
1956 }
1957}
1958```
1959
19603. Set padding between the end of the source line and the start of the diagnostic.
1961
1962```json
1963{
1964 "diagnostics": {
1965 "inline": {
1966 "enabled": true,
1967 "padding": 4
1968 }
1969 }
1970}
1971```
1972
19734. Horizontally align inline diagnostics at the given column.
1974
1975```json
1976{
1977 "diagnostics": {
1978 "inline": {
1979 "enabled": true,
1980 "min_column": 80
1981 }
1982 }
1983}
1984```
1985
19865. Show only warning and error diagnostics.
1987
1988```json
1989{
1990 "diagnostics": {
1991 "inline": {
1992 "enabled": true,
1993 "max_severity": "warning"
1994 }
1995 }
1996}
1997```
1998
1999## Git
2000
2001- Description: Configuration for git-related features.
2002- Setting: `git`
2003- Default:
2004
2005```json
2006{
2007 "git": {
2008 "git_gutter": "tracked_files",
2009 "inline_blame": {
2010 "enabled": true
2011 },
2012 "branch_picker": {
2013 "show_author_name": true
2014 },
2015 "hunk_style": "staged_hollow"
2016 }
2017}
2018```
2019
2020### Git Gutter
2021
2022- Description: Whether or not to show the git gutter.
2023- Setting: `git_gutter`
2024- Default: `tracked_files`
2025
2026**Options**
2027
20281. Show git gutter in tracked files
2029
2030```json
2031{
2032 "git": {
2033 "git_gutter": "tracked_files"
2034 }
2035}
2036```
2037
20382. Hide git gutter
2039
2040```json
2041{
2042 "git": {
2043 "git_gutter": "hide"
2044 }
2045}
2046```
2047
2048### Gutter Debounce
2049
2050- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2051- Setting: `gutter_debounce`
2052- Default: `null`
2053
2054**Options**
2055
2056`integer` values representing milliseconds
2057
2058Example:
2059
2060```json
2061{
2062 "git": {
2063 "gutter_debounce": 100
2064 }
2065}
2066```
2067
2068### Inline Git Blame
2069
2070- Description: Whether or not to show git blame information inline, on the currently focused line.
2071- Setting: `inline_blame`
2072- Default:
2073
2074```json
2075{
2076 "git": {
2077 "inline_blame": {
2078 "enabled": true
2079 }
2080 }
2081}
2082```
2083
2084**Options**
2085
20861. Disable inline git blame:
2087
2088```json
2089{
2090 "git": {
2091 "inline_blame": {
2092 "enabled": false
2093 }
2094 }
2095}
2096```
2097
20982. Only show inline git blame after a delay (that starts after cursor stops moving):
2099
2100```json
2101{
2102 "git": {
2103 "inline_blame": {
2104 "delay_ms": 500
2105 }
2106 }
2107}
2108```
2109
21103. Show a commit summary next to the commit date and author:
2111
2112```json
2113{
2114 "git": {
2115 "inline_blame": {
2116 "show_commit_summary": true
2117 }
2118 }
2119}
2120```
2121
21224. Use this as the minimum column at which to display inline blame information:
2123
2124```json
2125{
2126 "git": {
2127 "inline_blame": {
2128 "min_column": 80
2129 }
2130 }
2131}
2132```
2133
21345. Set the padding between the end of the line and the inline blame hint, in ems:
2135
2136```json
2137{
2138 "git": {
2139 "inline_blame": {
2140 "padding": 10
2141 }
2142 }
2143}
2144```
2145
2146### Branch Picker
2147
2148- Description: Configuration related to the branch picker.
2149- Setting: `branch_picker`
2150- Default:
2151
2152```json
2153{
2154 "git": {
2155 "branch_picker": {
2156 "show_author_name": false
2157 }
2158 }
2159}
2160```
2161
2162**Options**
2163
21641. Show the author name in the branch picker:
2165
2166```json
2167{
2168 "git": {
2169 "branch_picker": {
2170 "show_author_name": true
2171 }
2172 }
2173}
2174```
2175
2176### Hunk Style
2177
2178- Description: What styling we should use for the diff hunks.
2179- Setting: `hunk_style`
2180- Default:
2181
2182```json
2183{
2184 "git": {
2185 "hunk_style": "staged_hollow"
2186 }
2187}
2188```
2189
2190**Options**
2191
21921. Show the staged hunks faded out and with a border:
2193
2194```json
2195{
2196 "git": {
2197 "hunk_style": "staged_hollow"
2198 }
2199}
2200```
2201
22022. Show unstaged hunks faded out and with a border:
2203
2204```json
2205{
2206 "git": {
2207 "hunk_style": "unstaged_hollow"
2208 }
2209}
2210```
2211
2212## Go to Definition Fallback
2213
2214- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2215- Setting: `go_to_definition_fallback`
2216- Default: `"find_all_references"`
2217
2218**Options**
2219
22201. Do nothing:
2221
2222```json
2223{
2224 "go_to_definition_fallback": "none"
2225}
2226```
2227
22282. Find references for the same symbol (default):
2229
2230```json
2231{
2232 "go_to_definition_fallback": "find_all_references"
2233}
2234```
2235
2236## Hard Tabs
2237
2238- Description: Whether to indent lines using tab characters or multiple spaces.
2239- Setting: `hard_tabs`
2240- Default: `false`
2241
2242**Options**
2243
2244`boolean` values
2245
2246## Helix Mode
2247
2248- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2249- Setting: `helix_mode`
2250- Default: `false`
2251
2252**Options**
2253
2254`boolean` values
2255
2256## Indent Guides
2257
2258- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2259- Setting: `indent_guides`
2260- Default:
2261
2262```json
2263{
2264 "indent_guides": {
2265 "enabled": true,
2266 "line_width": 1,
2267 "active_line_width": 1,
2268 "coloring": "fixed",
2269 "background_coloring": "disabled"
2270 }
2271}
2272```
2273
2274**Options**
2275
22761. Disable indent guides
2277
2278```json
2279{
2280 "indent_guides": {
2281 "enabled": false
2282 }
2283}
2284```
2285
22862. Enable indent guides for a specific language.
2287
2288```json
2289{
2290 "languages": {
2291 "Python": {
2292 "indent_guides": {
2293 "enabled": true
2294 }
2295 }
2296 }
2297}
2298```
2299
23003. Enable indent aware coloring ("rainbow indentation").
2301 The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
2302
2303```json
2304{
2305 "indent_guides": {
2306 "enabled": true,
2307 "coloring": "indent_aware"
2308 }
2309}
2310```
2311
23124. Enable indent aware background coloring ("rainbow indentation").
2313 The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
2314
2315```json
2316{
2317 "indent_guides": {
2318 "enabled": true,
2319 "coloring": "indent_aware",
2320 "background_coloring": "indent_aware"
2321 }
2322}
2323```
2324
2325## Hover Popover Enabled
2326
2327- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2328- Setting: `hover_popover_enabled`
2329- Default: `true`
2330
2331**Options**
2332
2333`boolean` values
2334
2335## Hover Popover Delay
2336
2337- Description: Time to wait in milliseconds before showing the informational hover box.
2338- Setting: `hover_popover_delay`
2339- Default: `300`
2340
2341**Options**
2342
2343`integer` values representing milliseconds
2344
2345## Icon Theme
2346
2347- Description: The icon theme setting can be specified in two forms - either as the name of an icon theme or as an object containing the `mode`, `dark`, and `light` icon themes for files/folders inside Zed.
2348- Setting: `icon_theme`
2349- Default: `Zed (Default)`
2350
2351### Icon Theme Object
2352
2353- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2354- Setting: `icon_theme`
2355- Default:
2356
2357```json
2358"icon_theme": {
2359 "mode": "system",
2360 "dark": "Zed (Default)",
2361 "light": "Zed (Default)"
2362},
2363```
2364
2365### Mode
2366
2367- Description: Specify the icon theme mode.
2368- Setting: `mode`
2369- Default: `system`
2370
2371**Options**
2372
23731. Set the icon theme to dark mode
2374
2375```json
2376{
2377 "mode": "dark"
2378}
2379```
2380
23812. Set the icon theme to light mode
2382
2383```json
2384{
2385 "mode": "light"
2386}
2387```
2388
23893. Set the icon theme to system mode
2390
2391```json
2392{
2393 "mode": "system"
2394}
2395```
2396
2397### Dark
2398
2399- Description: The name of the dark icon theme.
2400- Setting: `dark`
2401- Default: `Zed (Default)`
2402
2403**Options**
2404
2405Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2406
2407### Light
2408
2409- Description: The name of the light icon theme.
2410- Setting: `light`
2411- Default: `Zed (Default)`
2412
2413**Options**
2414
2415Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2416
2417## Image Viewer
2418
2419- Description: Settings for image viewer functionality
2420- Setting: `image_viewer`
2421- Default:
2422
2423```json
2424{
2425 "image_viewer": {
2426 "unit": "binary"
2427 }
2428}
2429```
2430
2431**Options**
2432
2433### Unit
2434
2435- Description: The unit for image file sizes
2436- Setting: `unit`
2437- Default: `"binary"`
2438
2439**Options**
2440
24411. Use binary units (KiB, MiB):
2442
2443```json
2444{
2445 "image_viewer": {
2446 "unit": "binary"
2447 }
2448}
2449```
2450
24512. Use decimal units (KB, MB):
2452
2453```json
2454{
2455 "image_viewer": {
2456 "unit": "decimal"
2457 }
2458}
2459```
2460
2461## Inlay hints
2462
2463- Description: Configuration for displaying extra text with hints in the editor.
2464- Setting: `inlay_hints`
2465- Default:
2466
2467```json
2468"inlay_hints": {
2469 "enabled": false,
2470 "show_type_hints": true,
2471 "show_parameter_hints": true,
2472 "show_other_hints": true,
2473 "show_background": false,
2474 "edit_debounce_ms": 700,
2475 "scroll_debounce_ms": 50,
2476 "toggle_on_modifiers_press": null
2477}
2478```
2479
2480**Options**
2481
2482Inlay hints querying consists of two parts: editor (client) and LSP server.
2483With the inlay settings above are changed to enable the hints, editor will start to query certain types of hints and react on LSP hint refresh request from the server.
2484At this point, the server may or may not return hints depending on its implementation, further configuration might be needed, refer to the corresponding LSP server documentation.
2485
2486The following languages have inlay hints preconfigured by Zed:
2487
2488- [Go](https://docs.zed.dev/languages/go)
2489- [Rust](https://docs.zed.dev/languages/rust)
2490- [Svelte](https://docs.zed.dev/languages/svelte)
2491- [TypeScript](https://docs.zed.dev/languages/typescript)
2492
2493Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2494
2495Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2496Settings-related hint updates are not debounced.
2497
2498All possible config values for `toggle_on_modifiers_press` are:
2499
2500```json
2501"inlay_hints": {
2502 "toggle_on_modifiers_press": {
2503 "control": true,
2504 "shift": true,
2505 "alt": true,
2506 "platform": true,
2507 "function": true
2508 }
2509}
2510```
2511
2512Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2513
2514## Journal
2515
2516- Description: Configuration for the journal.
2517- Setting: `journal`
2518- Default:
2519
2520```json
2521"journal": {
2522 "path": "~",
2523 "hour_format": "hour12"
2524}
2525```
2526
2527### Path
2528
2529- Description: The path of the directory where journal entries are stored.
2530- Setting: `path`
2531- Default: `~`
2532
2533**Options**
2534
2535`string` values
2536
2537### Hour Format
2538
2539- Description: The format to use for displaying hours in the journal.
2540- Setting: `hour_format`
2541- Default: `hour12`
2542
2543**Options**
2544
25451. 12-hour format:
2546
2547```json
2548{
2549 "hour_format": "hour12"
2550}
2551```
2552
25532. 24-hour format:
2554
2555```json
2556{
2557 "hour_format": "hour24"
2558}
2559```
2560
2561## JSX Tag Auto Close
2562
2563- Description: Whether to automatically close JSX tags
2564- Setting: `jsx_tag_auto_close`
2565- Default:
2566
2567```json
2568{
2569 "jsx_tag_auto_close": {
2570 "enabled": true
2571 }
2572}
2573```
2574
2575**Options**
2576
2577- `enabled`: Whether to enable automatic JSX tag closing
2578
2579## Languages
2580
2581- Description: Configuration for specific languages.
2582- Setting: `languages`
2583- Default: `null`
2584
2585**Options**
2586
2587To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2588
2589```json
2590"languages": {
2591 "C": {
2592 "format_on_save": "off",
2593 "preferred_line_length": 64,
2594 "soft_wrap": "preferred_line_length"
2595 },
2596 "JSON": {
2597 "tab_size": 4
2598 }
2599}
2600```
2601
2602The following settings can be overridden for each specific language:
2603
2604- [`enable_language_server`](#enable-language-server)
2605- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2606- [`format_on_save`](#format-on-save)
2607- [`formatter`](#formatter)
2608- [`hard_tabs`](#hard-tabs)
2609- [`preferred_line_length`](#preferred-line-length)
2610- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2611- [`show_edit_predictions`](#show-edit-predictions)
2612- [`show_whitespaces`](#show-whitespaces)
2613- [`whitespace_map`](#whitespace-map)
2614- [`soft_wrap`](#soft-wrap)
2615- [`tab_size`](#tab-size)
2616- [`use_autoclose`](#use-autoclose)
2617- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2618
2619These values take in the same options as the root-level settings with the same name.
2620
2621## Language Models
2622
2623- Description: Configuration for language model providers
2624- Setting: `language_models`
2625- Default:
2626
2627```json
2628{
2629 "language_models": {
2630 "anthropic": {
2631 "api_url": "https://api.anthropic.com"
2632 },
2633 "google": {
2634 "api_url": "https://generativelanguage.googleapis.com"
2635 },
2636 "ollama": {
2637 "api_url": "http://localhost:11434"
2638 },
2639 "openai": {
2640 "api_url": "https://api.openai.com/v1"
2641 }
2642 }
2643}
2644```
2645
2646**Options**
2647
2648Configuration for various AI model providers including API URLs and authentication settings.
2649
2650## Line Indicator Format
2651
2652- Description: Format for line indicator in the status bar
2653- Setting: `line_indicator_format`
2654- Default: `"short"`
2655
2656**Options**
2657
26581. Short format:
2659
2660```json
2661{
2662 "line_indicator_format": "short"
2663}
2664```
2665
26662. Long format:
2667
2668```json
2669{
2670 "line_indicator_format": "long"
2671}
2672```
2673
2674## Linked Edits
2675
2676- Description: Whether to perform linked edits of associated ranges, if the language server supports it. For example, when editing opening `<html>` tag, the contents of the closing `</html>` tag will be edited as well.
2677- Setting: `linked_edits`
2678- Default: `true`
2679
2680**Options**
2681
2682`boolean` values
2683
2684## LSP Document Colors
2685
2686- Description: Whether to show document color information from the language server
2687- Setting: `lsp_document_colors`
2688- Default: `true`
2689
2690**Options**
2691
2692`boolean` values
2693
2694## Max Tabs
2695
2696- Description: Maximum number of tabs to show in the tab bar
2697- Setting: `max_tabs`
2698- Default: `null`
2699
2700**Options**
2701
2702Positive `integer` values or `null` for unlimited tabs
2703
2704## Middle Click Paste (Linux only)
2705
2706- Description: Enable middle-click paste on Linux
2707- Setting: `middle_click_paste`
2708- Default: `true`
2709
2710**Options**
2711
2712`boolean` values
2713
2714## Multi Cursor Modifier
2715
2716- Description: Determines the modifier to be used to add multiple cursors with the mouse. The open hover link mouse gestures will adapt such that it do not conflict with the multicursor modifier.
2717- Setting: `multi_cursor_modifier`
2718- Default: `alt`
2719
2720**Options**
2721
27221. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2723
2724```json
2725{
2726 "multi_cursor_modifier": "alt"
2727}
2728```
2729
27302. Maps `Control` on Linux and Windows and to `Command` on macOS:
2731
2732```json
2733{
2734 "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2735}
2736```
2737
2738## Node
2739
2740- Description: Configuration for Node.js integration
2741- Setting: `node`
2742- Default:
2743
2744```json
2745{
2746 "node": {
2747 "ignore_system_version": false,
2748 "path": null,
2749 "npm_path": null
2750 }
2751}
2752```
2753
2754**Options**
2755
2756- `ignore_system_version`: Whether to ignore the system Node.js version
2757- `path`: Custom path to Node.js binary
2758- `npm_path`: Custom path to npm binary
2759
2760## Network Proxy
2761
2762- Description: Configure a network proxy for Zed.
2763- Setting: `proxy`
2764- Default: `null`
2765
2766**Options**
2767
2768The proxy setting must contain a URL to the proxy.
2769
2770The following URI schemes are supported:
2771
2772- `http`
2773- `https`
2774- `socks4` - SOCKS4 proxy with local DNS
2775- `socks4a` - SOCKS4 proxy with remote DNS
2776- `socks5` - SOCKS5 proxy with local DNS
2777- `socks5h` - SOCKS5 proxy with remote DNS
2778
2779`http` will be used when no scheme is specified.
2780
2781By default no proxy will be used, or Zed will attempt to retrieve proxy settings from environment variables, such as `http_proxy`, `HTTP_PROXY`, `https_proxy`, `HTTPS_PROXY`, `all_proxy`, `ALL_PROXY`, `no_proxy` and `NO_PROXY`.
2782
2783For example, to set an `http` proxy, add the following to your settings:
2784
2785```json
2786{
2787 "proxy": "http://127.0.0.1:10809"
2788}
2789```
2790
2791Or to set a `socks5` proxy:
2792
2793```json
2794{
2795 "proxy": "socks5h://localhost:10808"
2796}
2797```
2798
2799If you wish to exclude certain hosts from using the proxy, set the `NO_PROXY` environment variable. This accepts a comma-separated list of hostnames, host suffixes, IPv4/IPv6 addresses or blocks that should not use the proxy. For example if your environment included `NO_PROXY="google.com, 192.168.1.0/24"` all hosts in `192.168.1.*`, `google.com` and `*.google.com` would bypass the proxy. See [reqwest NoProxy docs](https://docs.rs/reqwest/latest/reqwest/struct.NoProxy.html#method.from_string) for more.
2800
2801## On Last Window Closed
2802
2803- Description: What to do when the last window is closed
2804- Setting: `on_last_window_closed`
2805- Default: `"platform_default"`
2806
2807**Options**
2808
28091. Use platform default behavior:
2810
2811```json
2812{
2813 "on_last_window_closed": "platform_default"
2814}
2815```
2816
28172. Always quit the application:
2818
2819```json
2820{
2821 "on_last_window_closed": "quit_app"
2822}
2823```
2824
2825## Profiles
2826
2827- Description: Configuration profiles that can be applied on top of existing settings
2828- Setting: `profiles`
2829- Default: `{}`
2830
2831**Options**
2832
2833Configuration object for defining settings profiles. Example:
2834
2835```json
2836{
2837 "profiles": {
2838 "presentation": {
2839 "buffer_font_size": 20,
2840 "ui_font_size": 18,
2841 "theme": "One Light"
2842 }
2843 }
2844}
2845```
2846
2847## Preview tabs
2848
2849- Description:
2850 Preview tabs allow you to open files in preview mode, where they close automatically when you switch to another file unless you explicitly pin them. This is useful for quickly viewing files without cluttering your workspace. Preview tabs display their file names in italics. \
2851 There are several ways to convert a preview tab into a regular tab:
2852
2853 - Double-clicking on the file
2854 - Double-clicking on the tab header
2855 - Using the {#action project_panel::OpenPermanent} action
2856 - Editing the file
2857 - Dragging the file to a different pane
2858
2859- Setting: `preview_tabs`
2860- Default:
2861
2862```json
2863"preview_tabs": {
2864 "enabled": true,
2865 "enable_preview_from_file_finder": false,
2866 "enable_preview_from_code_navigation": false,
2867}
2868```
2869
2870### Enable preview from file finder
2871
2872- Description: Determines whether to open files in preview mode when selected from the file finder.
2873- Setting: `enable_preview_from_file_finder`
2874- Default: `false`
2875
2876**Options**
2877
2878`boolean` values
2879
2880### Enable preview from code navigation
2881
2882- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
2883- Setting: `enable_preview_from_code_navigation`
2884- Default: `false`
2885
2886**Options**
2887
2888`boolean` values
2889
2890## File Finder
2891
2892### File Icons
2893
2894- Description: Whether to show file icons in the file finder.
2895- Setting: `file_icons`
2896- Default: `true`
2897
2898### Modal Max Width
2899
2900- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2901- Setting: `modal_max_width`
2902- Default: `small`
2903
2904### Skip Focus For Active In Search
2905
2906- Description: Determines whether the file finder should skip focus for the active file in search results.
2907- Setting: `skip_focus_for_active_in_search`
2908- Default: `true`
2909
2910## Pane Split Direction Horizontal
2911
2912- Description: The direction that you want to split panes horizontally
2913- Setting: `pane_split_direction_horizontal`
2914- Default: `"up"`
2915
2916**Options**
2917
29181. Split upward:
2919
2920```json
2921{
2922 "pane_split_direction_horizontal": "up"
2923}
2924```
2925
29262. Split downward:
2927
2928```json
2929{
2930 "pane_split_direction_horizontal": "down"
2931}
2932```
2933
2934## Pane Split Direction Vertical
2935
2936- Description: The direction that you want to split panes vertically
2937- Setting: `pane_split_direction_vertical`
2938- Default: `"left"`
2939
2940**Options**
2941
29421. Split to the left:
2943
2944```json
2945{
2946 "pane_split_direction_vertical": "left"
2947}
2948```
2949
29502. Split to the right:
2951
2952```json
2953{
2954 "pane_split_direction_vertical": "right"
2955}
2956```
2957
2958## Preferred Line Length
2959
2960- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
2961- Setting: `preferred_line_length`
2962- Default: `80`
2963
2964**Options**
2965
2966`integer` values
2967
2968## Private Files
2969
2970- Description: Globs to match against file paths to determine if a file is private
2971- Setting: `private_files`
2972- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
2973
2974**Options**
2975
2976List of `string` glob patterns
2977
2978## Projects Online By Default
2979
2980- Description: Whether or not to show the online projects view by default.
2981- Setting: `projects_online_by_default`
2982- Default: `true`
2983
2984**Options**
2985
2986`boolean` values
2987
2988## Read SSH Config
2989
2990- Description: Whether to read SSH configuration files
2991- Setting: `read_ssh_config`
2992- Default: `true`
2993
2994**Options**
2995
2996`boolean` values
2997
2998## Redact Private Values
2999
3000- Description: Hide the values of variables from visual display in private files
3001- Setting: `redact_private_values`
3002- Default: `false`
3003
3004**Options**
3005
3006`boolean` values
3007
3008## Relative Line Numbers
3009
3010- Description: Whether to show relative line numbers in the gutter
3011- Setting: `relative_line_numbers`
3012- Default: `false`
3013
3014**Options**
3015
3016`boolean` values
3017
3018## Remove Trailing Whitespace On Save
3019
3020- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3021- Setting: `remove_trailing_whitespace_on_save`
3022- Default: `true`
3023
3024**Options**
3025
3026`boolean` values
3027
3028## Resize All Panels In Dock
3029
3030- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3031- Setting: `resize_all_panels_in_dock`
3032- Default: `["left"]`
3033
3034**Options**
3035
3036List of strings containing any combination of:
3037
3038- `"left"`: Resize left dock panels together
3039- `"right"`: Resize right dock panels together
3040- `"bottom"`: Resize bottom dock panels together
3041
3042## Restore on File Reopen
3043
3044- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3045- Setting: `restore_on_file_reopen`
3046- Default: `true`
3047
3048**Options**
3049
3050`boolean` values
3051
3052## Restore on Startup
3053
3054- Description: Controls session restoration on startup.
3055- Setting: `restore_on_startup`
3056- Default: `last_session`
3057
3058**Options**
3059
30601. Restore all workspaces that were open when quitting Zed:
3061
3062```json
3063{
3064 "restore_on_startup": "last_session"
3065}
3066```
3067
30682. Restore the workspace that was closed last:
3069
3070```json
3071{
3072 "restore_on_startup": "last_workspace"
3073}
3074```
3075
30763. Always start with an empty editor:
3077
3078```json
3079{
3080 "restore_on_startup": "none"
3081}
3082```
3083
3084## Scroll Beyond Last Line
3085
3086- Description: Whether the editor will scroll beyond the last line
3087- Setting: `scroll_beyond_last_line`
3088- Default: `"one_page"`
3089
3090**Options**
3091
30921. Scroll one page beyond the last line by one page:
3093
3094```json
3095{
3096 "scroll_beyond_last_line": "one_page"
3097}
3098```
3099
31002. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3101
3102```json
3103{
3104 "scroll_beyond_last_line": "vertical_scroll_margin"
3105}
3106```
3107
31083. The editor will not scroll beyond the last line:
3109
3110```json
3111{
3112 "scroll_beyond_last_line": "off"
3113}
3114```
3115
3116**Options**
3117
3118`boolean` values
3119
3120## Scroll Sensitivity
3121
3122- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3123- Setting: `scroll_sensitivity`
3124- Default: `1.0`
3125
3126**Options**
3127
3128Positive `float` values
3129
3130### Fast Scroll Sensitivity
3131
3132- Description: Scroll sensitivity multiplier for fast scrolling. This multiplier is applied to both the horizontal and vertical delta values while scrolling. Fast scrolling happens when a user holds the alt or option key while scrolling.
3133- Setting: `fast_scroll_sensitivity`
3134- Default: `4.0`
3135
3136**Options**
3137
3138Positive `float` values
3139
3140### Horizontal Scroll Margin
3141
3142- Description: The number of characters to keep on either side when scrolling with the mouse
3143- Setting: `horizontal_scroll_margin`
3144- Default: `5`
3145
3146**Options**
3147
3148Non-negative `integer` values
3149
3150### Vertical Scroll Margin
3151
3152- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3153- Setting: `vertical_scroll_margin`
3154- Default: `3`
3155
3156**Options**
3157
3158Non-negative `integer` values
3159
3160## Search
3161
3162- Description: Search options to enable by default when opening new project and buffer searches.
3163- Setting: `search`
3164- Default:
3165
3166```json
3167"search": {
3168 "whole_word": false,
3169 "case_sensitive": false,
3170 "include_ignored": false,
3171 "regex": false
3172},
3173```
3174
3175## Search Wrap
3176
3177- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3178- Setting: `search_wrap`
3179- Default: `true`
3180
3181## Seed Search Query From Cursor
3182
3183- Description: When to populate a new search's query based on the text under the cursor.
3184- Setting: `seed_search_query_from_cursor`
3185- Default: `always`
3186
3187**Options**
3188
31891. `always` always populate the search query with the word under the cursor
31902. `selection` only populate the search query when there is text selected
31913. `never` never populate the search query
3192
3193## Use Smartcase Search
3194
3195- Description: When enabled, automatically adjusts search case sensitivity based on your query. If your search query contains any uppercase letters, the search becomes case-sensitive; if it contains only lowercase letters, the search becomes case-insensitive. \
3196 This applies to both in-file searches and project-wide searches.
3197- Setting: `use_smartcase_search`
3198- Default: `false`
3199
3200**Options**
3201
3202`boolean` values
3203
3204Examples:
3205
3206- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3207- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3208
3209## Show Call Status Icon
3210
3211- Description: Whether or not to show the call status icon in the status bar.
3212- Setting: `show_call_status_icon`
3213- Default: `true`
3214
3215**Options**
3216
3217`boolean` values
3218
3219## Completions
3220
3221- Description: Controls how completions are processed for this language.
3222- Setting: `completions`
3223- Default:
3224
3225```json
3226{
3227 "completions": {
3228 "words": "fallback",
3229 "words_min_length": 3,
3230 "lsp": true,
3231 "lsp_fetch_timeout_ms": 0,
3232 "lsp_insert_mode": "replace_suffix"
3233 }
3234}
3235```
3236
3237### Words
3238
3239- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3240- Setting: `words`
3241- Default: `fallback`
3242
3243**Options**
3244
32451. `enabled` - Always fetch document's words for completions along with LSP completions
32462. `fallback` - Only if LSP response errors or times out, use document's words to show completions
32473. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3248
3249### Min Words Query Length
3250
3251- Description: Minimum number of characters required to automatically trigger word-based completions.
3252 Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3253- Setting: `words_min_length`
3254- Default: `3`
3255
3256**Options**
3257
3258Positive integer values
3259
3260### LSP
3261
3262- Description: Whether to fetch LSP completions or not.
3263- Setting: `lsp`
3264- Default: `true`
3265
3266**Options**
3267
3268`boolean` values
3269
3270### LSP Fetch Timeout (ms)
3271
3272- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3273- Setting: `lsp_fetch_timeout_ms`
3274- Default: `0`
3275
3276**Options**
3277
3278`integer` values representing milliseconds
3279
3280### LSP Insert Mode
3281
3282- Description: Controls what range to replace when accepting LSP completions.
3283- Setting: `lsp_insert_mode`
3284- Default: `replace_suffix`
3285
3286**Options**
3287
32881. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
32892. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
32903. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
32914. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3292
3293## Show Completions On Input
3294
3295- Description: Whether or not to show completions as you type.
3296- Setting: `show_completions_on_input`
3297- Default: `true`
3298
3299**Options**
3300
3301`boolean` values
3302
3303## Show Completion Documentation
3304
3305- Description: Whether to display inline and alongside documentation for items in the completions menu.
3306- Setting: `show_completion_documentation`
3307- Default: `true`
3308
3309**Options**
3310
3311`boolean` values
3312
3313## Show Edit Predictions
3314
3315- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3316- Setting: `show_edit_predictions`
3317- Default: `true`
3318
3319**Options**
3320
3321`boolean` values
3322
3323## Show Whitespaces
3324
3325- Description: Whether or not to render whitespace characters in the editor.
3326- Setting: `show_whitespaces`
3327- Default: `selection`
3328
3329**Options**
3330
33311. `all`
33322. `selection`
33333. `none`
33344. `boundary`
3335
3336## Whitespace Map
3337
3338- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3339- Setting: `whitespace_map`
3340- Default:
3341
3342```json
3343{
3344 "whitespace_map": {
3345 "space": "•",
3346 "tab": "→"
3347 },
3348```
3349
3350## Soft Wrap
3351
3352- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3353- Setting: `soft_wrap`
3354- Default: `none`
3355
3356**Options**
3357
33581. `none` to avoid wrapping generally, unless the line is too long
33592. `prefer_line` (deprecated, same as `none`)
33603. `editor_width` to wrap lines that overflow the editor width
33614. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
33625. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3363
3364## Show Wrap Guides
3365
3366- Description: Whether to show wrap guides (vertical rulers) in the editor. Setting this to true will show a guide at the 'preferred_line_length' value if 'soft_wrap' is set to 'preferred_line_length', and will show any additional guides as specified by the 'wrap_guides' setting.
3367- Setting: `show_wrap_guides`
3368- Default: `true`
3369
3370**Options**
3371
3372`boolean` values
3373
3374## Use On Type Format
3375
3376- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3377- Setting: `use_on_type_format`
3378- Default: `true`
3379
3380**Options**
3381
3382`boolean` values
3383
3384## Use Auto Surround
3385
3386- Description: Whether to automatically surround selected text when typing opening parenthesis, bracket, brace, single or double quote characters. For example, when you select text and type (, Zed will surround the text with ().
3387- Setting: `use_auto_surround`
3388- Default: `true`
3389
3390**Options**
3391
3392`boolean` values
3393
3394## Use System Path Prompts
3395
3396- Description: Whether to use the system provided dialogs for Open and Save As. When set to false, Zed will use the built-in keyboard-first pickers.
3397- Setting: `use_system_path_prompts`
3398- Default: `true`
3399
3400**Options**
3401
3402`boolean` values
3403
3404## Use System Prompts
3405
3406- Description: Whether to use the system provided dialogs for prompts, such as confirmation prompts. When set to false, Zed will use its built-in prompts. Note that on Linux, this option is ignored and Zed will always use the built-in prompts.
3407- Setting: `use_system_prompts`
3408- Default: `true`
3409
3410**Options**
3411
3412`boolean` values
3413
3414## Wrap Guides (Vertical Rulers)
3415
3416- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3417- Setting: `wrap_guides`
3418- Default: []
3419
3420**Options**
3421
3422List of `integer` column numbers
3423
3424## Tab Size
3425
3426- Description: The number of spaces to use for each tab character.
3427- Setting: `tab_size`
3428- Default: `4`
3429
3430**Options**
3431
3432`integer` values
3433
3434## Tasks
3435
3436- Description: Configuration for tasks that can be run within Zed
3437- Setting: `tasks`
3438- Default:
3439
3440```json
3441{
3442 "tasks": {
3443 "variables": {},
3444 "enabled": true,
3445 "prefer_lsp": false
3446 }
3447}
3448```
3449
3450**Options**
3451
3452- `variables`: Custom variables for task configuration
3453- `enabled`: Whether tasks are enabled
3454- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3455
3456## Telemetry
3457
3458- Description: Control what info is collected by Zed.
3459- Setting: `telemetry`
3460- Default:
3461
3462```json
3463"telemetry": {
3464 "diagnostics": true,
3465 "metrics": true
3466},
3467```
3468
3469**Options**
3470
3471### Diagnostics
3472
3473- Description: Setting for sending debug-related data, such as crash reports.
3474- Setting: `diagnostics`
3475- Default: `true`
3476
3477**Options**
3478
3479`boolean` values
3480
3481### Metrics
3482
3483- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3484- Setting: `metrics`
3485- Default: `true`
3486
3487**Options**
3488
3489`boolean` values
3490
3491## Terminal
3492
3493- Description: Configuration for the terminal.
3494- Setting: `terminal`
3495- Default:
3496
3497```json
3498{
3499 "terminal": {
3500 "alternate_scroll": "off",
3501 "blinking": "terminal_controlled",
3502 "copy_on_select": false,
3503 "keep_selection_on_copy": false,
3504 "dock": "bottom",
3505 "default_width": 640,
3506 "default_height": 320,
3507 "detect_venv": {
3508 "on": {
3509 "directories": [".env", "env", ".venv", "venv"],
3510 "activate_script": "default"
3511 }
3512 },
3513 "env": {},
3514 "font_family": null,
3515 "font_features": null,
3516 "font_size": null,
3517 "line_height": "comfortable",
3518 "minimum_contrast": 45,
3519 "option_as_meta": false,
3520 "button": true,
3521 "shell": "system",
3522 "toolbar": {
3523 "breadcrumbs": false
3524 },
3525 "working_directory": "current_project_directory",
3526 "scrollbar": {
3527 "show": null
3528 }
3529 }
3530}
3531```
3532
3533### Terminal: Dock
3534
3535- Description: Control the position of the dock
3536- Setting: `dock`
3537- Default: `bottom`
3538
3539**Options**
3540
3541`"bottom"`, `"left"` or `"right"`
3542
3543### Terminal: Alternate Scroll
3544
3545- Description: Set whether Alternate Scroll mode (DECSET code: `?1007`) is active by default. Alternate Scroll mode converts mouse scroll events into up / down key presses when in the alternate screen (e.g. when running applications like vim or less). The terminal can still set and unset this mode with ANSI escape codes.
3546- Setting: `alternate_scroll`
3547- Default: `off`
3548
3549**Options**
3550
35511. Default alternate scroll mode to off
3552
3553```json
3554{
3555 "terminal": {
3556 "alternate_scroll": "off"
3557 }
3558}
3559```
3560
35612. Default alternate scroll mode to on
3562
3563```json
3564{
3565 "terminal": {
3566 "alternate_scroll": "on"
3567 }
3568}
3569```
3570
3571### Terminal: Blinking
3572
3573- Description: Set the cursor blinking behavior in the terminal
3574- Setting: `blinking`
3575- Default: `terminal_controlled`
3576
3577**Options**
3578
35791. Never blink the cursor, ignore the terminal mode
3580
3581```json
3582{
3583 "terminal": {
3584 "blinking": "off"
3585 }
3586}
3587```
3588
35892. Default the cursor blink to off, but allow the terminal to turn blinking on
3590
3591```json
3592{
3593 "terminal": {
3594 "blinking": "terminal_controlled"
3595 }
3596}
3597```
3598
35993. Always blink the cursor, ignore the terminal mode
3600
3601```json
3602{
3603 "terminal": {
3604 "blinking": "on"
3605 }
3606}
3607```
3608
3609### Terminal: Copy On Select
3610
3611- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3612- Setting: `copy_on_select`
3613- Default: `false`
3614
3615**Options**
3616
3617`boolean` values
3618
3619**Example**
3620
3621```json
3622{
3623 "terminal": {
3624 "copy_on_select": true
3625 }
3626}
3627```
3628
3629### Terminal: Cursor Shape
3630
3631- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3632- Setting: `cursor_shape`
3633- Default: `null` (defaults to block)
3634
3635**Options**
3636
36371. A block that surrounds the following character
3638
3639```json
3640{
3641 "terminal": {
3642 "cursor_shape": "block"
3643 }
3644}
3645```
3646
36472. A vertical bar
3648
3649```json
3650{
3651 "terminal": {
3652 "cursor_shape": "bar"
3653 }
3654}
3655```
3656
36573. An underline / underscore that runs along the following character
3658
3659```json
3660{
3661 "terminal": {
3662 "cursor_shape": "underline"
3663 }
3664}
3665```
3666
36674. A box drawn around the following character
3668
3669```json
3670{
3671 "terminal": {
3672 "cursor_shape": "hollow"
3673 }
3674}
3675```
3676
3677### Terminal: Keep Selection On Copy
3678
3679- Description: Whether or not to keep the selection in the terminal after copying text.
3680- Setting: `keep_selection_on_copy`
3681- Default: `false`
3682
3683**Options**
3684
3685`boolean` values
3686
3687**Example**
3688
3689```json
3690{
3691 "terminal": {
3692 "keep_selection_on_copy": true
3693 }
3694}
3695```
3696
3697### Terminal: Env
3698
3699- Description: Any key-value pairs added to this object will be added to the terminal's environment. Keys must be unique, use `:` to separate multiple values in a single variable
3700- Setting: `env`
3701- Default: `{}`
3702
3703**Example**
3704
3705```json
3706{
3707 "terminal": {
3708 "env": {
3709 "ZED": "1",
3710 "KEY": "value1:value2"
3711 }
3712 }
3713}
3714```
3715
3716### Terminal: Font Size
3717
3718- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3719- Setting: `font_size`
3720- Default: `null`
3721
3722**Options**
3723
3724`integer` values
3725
3726```json
3727{
3728 "terminal": {
3729 "font_size": 15
3730 }
3731}
3732```
3733
3734### Terminal: Font Family
3735
3736- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3737- Setting: `font_family`
3738- Default: `null`
3739
3740**Options**
3741
3742The name of any font family installed on the user's system
3743
3744```json
3745{
3746 "terminal": {
3747 "font_family": "Berkeley Mono"
3748 }
3749}
3750```
3751
3752### Terminal: Font Features
3753
3754- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3755- Setting: `font_features`
3756- Default: `null`
3757- Platform: macOS and Windows.
3758
3759**Options**
3760
3761See Buffer Font Features
3762
3763```json
3764{
3765 "terminal": {
3766 "font_features": {
3767 "calt": false
3768 // See Buffer Font Features for more features
3769 }
3770 }
3771}
3772```
3773
3774### Terminal: Line Height
3775
3776- Description: Set the terminal's line height.
3777- Setting: `line_height`
3778- Default: `standard`
3779
3780**Options**
3781
37821. Use a line height that's `comfortable` for reading, 1.618.
3783
3784```json
3785{
3786 "terminal": {
3787 "line_height": "comfortable"
3788 }
3789}
3790```
3791
37922. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3793
3794```json
3795{
3796 "terminal": {
3797 "line_height": "standard"
3798 }
3799}
3800```
3801
38023. Use a custom line height.
3803
3804```json
3805{
3806 "terminal": {
3807 "line_height": {
3808 "custom": 2
3809 }
3810 }
3811}
3812```
3813
3814### Terminal: Minimum Contrast
3815
3816- Description: Controls the minimum contrast between foreground and background colors in the terminal. Uses the APCA (Accessible Perceptual Contrast Algorithm) for color adjustments. Set this to 0 to disable this feature.
3817- Setting: `minimum_contrast`
3818- Default: `45`
3819
3820**Options**
3821
3822`integer` values from 0 to 106. Common recommended values:
3823
3824- `0`: No contrast adjustment
3825- `45`: Minimum for large fluent text (default)
3826- `60`: Minimum for other content text
3827- `75`: Minimum for body text
3828- `90`: Preferred for body text
3829
3830```json
3831{
3832 "terminal": {
3833 "minimum_contrast": 45
3834 }
3835}
3836```
3837
3838### Terminal: Option As Meta
3839
3840- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
3841- Setting: `option_as_meta`
3842- Default: `false`
3843
3844**Options**
3845
3846`boolean` values
3847
3848```json
3849{
3850 "terminal": {
3851 "option_as_meta": true
3852 }
3853}
3854```
3855
3856### Terminal: Shell
3857
3858- Description: What shell to use when launching the terminal.
3859- Setting: `shell`
3860- Default: `system`
3861
3862**Options**
3863
38641. Use the system's default terminal configuration (usually the `/etc/passwd` file).
3865
3866```json
3867{
3868 "terminal": {
3869 "shell": "system"
3870 }
3871}
3872```
3873
38742. A program to launch:
3875
3876```json
3877{
3878 "terminal": {
3879 "shell": {
3880 "program": "sh"
3881 }
3882 }
3883}
3884```
3885
38863. A program with arguments:
3887
3888```json
3889{
3890 "terminal": {
3891 "shell": {
3892 "with_arguments": {
3893 "program": "/bin/bash",
3894 "args": ["--login"]
3895 }
3896 }
3897 }
3898}
3899```
3900
3901## Terminal: Detect Virtual Environments {#terminal-detect_venv}
3902
3903- Description: Activate the [Python Virtual Environment](https://docs.python.org/3/library/venv.html), if one is found, in the terminal's working directory (as resolved by the working_directory and automatically activating the virtual environment.
3904- Setting: `detect_venv`
3905- Default:
3906
3907```json
3908{
3909 "terminal": {
3910 "detect_venv": {
3911 "on": {
3912 // Default directories to search for virtual environments, relative
3913 // to the current working directory. We recommend overriding this
3914 // in your project's settings, rather than globally.
3915 "directories": [".env", "env", ".venv", "venv"],
3916 // Can also be `csh`, `fish`, and `nushell`
3917 "activate_script": "default"
3918 }
3919 }
3920 }
3921}
3922```
3923
3924Disable with:
3925
3926```json
3927{
3928 "terminal": {
3929 "detect_venv": "off"
3930 }
3931}
3932```
3933
3934## Terminal: Toolbar
3935
3936- Description: Whether or not to show various elements in the terminal toolbar.
3937- Setting: `toolbar`
3938- Default:
3939
3940```json
3941{
3942 "terminal": {
3943 "toolbar": {
3944 "breadcrumbs": false
3945 }
3946 }
3947}
3948```
3949
3950**Options**
3951
3952At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
3953
3954If the terminal title is empty, the breadcrumbs won't be shown.
3955
3956The shell running in the terminal needs to be configured to emit the title.
3957
3958Example command to set the title: `echo -e "\e]2;New Title\007";`
3959
3960### Terminal: Button
3961
3962- Description: Control to show or hide the terminal button in the status bar
3963- Setting: `button`
3964- Default: `true`
3965
3966**Options**
3967
3968`boolean` values
3969
3970```json
3971{
3972 "terminal": {
3973 "button": false
3974 }
3975}
3976```
3977
3978### Terminal: Working Directory
3979
3980- Description: What working directory to use when launching the terminal.
3981- Setting: `working_directory`
3982- Default: `"current_project_directory"`
3983
3984**Options**
3985
39861. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
3987
3988```json
3989{
3990 "terminal": {
3991 "working_directory": "current_project_directory"
3992 }
3993}
3994```
3995
39962. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
3997
3998```json
3999{
4000 "terminal": {
4001 "working_directory": "first_project_directory"
4002 }
4003}
4004```
4005
40063. Always use this platform's home directory (if we can find it)
4007
4008```json
4009{
4010 "terminal": {
4011 "working_directory": "always_home"
4012 }
4013}
4014```
4015
40164. Always use a specific directory. This value will be shell expanded. If this path is not a valid directory the terminal will default to this platform's home directory.
4017
4018```json
4019{
4020 "terminal": {
4021 "working_directory": {
4022 "always": {
4023 "directory": "~/zed/projects/"
4024 }
4025 }
4026 }
4027}
4028```
4029
4030## REPL
4031
4032- Description: Repl settings.
4033- Setting: `repl`
4034- Default:
4035
4036```json
4037"repl": {
4038 // Maximum number of columns to keep in REPL's scrollback buffer.
4039 // Clamped with [20, 512] range.
4040 "max_columns": 128,
4041 // Maximum number of lines to keep in REPL's scrollback buffer.
4042 // Clamped with [4, 256] range.
4043 "max_lines": 32
4044},
4045```
4046
4047## Theme
4048
4049- Description: The theme setting can be specified in two forms - either as the name of a theme or as an object containing the `mode`, `dark`, and `light` themes for the Zed UI.
4050- Setting: `theme`
4051- Default: `One Dark`
4052
4053### Theme Object
4054
4055- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4056- Setting: `theme`
4057- Default:
4058
4059```json
4060"theme": {
4061 "mode": "system",
4062 "dark": "One Dark",
4063 "light": "One Light"
4064},
4065```
4066
4067### Mode
4068
4069- Description: Specify theme mode.
4070- Setting: `mode`
4071- Default: `system`
4072
4073**Options**
4074
40751. Set the theme to dark mode
4076
4077```json
4078{
4079 "mode": "dark"
4080}
4081```
4082
40832. Set the theme to light mode
4084
4085```json
4086{
4087 "mode": "light"
4088}
4089```
4090
40913. Set the theme to system mode
4092
4093```json
4094{
4095 "mode": "system"
4096}
4097```
4098
4099### Dark
4100
4101- Description: The name of the dark Zed theme to use for the UI.
4102- Setting: `dark`
4103- Default: `One Dark`
4104
4105**Options**
4106
4107Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4108
4109### Light
4110
4111- Description: The name of the light Zed theme to use for the UI.
4112- Setting: `light`
4113- Default: `One Light`
4114
4115**Options**
4116
4117Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4118
4119## Title Bar
4120
4121- Description: Whether or not to show various elements in the title bar
4122- Setting: `title_bar`
4123- Default:
4124
4125```json
4126"title_bar": {
4127 "show_branch_icon": false,
4128 "show_branch_name": true,
4129 "show_project_items": true,
4130 "show_onboarding_banner": true,
4131 "show_user_picture": true,
4132 "show_sign_in": true,
4133 "show_menus": false
4134}
4135```
4136
4137**Options**
4138
4139- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4140- `show_branch_name`: Whether to show the branch name button in the titlebar
4141- `show_project_items`: Whether to show the project host and name in the titlebar
4142- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4143- `show_user_picture`: Whether to show user picture in the titlebar
4144- `show_sign_in`: Whether to show the sign in button in the titlebar
4145- `show_menus`: Whether to show the menus in the titlebar
4146
4147## Vim
4148
4149- Description: Whether or not to enable vim mode.
4150- Setting: `vim_mode`
4151- Default: `false`
4152
4153## When Closing With No Tabs
4154
4155- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4156- Setting: `when_closing_with_no_tabs`
4157- Default: `"platform_default"`
4158
4159**Options**
4160
41611. Use platform default behavior:
4162
4163```json
4164{
4165 "when_closing_with_no_tabs": "platform_default"
4166}
4167```
4168
41692. Always close the window:
4170
4171```json
4172{
4173 "when_closing_with_no_tabs": "close_window"
4174}
4175```
4176
41773. Never close the window:
4178
4179```json
4180{
4181 "when_closing_with_no_tabs": "keep_window_open"
4182}
4183```
4184
4185## Project Panel
4186
4187- Description: Customize project panel
4188- Setting: `project_panel`
4189- Default:
4190
4191```json
4192{
4193 "project_panel": {
4194 "button": true,
4195 "default_width": 240,
4196 "dock": "left",
4197 "entry_spacing": "comfortable",
4198 "file_icons": true,
4199 "folder_icons": true,
4200 "git_status": true,
4201 "indent_size": 20,
4202 "auto_reveal_entries": true,
4203 "auto_fold_dirs": true,
4204 "drag_and_drop": true,
4205 "scrollbar": {
4206 "show": null
4207 },
4208 "sticky_scroll": true,
4209 "show_diagnostics": "all",
4210 "indent_guides": {
4211 "show": "always"
4212 },
4213 "hide_root": false,
4214 "starts_open": true
4215 }
4216}
4217```
4218
4219### Dock
4220
4221- Description: Control the position of the dock
4222- Setting: `dock`
4223- Default: `left`
4224
4225**Options**
4226
42271. Default dock position to left
4228
4229```json
4230{
4231 "dock": "left"
4232}
4233```
4234
42352. Default dock position to right
4236
4237```json
4238{
4239 "dock": "right"
4240}
4241```
4242
4243### Entry Spacing
4244
4245- Description: Spacing between worktree entries
4246- Setting: `entry_spacing`
4247- Default: `comfortable`
4248
4249**Options**
4250
42511. Comfortable entry spacing
4252
4253```json
4254{
4255 "entry_spacing": "comfortable"
4256}
4257```
4258
42592. Standard entry spacing
4260
4261```json
4262{
4263 "entry_spacing": "standard"
4264}
4265```
4266
4267### Git Status
4268
4269- Description: Indicates newly created and updated files
4270- Setting: `git_status`
4271- Default: `true`
4272
4273**Options**
4274
42751. Default enable git status
4276
4277```json
4278{
4279 "git_status": true
4280}
4281```
4282
42832. Default disable git status
4284
4285```json
4286{
4287 "git_status": false
4288}
4289```
4290
4291### Default Width
4292
4293- Description: Customize default width taken by project panel
4294- Setting: `default_width`
4295- Default: `240`
4296
4297**Options**
4298
4299`float` values
4300
4301### Auto Reveal Entries
4302
4303- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4304- Setting: `auto_reveal_entries`
4305- Default: `true`
4306
4307**Options**
4308
43091. Enable auto reveal entries
4310
4311```json
4312{
4313 "auto_reveal_entries": true
4314}
4315```
4316
43172. Disable auto reveal entries
4318
4319```json
4320{
4321 "auto_reveal_entries": false
4322}
4323```
4324
4325### Auto Fold Dirs
4326
4327- Description: Whether to fold directories automatically when directory has only one directory inside.
4328- Setting: `auto_fold_dirs`
4329- Default: `true`
4330
4331**Options**
4332
43331. Enable auto fold dirs
4334
4335```json
4336{
4337 "auto_fold_dirs": true
4338}
4339```
4340
43412. Disable auto fold dirs
4342
4343```json
4344{
4345 "auto_fold_dirs": false
4346}
4347```
4348
4349### Indent Size
4350
4351- Description: Amount of indentation (in pixels) for nested items.
4352- Setting: `indent_size`
4353- Default: `20`
4354
4355### Indent Guides: Show
4356
4357- Description: Whether to show indent guides in the project panel.
4358- Setting: `indent_guides`
4359- Default:
4360
4361```json
4362"indent_guides": {
4363 "show": "always"
4364}
4365```
4366
4367**Options**
4368
43691. Show indent guides in the project panel
4370
4371```json
4372{
4373 "indent_guides": {
4374 "show": "always"
4375 }
4376}
4377```
4378
43792. Hide indent guides in the project panel
4380
4381```json
4382{
4383 "indent_guides": {
4384 "show": "never"
4385 }
4386}
4387```
4388
4389### Scrollbar: Show
4390
4391- Description: Whether to show a scrollbar in the project panel. Possible values: null, "auto", "system", "always", "never". Inherits editor settings when absent, see its description for more details.
4392- Setting: `scrollbar`
4393- Default:
4394
4395```json
4396"scrollbar": {
4397 "show": null
4398}
4399```
4400
4401**Options**
4402
44031. Show scrollbar in the project panel
4404
4405```json
4406{
4407 "scrollbar": {
4408 "show": "always"
4409 }
4410}
4411```
4412
44132. Hide scrollbar in the project panel
4414
4415```json
4416{
4417 "scrollbar": {
4418 "show": "never"
4419 }
4420}
4421```
4422
4423## Agent
4424
4425Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4426
4427## Collaboration Panel
4428
4429- Description: Customizations for the collaboration panel.
4430- Setting: `collaboration_panel`
4431- Default:
4432
4433```json
4434{
4435 "collaboration_panel": {
4436 "button": true,
4437 "dock": "left",
4438 "default_width": 240
4439 }
4440}
4441```
4442
4443**Options**
4444
4445- `button`: Whether to show the collaboration panel button in the status bar
4446- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4447- `default_width`: Default width of the collaboration panel
4448
4449## Debugger
4450
4451- Description: Configuration for debugger panel and settings
4452- Setting: `debugger`
4453- Default:
4454
4455```json
4456{
4457 "debugger": {
4458 "stepping_granularity": "line",
4459 "save_breakpoints": true,
4460 "dock": "bottom",
4461 "button": true
4462 }
4463}
4464```
4465
4466See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4467
4468## Git Panel
4469
4470- Description: Setting to customize the behavior of the git panel.
4471- Setting: `git_panel`
4472- Default:
4473
4474```json
4475{
4476 "git_panel": {
4477 "button": true,
4478 "dock": "left",
4479 "default_width": 360,
4480 "status_style": "icon",
4481 "fallback_branch_name": "main",
4482 "sort_by_path": false,
4483 "collapse_untracked_diff": false,
4484 "scrollbar": {
4485 "show": null
4486 }
4487 }
4488}
4489```
4490
4491**Options**
4492
4493- `button`: Whether to show the git panel button in the status bar
4494- `dock`: Where to dock the git panel. Can be `left` or `right`
4495- `default_width`: Default width of the git panel
4496- `status_style`: How to display git status. Can be `label_color` or `icon`
4497- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4498- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4499- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4500- `scrollbar`: When to show the scrollbar in the git panel
4501
4502## Outline Panel
4503
4504- Description: Customize outline Panel
4505- Setting: `outline_panel`
4506- Default:
4507
4508```json
4509"outline_panel": {
4510 "button": true,
4511 "default_width": 300,
4512 "dock": "left",
4513 "file_icons": true,
4514 "folder_icons": true,
4515 "git_status": true,
4516 "indent_size": 20,
4517 "auto_reveal_entries": true,
4518 "auto_fold_dirs": true,
4519 "indent_guides": {
4520 "show": "always"
4521 },
4522 "scrollbar": {
4523 "show": null
4524 }
4525}
4526```
4527
4528## Calls
4529
4530- Description: Customize behavior when participating in a call
4531- Setting: `calls`
4532- Default:
4533
4534```json
4535"calls": {
4536 // Join calls with the microphone live by default
4537 "mute_on_join": false,
4538 // Share your project when you are the first to join a channel
4539 "share_on_join": false
4540},
4541```
4542
4543## Unnecessary Code Fade
4544
4545- Description: How much to fade out unused code.
4546- Setting: `unnecessary_code_fade`
4547- Default: `0.3`
4548
4549**Options**
4550
4551Float values between `0.0` and `0.9`, where:
4552
4553- `0.0` means no fading (unused code looks the same as used code)
4554- `0.9` means maximum fading (unused code is very faint but still visible)
4555
4556**Example**
4557
4558```json
4559{
4560 "unnecessary_code_fade": 0.5
4561}
4562```
4563
4564## UI Font Family
4565
4566- Description: The name of the font to use for text in the UI.
4567- Setting: `ui_font_family`
4568- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4569
4570**Options**
4571
4572The name of any font family installed on the system, `".ZedSans"` to use the Zed-provided default, or `".SystemUIFont"` to use the system's default UI font (on macOS and Windows).
4573
4574## UI Font Features
4575
4576- Description: The OpenType features to enable for text in the UI.
4577- Setting: `ui_font_features`
4578- Default:
4579
4580```json
4581"ui_font_features": {
4582 "calt": false
4583}
4584```
4585
4586- Platform: macOS and Windows.
4587
4588**Options**
4589
4590Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4591
4592For example, to disable font ligatures, add the following to your settings:
4593
4594```json
4595{
4596 "ui_font_features": {
4597 "calt": false
4598 }
4599}
4600```
4601
4602You can also set other OpenType features, like setting `cv01` to `7`:
4603
4604```json
4605{
4606 "ui_font_features": {
4607 "cv01": 7
4608 }
4609}
4610```
4611
4612## UI Font Fallbacks
4613
4614- Description: The font fallbacks to use for text in the UI.
4615- Setting: `ui_font_fallbacks`
4616- Default: `null`
4617- Platform: macOS and Windows.
4618
4619**Options**
4620
4621For example, to use `Nerd Font` as a fallback, add the following to your settings:
4622
4623```json
4624{
4625 "ui_font_fallbacks": ["Nerd Font"]
4626}
4627```
4628
4629## UI Font Size
4630
4631- Description: The default font size for text in the UI.
4632- Setting: `ui_font_size`
4633- Default: `16`
4634
4635**Options**
4636
4637`integer` values from `6` to `100` pixels (inclusive)
4638
4639## UI Font Weight
4640
4641- Description: The default font weight for text in the UI.
4642- Setting: `ui_font_weight`
4643- Default: `400`
4644
4645**Options**
4646
4647`integer` values between `100` and `900`
4648
4649## An example configuration:
4650
4651```json
4652// ~/.config/zed/settings.json
4653{
4654 "theme": "cave-light",
4655 "tab_size": 2,
4656 "preferred_line_length": 80,
4657 "soft_wrap": "none",
4658
4659 "buffer_font_size": 18,
4660 "buffer_font_family": ".ZedMono",
4661
4662 "autosave": "on_focus_change",
4663 "format_on_save": "off",
4664 "vim_mode": false,
4665 "projects_online_by_default": true,
4666 "terminal": {
4667 "font_family": "FiraCode Nerd Font Mono",
4668 "blinking": "off"
4669 },
4670 "languages": {
4671 "C": {
4672 "format_on_save": "language_server",
4673 "preferred_line_length": 64,
4674 "soft_wrap": "preferred_line_length"
4675 }
4676 }
4677}
4678```