1---
2title: All Settings
3description: "Complete reference for all Zed settings."
4---
5
6# All Settings
7
8This is the complete reference for all Zed settings.
9
10You may also want to change your [theme](../themes.md), configure your [key bindings](../key-bindings.md), set up [tasks](../tasks.md), or install [extensions](../extensions.md).
11
12# Settings
13
14The sections below document supported Zed settings.
15
16## Active Pane Modifiers
17
18- Description: Styling settings applied to the active pane.
19- Setting: `active_pane_modifiers`
20- Default:
21
22```json [settings]
23{
24 "active_pane_modifiers": {
25 "border_size": 0.0,
26 "inactive_opacity": 1.0
27 }
28}
29```
30
31### Border size
32
33- 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.
34- Setting: `border_size`
35- Default: `0.0`
36
37**Options**
38
39Non-negative `float` values
40
41### Inactive Opacity
42
43- Description: Opacity of inactive panels. When set to 1.0, inactive panes have the same opacity as the active pane. If set to 0, inactive pane content is not visible. Values are clamped to the [0.0, 1.0] range.
44- Setting: `inactive_opacity`
45- Default: `1.0`
46
47**Options**
48
49`float` values
50
51## Bottom Dock Layout
52
53- Description: Control the layout of the bottom dock, relative to the left and right docks.
54- Setting: `bottom_dock_layout`
55- Default: `"contained"`
56
57**Options**
58
591. Contain the bottom dock, giving the full height of the window to the left and right docks.
60
61```json [settings]
62{
63 "bottom_dock_layout": "contained"
64}
65```
66
672. Give the bottom dock the full width of the window, truncating the left and right docks.
68
69```json [settings]
70{
71 "bottom_dock_layout": "full"
72}
73```
74
753. Left align the bottom dock, truncating the left dock and giving the right dock the full height of the window.
76
77```json [settings]
78{
79 "bottom_dock_layout": "left_aligned"
80}
81```
82
834. Right align the bottom dock, giving the left dock the full height of the window and truncating the right dock.
84
85```json [settings]
86{
87 "bottom_dock_layout": "right_aligned"
88}
89```
90
91## Agent Font Size
92
93- Description: The font size for text in the agent panel. Inherits the UI font size if unset.
94- Setting: `agent_font_size`
95- Default: `null`
96
97**Options**
98
99`integer` values from `6` to `100` pixels (inclusive)
100
101## Allow Rewrap
102
103- Description: Controls where the {#action editor::Rewrap} action is allowed in the current language scope
104- Setting: `allow_rewrap`
105- Default: `"in_comments"`
106
107**Options**
108
1091. Allow rewrap in comments only:
110
111```json [settings]
112{
113 "allow_rewrap": "in_comments"
114}
115```
116
1172. Allow rewrap in selections only:
118
119```json [settings]
120{
121 "allow_rewrap": "in_selections"
122}
123```
124
1253. Allow rewrap anywhere:
126
127```json [settings]
128{
129 "allow_rewrap": "anywhere"
130}
131```
132
133Note: This setting has no effect in Vim mode, as rewrap is already allowed everywhere.
134
135## Auto Indent
136
137- Description: Whether indentation should be adjusted based on context while typing. This can be specified on a per-language basis.
138- Setting: `auto_indent`
139- Default: `true`
140
141**Options**
142
143`boolean` values
144
145## Auto Indent On Paste
146
147- Description: Whether indentation of pasted content should be adjusted based on the context
148- Setting: `auto_indent_on_paste`
149- Default: `true`
150
151**Options**
152
153`boolean` values
154
155## Auto Install extensions
156
157- Description: Define extensions to install automatically or never install.
158- Setting: `auto_install_extensions`
159- Default: `{ "html": true }`
160
161**Options**
162
163You can find the names of your currently installed extensions by listing the subfolders under the [extension installation location](../extensions/installing-extensions.md#installation-location):
164
165On macOS:
166
167```sh
168ls ~/Library/Application\ Support/Zed/extensions/installed/
169```
170
171On Linux:
172
173```sh
174ls ~/.local/share/zed/extensions/installed
175```
176
177Define extensions which should be installed (`true`) or never installed (`false`).
178
179```json [settings]
180{
181 "auto_install_extensions": {
182 "html": true,
183 "dockerfile": true,
184 "docker-compose": false
185 }
186}
187```
188
189## Autosave
190
191- Description: When to automatically save edited buffers.
192- Setting: `autosave`
193- Default: `off`
194
195**Options**
196
1971. To disable autosave, set it to `off`:
198
199```json [settings]
200{
201 "autosave": "off"
202}
203```
204
2052. To autosave when focus changes, use `on_focus_change`:
206
207```json [settings]
208{
209 "autosave": "on_focus_change"
210}
211```
212
2133. To autosave when the active window changes, use `on_window_change`:
214
215```json [settings]
216{
217 "autosave": "on_window_change"
218}
219```
220
2214. To autosave after an inactivity period, use `after_delay`:
222
223```json [settings]
224{
225 "autosave": {
226 "after_delay": {
227 "milliseconds": 1000
228 }
229 }
230}
231```
232
233Note that a save will be triggered when an unsaved tab is closed, even if this is earlier than the configured inactivity period.
234
235## Autoscroll on Clicks
236
237- Description: Whether to scroll when clicking near the edge of the visible text area.
238- Setting: `autoscroll_on_clicks`
239- Default: `false`
240
241**Options**
242
243`boolean` values
244
245## Auto Signature Help
246
247- Description: Show method signatures in the editor when inside parentheses.
248- Setting: `auto_signature_help`
249- Default: `false`
250
251**Options**
252
253`boolean` values
254
255### Show Signature Help After Edits
256
257- 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.
258- Setting: `show_signature_help_after_edits`
259- Default: `false`
260
261**Options**
262
263`boolean` values
264
265## Auto Update
266
267- Description: Whether or not to automatically check for updates.
268- Setting: `auto_update`
269- Default: `true`
270
271**Options**
272
273`boolean` values
274
275## Base Keymap
276
277- Description: Base key bindings scheme. Base keymaps can be overridden with user keymaps.
278- Setting: `base_keymap`
279- Default: `VSCode`
280
281**Options**
282
2831. VS Code
284
285```json [settings]
286{
287 "base_keymap": "VSCode"
288}
289```
290
2912. Atom
292
293```json [settings]
294{
295 "base_keymap": "Atom"
296}
297```
298
2993. JetBrains
300
301```json [settings]
302{
303 "base_keymap": "JetBrains"
304}
305```
306
3074. None
308
309```json [settings]
310{
311 "base_keymap": "None"
312}
313```
314
3155. Sublime Text
316
317```json [settings]
318{
319 "base_keymap": "SublimeText"
320}
321```
322
3236. TextMate
324
325```json [settings]
326{
327 "base_keymap": "TextMate"
328}
329```
330
331## Buffer Font Family
332
333- Description: The name of a font to use for rendering text in the editor.
334- Setting: `buffer_font_family`
335- Default: `.ZedMono`. This currently aliases to [Lilex](https://lilex.myrt.co).
336
337**Options**
338
339The name of any font family installed on the user's system, or `".ZedMono"`.
340
341## Buffer Font Features
342
343- Description: The OpenType features to enable for text in the editor.
344- Setting: `buffer_font_features`
345- Default: `null`
346- Platform: macOS and Windows.
347
348**Options**
349
350Zed 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.
351
352For example, to disable font ligatures, add the following to your settings:
353
354```json [settings]
355{
356 "buffer_font_features": {
357 "calt": false
358 }
359}
360```
361
362You can also set other OpenType features, like setting `cv01` to `7`:
363
364```json [settings]
365{
366 "buffer_font_features": {
367 "cv01": 7
368 }
369}
370```
371
372## Buffer Font Fallbacks
373
374- Description: Set the buffer text's font fallbacks, this will be merged with the platform's default fallbacks.
375- Setting: `buffer_font_fallbacks`
376- Default: `null`
377- Platform: macOS and Windows.
378
379**Options**
380
381For example, to use `Nerd Font` as a fallback, add the following to your settings:
382
383```json [settings]
384{
385 "buffer_font_fallbacks": ["Nerd Font"]
386}
387```
388
389## Buffer Font Size
390
391- Description: The default font size for text in the editor.
392- Setting: `buffer_font_size`
393- Default: `15`
394
395**Options**
396
397A font size from `6` to `100` pixels (inclusive)
398
399## Buffer Font Weight
400
401- Description: The default font weight for text in the editor.
402- Setting: `buffer_font_weight`
403- Default: `400`
404
405**Options**
406
407`integer` values between `100` and `900`
408
409## Buffer Line Height
410
411- Description: The default line height for text in the editor.
412- Setting: `buffer_line_height`
413- Default: `"comfortable"`
414
415**Options**
416
417`"standard"`, `"comfortable"` or `{ "custom": float }` (`1` is compact, `2` is loose)
418
419## Centered Layout
420
421- Description: Configuration for the centered layout mode.
422- Setting: `centered_layout`
423- Default:
424
425```json [settings]
426{
427 "centered_layout": {
428 "left_padding": 0.2,
429 "right_padding": 0.2
430 }
431}
432```
433
434**Options**
435
436The `left_padding` and `right_padding` options define the relative width of the
437left 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`.
438
439## Close on File Delete
440
441- Description: Whether to automatically close editor tabs when their corresponding files are deleted from disk.
442- Setting: `close_on_file_delete`
443- Default: `false`
444
445**Options**
446
447`boolean` values
448
449When 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.
450
451Note: Dirty files (files with unsaved changes) will not be automatically closed even when this setting is enabled, ensuring you don't lose unsaved work.
452
453## Confirm Quit
454
455- Description: Whether or not to prompt the user to confirm before closing the application.
456- Setting: `confirm_quit`
457- Default: `false`
458
459**Options**
460
461`boolean` values
462
463## Diagnostics Max Severity
464
465- Description: Which level to use to filter out diagnostics displayed in the editor
466- Setting: `diagnostics_max_severity`
467- Default: `null`
468
469**Options**
470
4711. Allow all diagnostics (default):
472
473```json [settings]
474{
475 "diagnostics_max_severity": "all"
476}
477```
478
4792. Show only errors:
480
481```json [settings]
482{
483 "diagnostics_max_severity": "error"
484}
485```
486
4873. Show errors and warnings:
488
489```json [settings]
490{
491 "diagnostics_max_severity": "warning"
492}
493```
494
4954. Show errors, warnings, and information:
496
497```json [settings]
498{
499 "diagnostics_max_severity": "info"
500}
501```
502
5035. Show all including hints:
504
505```json [settings]
506{
507 "diagnostics_max_severity": "hint"
508}
509```
510
511## Diff View Style
512
513- Description: How to display diffs in the editor.
514- Setting: `diff_view_style`
515- Default: `"split"`
516
517**Options**
518
519- `"unified"`: Show changes inline with added and deleted lines stacked vertically
520- `"split"`: Display old and new versions side by side in separate panes (default)
521
522See [Git documentation](../git.md#diff-view-styles) for more details.
523
524## Disable AI
525
526- Description: Whether to disable all AI features in Zed
527- Setting: `disable_ai`
528- Default: `false`
529
530**Options**
531
532`boolean` values
533
534## Direnv Integration
535
536- Description: Settings for [direnv](https://direnv.net/) integration. Requires `direnv` to be installed.
537 `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.
538 It also allows for those environment variables to be used in tasks.
539- Setting: `load_direnv`
540- Default: `"direct"`
541
542**Options**
543
544There are three options to choose from:
545
5461. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
5472. `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.
5483. `disabled`: No shell environment will be loaded automatically; direnv must be invoked manually (e.g. with `direnv exec`) to be used.
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 [settings]
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 [settings]
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 [settings]
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 [settings]
631{
632 "edit_predictions_disabled_in": ["comment"]
633}
634```
635
6362. Don't show edit predictions in strings and comments:
637
638```json [settings]
639{
640 "edit_predictions_disabled_in": ["comment", "string"]
641}
642```
643
6443. Only in Go, don't show edit predictions in strings and comments:
645
646```json [settings]
647{
648 "languages": {
649 "Go": {
650 "edit_predictions_disabled_in": ["comment", "string"]
651 }
652 }
653}
654```
655
656## Current Line Highlight
657
658- Description: How to highlight the current line in the editor.
659- Setting: `current_line_highlight`
660- Default: `all`
661
662**Options**
663
6641. Don't highlight the current line:
665
666```json [settings]
667{
668 "current_line_highlight": "none"
669}
670```
671
6722. Highlight the gutter area:
673
674```json [settings]
675{
676 "current_line_highlight": "gutter"
677}
678```
679
6803. Highlight the editor area:
681
682```json [settings]
683{
684 "current_line_highlight": "line"
685}
686```
687
6884. Highlight the full line:
689
690```json [settings]
691{
692 "current_line_highlight": "all"
693}
694```
695
696## Selection Highlight
697
698- Description: Whether to highlight all occurrences of the selected text in an editor.
699- Setting: `selection_highlight`
700- Default: `true`
701
702## Rounded Selection
703
704- Description: Whether the text selection should have rounded corners.
705- Setting: `rounded_selection`
706- Default: `true`
707
708## Cursor Blink
709
710- Description: Whether or not the cursor blinks.
711- Setting: `cursor_blink`
712- Default: `true`
713
714**Options**
715
716`boolean` values
717
718## Cursor Shape
719
720- Description: Cursor shape for the default editor.
721- Setting: `cursor_shape`
722- Default: `bar`
723
724**Options**
725
7261. A vertical bar:
727
728```json [settings]
729{
730 "cursor_shape": "bar"
731}
732```
733
7342. A block that surrounds the following character:
735
736```json [settings]
737{
738 "cursor_shape": "block"
739}
740```
741
7423. An underline / underscore that runs along the following character:
743
744```json [settings]
745{
746 "cursor_shape": "underline"
747}
748```
749
7504. An box drawn around the following character:
751
752```json [settings]
753{
754 "cursor_shape": "hollow"
755}
756```
757
758## Gutter
759
760- Description: Settings for the editor gutter
761- Setting: `gutter`
762- Default:
763
764```json [settings]
765{
766 "gutter": {
767 "line_numbers": true,
768 "runnables": true,
769 "breakpoints": true,
770 "folds": true,
771 "min_line_number_digits": 4
772 }
773}
774```
775
776**Options**
777
778- `line_numbers`: Whether to show line numbers in the gutter
779- `runnables`: Whether to show runnable buttons in the gutter
780- `breakpoints`: Whether to show breakpoints in the gutter
781- `folds`: Whether to show fold buttons in the gutter
782- `min_line_number_digits`: Minimum number of characters to reserve space for in the gutter
783
784## Hide Mouse
785
786- Description: Determines when the mouse cursor should be hidden in an editor or input box.
787- Setting: `hide_mouse`
788- Default: `on_typing_and_movement`
789
790**Options**
791
7921. Never hide the mouse cursor:
793
794```json [settings]
795{
796 "hide_mouse": "never"
797}
798```
799
8002. Hide only when typing:
801
802```json [settings]
803{
804 "hide_mouse": "on_typing"
805}
806```
807
8083. Hide on both typing and cursor movement:
809
810```json [settings]
811{
812 "hide_mouse": "on_typing_and_movement"
813}
814```
815
816## Snippet Sort Order
817
818- Description: Determines how snippets are sorted relative to other completion items.
819- Setting: `snippet_sort_order`
820- Default: `inline`
821
822**Options**
823
8241. Place snippets at the top of the completion list:
825
826```json [settings]
827{
828 "snippet_sort_order": "top"
829}
830```
831
8322. Place snippets normally without any preference:
833
834```json [settings]
835{
836 "snippet_sort_order": "inline"
837}
838```
839
8403. Place snippets at the bottom of the completion list:
841
842```json [settings]
843{
844 "snippet_sort_order": "bottom"
845}
846```
847
8484. Do not show snippets in the completion list at all:
849
850```json [settings]
851{
852 "snippet_sort_order": "none"
853}
854```
855
856## Editor Scrollbar
857
858- Description: Whether or not to show the editor scrollbar and various elements in it.
859- Setting: `scrollbar`
860- Default:
861
862```json [settings]
863{
864 "scrollbar": {
865 "show": "auto",
866 "cursors": true,
867 "git_diff": true,
868 "search_results": true,
869 "selected_text": true,
870 "selected_symbol": true,
871 "diagnostics": "all",
872 "axes": {
873 "horizontal": true,
874 "vertical": true
875 }
876 }
877}
878```
879
880### Show Mode
881
882- Description: When to show the editor scrollbar.
883- Setting: `show`
884- Default: `auto`
885
886**Options**
887
8881. Show the scrollbar if there's important information or follow the system's configured behavior:
889
890```json [settings]
891{
892 "scrollbar": {
893 "show": "auto"
894 }
895}
896```
897
8982. Match the system's configured behavior:
899
900```json [settings]
901{
902 "scrollbar": {
903 "show": "system"
904 }
905}
906```
907
9083. Always show the scrollbar:
909
910```json [settings]
911{
912 "scrollbar": {
913 "show": "always"
914 }
915}
916```
917
9184. Never show the scrollbar:
919
920```json [settings]
921{
922 "scrollbar": {
923 "show": "never"
924 }
925}
926```
927
928### Cursor Indicators
929
930- Description: Whether to show cursor positions in the scrollbar.
931- Setting: `cursors`
932- Default: `true`
933
934Cursor indicators appear as small marks on the scrollbar showing where other collaborators' cursors are positioned in the file.
935
936**Options**
937
938`boolean` values
939
940### Git Diff Indicators
941
942- Description: Whether to show git diff indicators in the scrollbar.
943- Setting: `git_diff`
944- Default: `true`
945
946Git diff indicators appear as colored marks showing lines that have been added, modified, or deleted compared to the git HEAD.
947
948**Options**
949
950`boolean` values
951
952### Search Results Indicators
953
954- Description: Whether to show buffer search results in the scrollbar.
955- Setting: `search_results`
956- Default: `true`
957
958Search result indicators appear as marks showing all locations in the file where your current search query matches.
959
960**Options**
961
962`boolean` values
963
964### Selected Text Indicators
965
966- Description: Whether to show selected text occurrences in the scrollbar.
967- Setting: `selected_text`
968- Default: `true`
969
970Selected text indicators appear as marks showing all occurrences of the currently selected text throughout the file.
971
972**Options**
973
974`boolean` values
975
976### Selected Symbols Indicators
977
978- Description: Whether to show selected symbol occurrences in the scrollbar.
979- Setting: `selected_symbol`
980- Default: `true`
981
982Selected symbol indicators appear as marks showing all occurrences of the currently selected symbol (like a function or variable name) throughout the file.
983
984**Options**
985
986`boolean` values
987
988### Diagnostics
989
990- Description: Which diagnostic indicators to show in the scrollbar.
991- Setting: `diagnostics`
992- Default: `all`
993
994Diagnostic indicators appear as colored marks showing errors, warnings, and other language server diagnostics at their corresponding line positions in the file.
995
996**Options**
997
9981. Show all diagnostics:
999
1000```json [settings]
1001{
1002 "scrollbar": {
1003 "diagnostics": "all"
1004 }
1005}
1006```
1007
10082. Do not show any diagnostics:
1009
1010```json [settings]
1011{
1012 "scrollbar": {
1013 "diagnostics": "none"
1014 }
1015}
1016```
1017
10183. Show only errors:
1019
1020```json [settings]
1021{
1022 "scrollbar": {
1023 "diagnostics": "error"
1024 }
1025}
1026```
1027
10284. Show only errors and warnings:
1029
1030```json [settings]
1031{
1032 "scrollbar": {
1033 "diagnostics": "warning"
1034 }
1035}
1036```
1037
10385. Show only errors, warnings, and information:
1039
1040```json [settings]
1041{
1042 "scrollbar": {
1043 "diagnostics": "information"
1044 }
1045}
1046```
1047
1048### Axes
1049
1050- Description: Forcefully enable or disable the scrollbar for each axis
1051- Setting: `axes`
1052- Default:
1053
1054```json [settings]
1055{
1056 "scrollbar": {
1057 "axes": {
1058 "horizontal": true,
1059 "vertical": true
1060 }
1061 }
1062}
1063```
1064
1065#### Horizontal
1066
1067- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
1068- Setting: `horizontal`
1069- Default: `true`
1070
1071**Options**
1072
1073`boolean` values
1074
1075#### Vertical
1076
1077- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
1078- Setting: `vertical`
1079- Default: `true`
1080
1081**Options**
1082
1083`boolean` values
1084
1085## Minimap
1086
1087- Description: Settings related to the editor's minimap, which provides an overview of your document.
1088- Setting: `minimap`
1089- Default:
1090
1091```json [settings]
1092{
1093 "minimap": {
1094 "show": "never",
1095 "thumb": "always",
1096 "thumb_border": "left_open",
1097 "current_line_highlight": null
1098 }
1099}
1100```
1101
1102### Show Mode
1103
1104- Description: When to show the minimap in the editor.
1105- Setting: `show`
1106- Default: `never`
1107
1108**Options**
1109
11101. Always show the minimap:
1111
1112```json [settings]
1113{
1114 "minimap": {
1115 "show": "always"
1116 }
1117}
1118```
1119
11202. Show the minimap if the editor's scrollbars are visible:
1121
1122```json [settings]
1123{
1124 "minimap": {
1125 "show": "auto"
1126 }
1127}
1128```
1129
11303. Never show the minimap:
1131
1132```json [settings]
1133{
1134 "minimap": {
1135 "show": "never"
1136 }
1137}
1138```
1139
1140### Thumb Display
1141
1142- Description: When to show the minimap thumb (the visible editor area) in the minimap.
1143- Setting: `thumb`
1144- Default: `always`
1145
1146**Options**
1147
11481. Show the minimap thumb when hovering over the minimap:
1149
1150```json [settings]
1151{
1152 "minimap": {
1153 "thumb": "hover"
1154 }
1155}
1156```
1157
11582. Always show the minimap thumb:
1159
1160```json [settings]
1161{
1162 "minimap": {
1163 "thumb": "always"
1164 }
1165}
1166```
1167
1168### Thumb Border
1169
1170- Description: How the minimap thumb border should look.
1171- Setting: `thumb_border`
1172- Default: `left_open`
1173
1174**Options**
1175
11761. Display a border on all sides of the thumb:
1177
1178```json [settings]
1179{
1180 "minimap": {
1181 "thumb_border": "full"
1182 }
1183}
1184```
1185
11862. Display a border on all sides except the left side:
1187
1188```json [settings]
1189{
1190 "minimap": {
1191 "thumb_border": "left_open"
1192 }
1193}
1194```
1195
11963. Display a border on all sides except the right side:
1197
1198```json [settings]
1199{
1200 "minimap": {
1201 "thumb_border": "right_open"
1202 }
1203}
1204```
1205
12064. Display a border only on the left side:
1207
1208```json [settings]
1209{
1210 "minimap": {
1211 "thumb_border": "left_only"
1212 }
1213}
1214```
1215
12165. Display the thumb without any border:
1217
1218```json [settings]
1219{
1220 "minimap": {
1221 "thumb_border": "none"
1222 }
1223}
1224```
1225
1226### Current Line Highlight
1227
1228- Description: How to highlight the current line in the minimap.
1229- Setting: `current_line_highlight`
1230- Default: `null`
1231
1232**Options**
1233
12341. Inherit the editor's current line highlight setting:
1235
1236```json [settings]
1237{
1238 "minimap": {
1239 "current_line_highlight": null
1240 }
1241}
1242```
1243
12442. Highlight the current line in the minimap:
1245
1246```json [settings]
1247{
1248 "minimap": {
1249 "current_line_highlight": "line"
1250 }
1251}
1252```
1253
1254or
1255
1256```json [settings]
1257{
1258 "minimap": {
1259 "current_line_highlight": "all"
1260 }
1261}
1262```
1263
12643. Do not highlight the current line in the minimap:
1265
1266```json [settings]
1267{
1268 "minimap": {
1269 "current_line_highlight": "gutter"
1270 }
1271}
1272```
1273
1274or
1275
1276```json [settings]
1277{
1278 "minimap": {
1279 "current_line_highlight": "none"
1280 }
1281}
1282```
1283
1284## Editor Tab Bar
1285
1286- Description: Settings related to the editor's tab bar.
1287- Settings: `tab_bar`
1288- Default:
1289
1290```json [settings]
1291{
1292 "tab_bar": {
1293 "show": true,
1294 "show_nav_history_buttons": true,
1295 "show_tab_bar_buttons": true
1296 }
1297}
1298```
1299
1300### Show
1301
1302- Description: Whether or not to show the tab bar in the editor.
1303- Setting: `show`
1304- Default: `true`
1305
1306**Options**
1307
1308`boolean` values
1309
1310### Navigation History Buttons
1311
1312- Description: Whether or not to show the navigation history buttons.
1313- Setting: `show_nav_history_buttons`
1314- Default: `true`
1315
1316**Options**
1317
1318`boolean` values
1319
1320### Tab Bar Buttons
1321
1322- Description: Whether or not to show the tab bar buttons.
1323- Setting: `show_tab_bar_buttons`
1324- Default: `true`
1325
1326**Options**
1327
1328`boolean` values
1329
1330## Editor Tabs
1331
1332- Description: Configuration for the editor tabs.
1333- Setting: `tabs`
1334- Default:
1335
1336```json [settings]
1337{
1338 "tabs": {
1339 "close_position": "right",
1340 "file_icons": false,
1341 "git_status": false,
1342 "activate_on_close": "history",
1343 "show_close_button": "hover",
1344 "show_diagnostics": "off"
1345 }
1346}
1347```
1348
1349### Close Position
1350
1351- Description: Where to display close button within a tab.
1352- Setting: `close_position`
1353- Default: `right`
1354
1355**Options**
1356
13571. Display the close button on the right:
1358
1359```json [settings]
1360{
1361 "tabs": {
1362 "close_position": "right"
1363 }
1364}
1365```
1366
13672. Display the close button on the left:
1368
1369```json [settings]
1370{
1371 "tabs": {
1372 "close_position": "left"
1373 }
1374}
1375```
1376
1377### File Icons
1378
1379- Description: Whether to show the file icon for a tab.
1380- Setting: `file_icons`
1381- Default: `false`
1382
1383### Git Status
1384
1385- Description: Whether or not to show Git file status in tab.
1386- Setting: `git_status`
1387- Default: `false`
1388
1389### Activate on close
1390
1391- Description: What to do after closing the current tab.
1392- Setting: `activate_on_close`
1393- Default: `history`
1394
1395**Options**
1396
13971. Activate the tab that was open previously:
1398
1399```json [settings]
1400{
1401 "tabs": {
1402 "activate_on_close": "history"
1403 }
1404}
1405```
1406
14072. Activate the right neighbour tab if present:
1408
1409```json [settings]
1410{
1411 "tabs": {
1412 "activate_on_close": "neighbour"
1413 }
1414}
1415```
1416
14173. Activate the left neighbour tab if present:
1418
1419```json [settings]
1420{
1421 "tabs": {
1422 "activate_on_close": "left_neighbour"
1423 }
1424}
1425```
1426
1427### Show close button
1428
1429- Description: Controls the appearance behavior of the tab's close button.
1430- Setting: `show_close_button`
1431- Default: `hover`
1432
1433**Options**
1434
14351. Show it just upon hovering the tab:
1436
1437```json [settings]
1438{
1439 "tabs": {
1440 "show_close_button": "hover"
1441 }
1442}
1443```
1444
14452. Show it persistently:
1446
1447```json [settings]
1448{
1449 "tabs": {
1450 "show_close_button": "always"
1451 }
1452}
1453```
1454
14553. Never show it, even if hovering it:
1456
1457```json [settings]
1458{
1459 "tabs": {
1460 "show_close_button": "hidden"
1461 }
1462}
1463```
1464
1465### Show Diagnostics
1466
1467- 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.
1468- Setting: `show_diagnostics`
1469- Default: `off`
1470
1471**Options**
1472
14731. Do not mark any files:
1474
1475```json [settings]
1476{
1477 "tabs": {
1478 "show_diagnostics": "off"
1479 }
1480}
1481```
1482
14832. Only mark files with errors:
1484
1485```json [settings]
1486{
1487 "tabs": {
1488 "show_diagnostics": "errors"
1489 }
1490}
1491```
1492
14933. Mark files with errors and warnings:
1494
1495```json [settings]
1496{
1497 "tabs": {
1498 "show_diagnostics": "all"
1499 }
1500}
1501```
1502
1503### Show Inline Code Actions
1504
1505- Description: Whether to show code action button at start of buffer line.
1506- Setting: `inline_code_actions`
1507- Default: `true`
1508
1509**Options**
1510
1511`boolean` values
1512
1513### Session
1514
1515- Description: Controls Zed lifecycle-related behavior.
1516- Setting: `session`
1517- Default:
1518
1519```json
1520{
1521 "session": {
1522 "restore_unsaved_buffers": true,
1523 "trust_all_worktrees": false
1524 }
1525}
1526```
1527
1528**Options**
1529
15301. Whether or not to restore unsaved buffers on restart:
1531
1532```json [settings]
1533{
1534 "session": {
1535 "restore_unsaved_buffers": true
1536 }
1537}
1538```
1539
1540If this is true, user won't be prompted whether to save/discard dirty files when closing the application.
1541
15422. Whether or not to skip worktree and workspace trust checks:
1543
1544```json [settings]
1545{
1546 "session": {
1547 "trust_all_worktrees": false
1548 }
1549}
1550```
1551
1552When trusted, project settings are synchronized automatically, language and MCP servers are downloaded and started automatically.
1553
1554### Drag And Drop Selection
1555
1556- 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.
1557- Setting: `drag_and_drop_selection`
1558- Default:
1559
1560```json [settings]
1561{
1562 "drag_and_drop_selection": {
1563 "enabled": true,
1564 "delay": 300
1565 }
1566}
1567```
1568
1569## Editor Toolbar
1570
1571- Description: Whether or not to show various elements in the editor toolbar.
1572- Setting: `toolbar`
1573- Default:
1574
1575```json [settings]
1576{
1577 "toolbar": {
1578 "breadcrumbs": true,
1579 "quick_actions": true,
1580 "selections_menu": true,
1581 "agent_review": true,
1582 "code_actions": false
1583 }
1584}
1585```
1586
1587**Options**
1588
1589Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
1590
1591## Use System Tabs
1592
1593- Description: Whether to allow windows to tab together based on the user’s tabbing preference (macOS only).
1594- Setting: `use_system_window_tabs`
1595- Default: `false`
1596
1597**Options**
1598
1599This 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.
1600
1601## Enable Language Server
1602
1603- Description: Whether or not to use language servers to provide code intelligence.
1604- Setting: `enable_language_server`
1605- Default: `true`
1606
1607**Options**
1608
1609`boolean` values
1610
1611## Ensure Final Newline On Save
1612
1613- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
1614- Setting: `ensure_final_newline_on_save`
1615- Default: `true`
1616
1617**Options**
1618
1619`boolean` values
1620
1621## Expand Excerpt Lines
1622
1623- Description: The default number of lines to expand excerpts in the multibuffer by
1624- Setting: `expand_excerpt_lines`
1625- Default: `5`
1626
1627**Options**
1628
1629Positive `integer` values
1630
1631## Excerpt Context Lines
1632
1633- Description: The number of lines of context to provide when showing excerpts in the multibuffer.
1634- Setting: `excerpt_context_lines`
1635- Default: `2`
1636
1637**Options**
1638
1639Positive `integer` value between 1 and 32. Values outside of this range will be clamped to this range.
1640
1641## Extend Comment On Newline
1642
1643- Description: Whether to start a new line with a comment when a previous line is a comment as well.
1644- Setting: `extend_comment_on_newline`
1645- Default: `true`
1646
1647**Options**
1648
1649`boolean` values
1650
1651## Status Bar
1652
1653- Description: Control various elements in the status bar. Note that some items in the status bar have their own settings set elsewhere.
1654- Setting: `status_bar`
1655- Default:
1656
1657```json [settings]
1658{
1659 "status_bar": {
1660 "active_language_button": true,
1661 "cursor_position_button": true,
1662 "line_endings_button": false
1663 }
1664}
1665```
1666
1667There is an experimental setting that completely hides the status bar. This causes major usability problems (you will be unable to use many of Zed's features), but is provided for those who value screen real-estate above all else.
1668
1669```json
1670"status_bar": {
1671 "experimental.show": false
1672}
1673```
1674
1675## LSP
1676
1677- Description: Configuration for language servers.
1678- Setting: `lsp`
1679- Default: `null`
1680
1681**Options**
1682
1683The following settings can be overridden for specific language servers:
1684
1685- `initialization_options`
1686- `settings`
1687
1688To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1689
1690Some 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.
1691
1692For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1693
1694```json [settings]
1695{
1696 "lsp": {
1697 "rust-analyzer": {
1698 "initialization_options": {
1699 "check": {
1700 "command": "clippy" // rust-analyzer.check.command (default: "check")
1701 }
1702 }
1703 }
1704 }
1705}
1706```
1707
1708While other options may be changed at a runtime and should be placed under `settings`:
1709
1710```json [settings]
1711{
1712 "lsp": {
1713 "yaml-language-server": {
1714 "settings": {
1715 "yaml": {
1716 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1717 }
1718 }
1719 }
1720 }
1721}
1722```
1723
1724## Global LSP Settings
1725
1726- Description: Configuration for global LSP settings that apply to all language servers
1727- Setting: `global_lsp_settings`
1728- Default:
1729
1730```json [settings]
1731{
1732 "global_lsp_settings": {
1733 "button": true,
1734 "request_timeout": 120,
1735 "notifications": {
1736 // Timeout in milliseconds for automatically dismissing language server notifications.
1737 // Set to 0 to disable auto-dismiss.
1738 "dismiss_timeout_ms": 5000
1739 }
1740 }
1741}
1742```
1743
1744**Options**
1745
1746- `button`: Whether to show the LSP status button in the status bar
1747- `request_timeout`: The maximum amount of time to wait for responses from language servers, in seconds. A value of `0` will result in no timeout being applied (causing all LSP responses to wait indefinitely until completed). Default: `120`
1748- `notifications`: Notification-related settings.
1749 - `dismiss_timeout_ms`: Timeout in milliseconds for automatically dismissing language server notifications. Set to 0 to disable auto-dismiss.
1750
1751## LSP Highlight Debounce
1752
1753- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1754- Setting: `lsp_highlight_debounce`
1755- Default: `75`
1756
1757**Options**
1758
1759`integer` values representing milliseconds
1760
1761## Features
1762
1763- Description: Features that can be globally enabled or disabled
1764- Setting: `features`
1765- Default:
1766
1767```json [settings]
1768{
1769 "edit_predictions": {
1770 "provider": "zed"
1771 }
1772}
1773```
1774
1775### Edit Prediction Provider
1776
1777- Description: Which edit prediction provider to use
1778- Setting: `edit_prediction_provider`
1779- Default: `"zed"`
1780
1781**Options**
1782
17831. Use Zeta as the edit prediction provider:
1784
1785```json [settings]
1786{
1787 "edit_predictions": {
1788 "provider": "zed"
1789 }
1790}
1791```
1792
17932. Use Copilot as the edit prediction provider:
1794
1795```json [settings]
1796{
1797 "edit_predictions": {
1798 "provider": "copilot"
1799 }
1800}
1801```
1802
18033. Turn off edit predictions across all providers
1804
1805```json [settings]
1806{
1807 "edit_predictions": {
1808 "provider": "none"
1809 }
1810}
1811```
1812
1813## Format On Save
1814
1815- Description: Whether or not to perform a buffer format before saving.
1816- Setting: `format_on_save`
1817- Default: `on`
1818
1819**Options**
1820
18211. `on`, enables format on save obeying `formatter` setting:
1822
1823```json [settings]
1824{
1825 "format_on_save": "on"
1826}
1827```
1828
18292. `off`, disables format on save:
1830
1831```json [settings]
1832{
1833 "format_on_save": "off"
1834}
1835```
1836
1837## Formatter
1838
1839- Description: How to perform a buffer format.
1840- Setting: `formatter`
1841- Default: `auto`
1842
1843**Options**
1844
18451. To use the current language server, use `"language_server"`:
1846
1847```json [settings]
1848{
1849 "formatter": "language_server"
1850}
1851```
1852
18532. 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):
1854
1855```json [settings]
1856{
1857 "formatter": {
1858 "external": {
1859 "command": "sed",
1860 "arguments": ["-e", "s/ *$//"]
1861 }
1862 }
1863}
1864```
1865
18663. 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.
1867
1868WARNING: `{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.
1869
1870```json [settings]
1871 "formatter": {
1872 "external": {
1873 "command": "prettier",
1874 "arguments": ["--stdin-filepath", "{buffer_path}"]
1875 }
1876 }
1877```
1878
18794. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1880
1881```json [settings]
1882{
1883 "formatter": [
1884 // Use ESLint's --fix:
1885 { "code_action": "source.fixAll.eslint" },
1886 // Organize imports on save:
1887 { "code_action": "source.organizeImports" }
1888 ]
1889}
1890```
1891
18925. Or to use multiple formatters consecutively, use an array of formatters:
1893
1894```json [settings]
1895{
1896 "formatter": [
1897 { "language_server": { "name": "rust-analyzer" } },
1898 {
1899 "external": {
1900 "command": "sed",
1901 "arguments": ["-e", "s/ *$//"]
1902 }
1903 }
1904 ]
1905}
1906```
1907
1908Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1909If any of the formatters fails, the subsequent ones will still be executed.
1910
19116. To disable the formatter, use `"none"`. This setting disables the configured formatter, but any actions in `code_actions_on_format` will still be executed:
1912
1913```json [settings]
1914{
1915 "formatter": "none"
1916}
1917```
1918
1919## Auto close
1920
1921- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1922- Setting: `use_autoclose`
1923- Default: `true`
1924
1925**Options**
1926
1927`boolean` values
1928
1929## Always Treat Brackets As Autoclosed
1930
1931- Description: Controls how the editor handles the autoclosed characters.
1932- Setting: `always_treat_brackets_as_autoclosed`
1933- Default: `false`
1934
1935**Options**
1936
1937`boolean` values
1938
1939**Example**
1940
1941If the setting is set to `true`:
1942
19431. Enter in the editor: `)))`
19442. Move the cursor to the start: `^)))`
19453. Enter again: `)))`
1946
1947The result is still `)))` and not `))))))`, which is what it would be by default.
1948
1949## File Scan Exclusions
1950
1951- Setting: `file_scan_exclusions`
1952- 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`.
1953- Default:
1954
1955```json [settings]
1956{
1957 "file_scan_exclusions": [
1958 "**/.git",
1959 "**/.svn",
1960 "**/.hg",
1961 "**/.jj",
1962 "**/CVS",
1963 "**/.DS_Store",
1964 "**/Thumbs.db",
1965 "**/.classpath",
1966 "**/.settings"
1967 ]
1968}
1969```
1970
1971Note, 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.
1972
1973## File Scan Inclusions
1974
1975- Setting: `file_scan_inclusions`
1976- 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.
1977- Default:
1978
1979```json [settings]
1980{
1981 "file_scan_inclusions": [".env*"]
1982}
1983```
1984
1985## File Types
1986
1987- Setting: `file_types`
1988- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1989- Default:
1990
1991```json [settings]
1992{
1993 "file_types": {
1994 "JSONC": [
1995 "**/.zed/**/*.json",
1996 "**/zed/**/*.json",
1997 "**/Zed/**/*.json",
1998 "**/.vscode/**/*.json"
1999 ],
2000 "Shell Script": [".env.*"]
2001 }
2002}
2003```
2004
2005**Examples**
2006
2007To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
2008
2009```json [settings]
2010{
2011 "file_types": {
2012 "C++": ["c"],
2013 "TOML": ["MyLockFile"],
2014 "Dockerfile": ["Dockerfile*"]
2015 }
2016}
2017```
2018
2019## Diagnostics
2020
2021- Description: Configuration for diagnostics-related features.
2022- Setting: `diagnostics`
2023- Default:
2024
2025```json [settings]
2026{
2027 "diagnostics": {
2028 "include_warnings": true,
2029 "inline": {
2030 "enabled": false
2031 }
2032 }
2033}
2034```
2035
2036### Inline Diagnostics
2037
2038- Description: Whether or not to show diagnostics information inline.
2039- Setting: `inline`
2040- Default:
2041
2042```json [settings]
2043{
2044 "diagnostics": {
2045 "inline": {
2046 "enabled": false,
2047 "update_debounce_ms": 150,
2048 "padding": 4,
2049 "min_column": 0,
2050 "max_severity": null
2051 }
2052 }
2053}
2054```
2055
2056**Options**
2057
20581. Enable inline diagnostics.
2059
2060```json [settings]
2061{
2062 "diagnostics": {
2063 "inline": {
2064 "enabled": true
2065 }
2066 }
2067}
2068```
2069
20702. Delay diagnostic updates until some time after the last diagnostic update.
2071
2072```json [settings]
2073{
2074 "diagnostics": {
2075 "inline": {
2076 "enabled": true,
2077 "update_debounce_ms": 150
2078 }
2079 }
2080}
2081```
2082
20833. Set padding between the end of the source line and the start of the diagnostic.
2084
2085```json [settings]
2086{
2087 "diagnostics": {
2088 "inline": {
2089 "enabled": true,
2090 "padding": 4
2091 }
2092 }
2093}
2094```
2095
20964. Horizontally align inline diagnostics at the given column.
2097
2098```json [settings]
2099{
2100 "diagnostics": {
2101 "inline": {
2102 "enabled": true,
2103 "min_column": 80
2104 }
2105 }
2106}
2107```
2108
21095. Show only warning and error diagnostics.
2110
2111```json [settings]
2112{
2113 "diagnostics": {
2114 "inline": {
2115 "enabled": true,
2116 "max_severity": "warning"
2117 }
2118 }
2119}
2120```
2121
2122## Git
2123
2124- Description: Configuration for git-related features.
2125- Setting: `git`
2126- Default:
2127
2128```json [settings]
2129{
2130 "git": {
2131 "git_gutter": "tracked_files",
2132 "inline_blame": {
2133 "enabled": true
2134 },
2135 "branch_picker": {
2136 "show_author_name": true
2137 },
2138 "hunk_style": "staged_hollow"
2139 }
2140}
2141```
2142
2143### Git Gutter
2144
2145- Description: Whether or not to show the git gutter.
2146- Setting: `git_gutter`
2147- Default: `tracked_files`
2148
2149**Options**
2150
21511. Show git gutter in tracked files
2152
2153```json [settings]
2154{
2155 "git": {
2156 "git_gutter": "tracked_files"
2157 }
2158}
2159```
2160
21612. Hide git gutter
2162
2163```json [settings]
2164{
2165 "git": {
2166 "git_gutter": "hide"
2167 }
2168}
2169```
2170
2171### Gutter Debounce
2172
2173- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2174- Setting: `gutter_debounce`
2175- Default: `null`
2176
2177**Options**
2178
2179`integer` values representing milliseconds
2180
2181Example:
2182
2183```json [settings]
2184{
2185 "git": {
2186 "gutter_debounce": 100
2187 }
2188}
2189```
2190
2191### Inline Git Blame
2192
2193- Description: Whether or not to show git blame information inline, on the currently focused line.
2194- Setting: `inline_blame`
2195- Default:
2196
2197```json [settings]
2198{
2199 "git": {
2200 "inline_blame": {
2201 "enabled": true
2202 }
2203 }
2204}
2205```
2206
2207**Options**
2208
22091. Disable inline git blame:
2210
2211```json [settings]
2212{
2213 "git": {
2214 "inline_blame": {
2215 "enabled": false
2216 }
2217 }
2218}
2219```
2220
22212. Only show inline git blame after a delay (that starts after cursor stops moving):
2222
2223```json [settings]
2224{
2225 "git": {
2226 "inline_blame": {
2227 "delay_ms": 500
2228 }
2229 }
2230}
2231```
2232
22333. Show a commit summary next to the commit date and author:
2234
2235```json [settings]
2236{
2237 "git": {
2238 "inline_blame": {
2239 "show_commit_summary": true
2240 }
2241 }
2242}
2243```
2244
22454. Use this as the minimum column at which to display inline blame information:
2246
2247```json [settings]
2248{
2249 "git": {
2250 "inline_blame": {
2251 "min_column": 80
2252 }
2253 }
2254}
2255```
2256
22575. Set the padding between the end of the line and the inline blame hint, in ems:
2258
2259```json [settings]
2260{
2261 "git": {
2262 "inline_blame": {
2263 "padding": 10
2264 }
2265 }
2266}
2267```
2268
2269### Branch Picker
2270
2271- Description: Configuration related to the branch picker.
2272- Setting: `branch_picker`
2273- Default:
2274
2275```json [settings]
2276{
2277 "git": {
2278 "branch_picker": {
2279 "show_author_name": false
2280 }
2281 }
2282}
2283```
2284
2285**Options**
2286
22871. Show the author name in the branch picker:
2288
2289```json [settings]
2290{
2291 "git": {
2292 "branch_picker": {
2293 "show_author_name": true
2294 }
2295 }
2296}
2297```
2298
2299### Hunk Style
2300
2301- Description: What styling we should use for the diff hunks.
2302- Setting: `hunk_style`
2303- Default:
2304
2305```json [settings]
2306{
2307 "git": {
2308 "hunk_style": "staged_hollow"
2309 }
2310}
2311```
2312
2313**Options**
2314
23151. Show the staged hunks faded out and with a border:
2316
2317```json [settings]
2318{
2319 "git": {
2320 "hunk_style": "staged_hollow"
2321 }
2322}
2323```
2324
23252. Show unstaged hunks faded out and with a border:
2326
2327```json [settings]
2328{
2329 "git": {
2330 "hunk_style": "unstaged_hollow"
2331 }
2332}
2333```
2334
2335## Go to Definition Fallback
2336
2337- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2338- Setting: `go_to_definition_fallback`
2339- Default: `"find_all_references"`
2340
2341**Options**
2342
23431. Do nothing:
2344
2345```json [settings]
2346{
2347 "go_to_definition_fallback": "none"
2348}
2349```
2350
23512. Find references for the same symbol (default):
2352
2353```json [settings]
2354{
2355 "go_to_definition_fallback": "find_all_references"
2356}
2357```
2358
2359## Hard Tabs
2360
2361- Description: Whether to indent lines using tab characters or multiple spaces.
2362- Setting: `hard_tabs`
2363- Default: `false`
2364
2365**Options**
2366
2367`boolean` values
2368
2369## Helix Mode
2370
2371- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](../helix.md) for more details.
2372- Setting: `helix_mode`
2373- Default: `false`
2374
2375**Options**
2376
2377`boolean` values
2378
2379## Indent Guides
2380
2381- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2382- Setting: `indent_guides`
2383- Default:
2384
2385```json [settings]
2386{
2387 "indent_guides": {
2388 "enabled": true,
2389 "line_width": 1,
2390 "active_line_width": 1,
2391 "coloring": "fixed",
2392 "background_coloring": "disabled"
2393 }
2394}
2395```
2396
2397**Options**
2398
23991. Disable indent guides
2400
2401```json [settings]
2402{
2403 "indent_guides": {
2404 "enabled": false
2405 }
2406}
2407```
2408
24092. Enable indent guides for a specific language.
2410
2411```json [settings]
2412{
2413 "languages": {
2414 "Python": {
2415 "indent_guides": {
2416 "enabled": true
2417 }
2418 }
2419 }
2420}
2421```
2422
24233. Enable indent aware coloring ("rainbow indentation").
2424 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.
2425
2426```json [settings]
2427{
2428 "indent_guides": {
2429 "enabled": true,
2430 "coloring": "indent_aware"
2431 }
2432}
2433```
2434
24354. Enable indent aware background coloring ("rainbow indentation").
2436 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.
2437
2438```json [settings]
2439{
2440 "indent_guides": {
2441 "enabled": true,
2442 "coloring": "indent_aware",
2443 "background_coloring": "indent_aware"
2444 }
2445}
2446```
2447
2448## Hover Popover Enabled
2449
2450- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2451- Setting: `hover_popover_enabled`
2452- Default: `true`
2453
2454**Options**
2455
2456`boolean` values
2457
2458## Hover Popover Delay
2459
2460- Description: Time to wait in milliseconds before showing the informational hover box. This delay also applies to auto signature help when `auto_signature_help` is enabled.
2461- Setting: `hover_popover_delay`
2462- Default: `300`
2463
2464**Options**
2465
2466`integer` values representing milliseconds
2467
2468## Icon Theme
2469
2470- 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.
2471- Setting: `icon_theme`
2472- Default: `Zed (Default)`
2473
2474### Icon Theme Object
2475
2476- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2477- Setting: `icon_theme`
2478- Default:
2479
2480```json [settings]
2481{
2482 "icon_theme": {
2483 "mode": "system",
2484 "dark": "Zed (Default)",
2485 "light": "Zed (Default)"
2486 }
2487}
2488```
2489
2490### Mode
2491
2492- Description: Specify the icon theme mode.
2493- Setting: `mode`
2494- Default: `system`
2495
2496**Options**
2497
24981. Set the icon theme to dark mode
2499
2500```json [settings]
2501{
2502 "icon_theme": {
2503 "mode": "dark",
2504 "dark": "Zed (Default)",
2505 "light": "Zed (Default)"
2506 }
2507}
2508```
2509
25102. Set the icon theme to light mode
2511
2512```json [settings]
2513{
2514 "icon_theme": {
2515 "mode": "light",
2516 "dark": "Zed (Default)",
2517 "light": "Zed (Default)"
2518 }
2519}
2520```
2521
25223. Set the icon theme to system mode
2523
2524```json [settings]
2525{
2526 "icon_theme": {
2527 "mode": "system",
2528 "dark": "Zed (Default)",
2529 "light": "Zed (Default)"
2530 }
2531}
2532```
2533
2534### Dark
2535
2536- Description: The name of the dark icon theme.
2537- Setting: `dark`
2538- Default: `Zed (Default)`
2539
2540**Options**
2541
2542Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2543
2544### Light
2545
2546- Description: The name of the light icon theme.
2547- Setting: `light`
2548- Default: `Zed (Default)`
2549
2550**Options**
2551
2552Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2553
2554## Image Viewer
2555
2556- Description: Settings for image viewer functionality
2557- Setting: `image_viewer`
2558- Default:
2559
2560```json [settings]
2561{
2562 "image_viewer": {
2563 "unit": "binary"
2564 }
2565}
2566```
2567
2568**Options**
2569
2570### Unit
2571
2572- Description: The unit for image file sizes
2573- Setting: `unit`
2574- Default: `"binary"`
2575
2576**Options**
2577
25781. Use binary units (KiB, MiB):
2579
2580```json [settings]
2581{
2582 "image_viewer": {
2583 "unit": "binary"
2584 }
2585}
2586```
2587
25882. Use decimal units (KB, MB):
2589
2590```json [settings]
2591{
2592 "image_viewer": {
2593 "unit": "decimal"
2594 }
2595}
2596```
2597
2598## Inlay hints
2599
2600- Description: Configuration for displaying extra text with hints in the editor.
2601- Setting: `inlay_hints`
2602- Default:
2603
2604```json [settings]
2605{
2606 "inlay_hints": {
2607 "enabled": false,
2608 "show_type_hints": true,
2609 "show_parameter_hints": true,
2610 "show_other_hints": true,
2611 "show_background": false,
2612 "edit_debounce_ms": 700,
2613 "scroll_debounce_ms": 50,
2614 "toggle_on_modifiers_press": null
2615 }
2616}
2617```
2618
2619**Options**
2620
2621Inlay hints querying consists of two parts: editor (client) and LSP server.
2622With 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.
2623At 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.
2624
2625The following languages have inlay hints preconfigured by Zed:
2626
2627- [Go](https://docs.zed.dev/languages/go)
2628- [Rust](https://docs.zed.dev/languages/rust)
2629- [Svelte](https://docs.zed.dev/languages/svelte)
2630- [TypeScript](https://docs.zed.dev/languages/typescript)
2631
2632Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2633
2634Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2635Settings-related hint updates are not debounced.
2636
2637All possible config values for `toggle_on_modifiers_press` are:
2638
2639```json [settings]
2640{
2641 "inlay_hints": {
2642 "toggle_on_modifiers_press": {
2643 "control": true,
2644 "shift": true,
2645 "alt": true,
2646 "platform": true,
2647 "function": true
2648 }
2649 }
2650}
2651```
2652
2653Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2654
2655## Journal
2656
2657- Description: Configuration for the journal.
2658- Setting: `journal`
2659- Default:
2660
2661```json [settings]
2662{
2663 "journal": {
2664 "path": "~",
2665 "hour_format": "hour12"
2666 }
2667}
2668```
2669
2670### Path
2671
2672- Description: The path of the directory where journal entries are stored. If an invalid path is specified, the journal will fall back to using `~` (the home directory).
2673- Setting: `path`
2674- Default: `~`
2675
2676**Options**
2677
2678`string` values
2679
2680### Hour Format
2681
2682- Description: The format to use for displaying hours in the journal.
2683- Setting: `hour_format`
2684- Default: `hour12`
2685
2686**Options**
2687
26881. 12-hour format:
2689
2690```json [settings]
2691{
2692 "journal": {
2693 "hour_format": "hour12"
2694 }
2695}
2696```
2697
26982. 24-hour format:
2699
2700```json [settings]
2701{
2702 "journal": {
2703 "hour_format": "hour24"
2704 }
2705}
2706```
2707
2708## JSX Tag Auto Close
2709
2710- Description: Whether to automatically close JSX tags
2711- Setting: `jsx_tag_auto_close`
2712- Default:
2713
2714```json [settings]
2715{
2716 "jsx_tag_auto_close": {
2717 "enabled": true
2718 }
2719}
2720```
2721
2722**Options**
2723
2724- `enabled`: Whether to enable automatic JSX tag closing
2725
2726## Languages
2727
2728- Description: Configuration for specific languages.
2729- Setting: `languages`
2730- Default: `null`
2731
2732**Options**
2733
2734To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2735
2736```json [settings]
2737{
2738 "languages": {
2739 "C": {
2740 "format_on_save": "off",
2741 "preferred_line_length": 64,
2742 "soft_wrap": "preferred_line_length"
2743 },
2744 "JSON": {
2745 "tab_size": 4
2746 }
2747 }
2748}
2749```
2750
2751The following settings can be overridden for each specific language:
2752
2753- [`enable_language_server`](#enable-language-server)
2754- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2755- [`format_on_save`](#format-on-save)
2756- [`formatter`](#formatter)
2757- [`hard_tabs`](#hard-tabs)
2758- [`preferred_line_length`](#preferred-line-length)
2759- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2760- [`semantic_tokens`](#semantic-tokens)
2761- [`show_edit_predictions`](#show-edit-predictions)
2762- [`show_whitespaces`](#show-whitespaces)
2763- [`whitespace_map`](#whitespace-map)
2764- [`soft_wrap`](#soft-wrap)
2765- [`tab_size`](#tab-size)
2766- [`use_autoclose`](#use-autoclose)
2767- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2768
2769These values take in the same options as the root-level settings with the same name.
2770
2771### Document Symbols
2772
2773- Description: Controls the source of document symbols used for outlines and breadcrumbs.
2774- Setting: `document_symbols`
2775- Default: `off`
2776
2777**Options**
2778
2779- `"off"`: Use tree-sitter queries to compute document symbols (default)
2780- `"on"`: Use the language server's `textDocument/documentSymbol` LSP response. When enabled, tree-sitter is not used for document symbols
2781
2782LSP document symbols can provide more accurate symbols for complex language features (e.g., generic types, macros, decorators) that tree-sitter may not handle well. Use this when your language server provides better symbol information than the tree-sitter grammar.
2783
2784Example:
2785
2786```json [settings]
2787{
2788 "languages": {
2789 "TypeScript": {
2790 "document_symbols": "on"
2791 }
2792 }
2793}
2794```
2795
2796## Language Models
2797
2798- Description: Configuration for language model providers
2799- Setting: `language_models`
2800- Default:
2801
2802```json [settings]
2803{
2804 "language_models": {
2805 "anthropic": {
2806 "api_url": "https://api.anthropic.com"
2807 },
2808 "google": {
2809 "api_url": "https://generativelanguage.googleapis.com"
2810 },
2811 "ollama": {
2812 "api_url": "http://localhost:11434"
2813 },
2814 "openai": {
2815 "api_url": "https://api.openai.com/v1"
2816 }
2817 }
2818}
2819```
2820
2821**Options**
2822
2823Configuration for various AI model providers including API URLs and authentication settings.
2824
2825## Line Indicator Format
2826
2827- Description: Format for line indicator in the status bar
2828- Setting: `line_indicator_format`
2829- Default: `"short"`
2830
2831**Options**
2832
28331. Short format:
2834
2835```json [settings]
2836{
2837 "line_indicator_format": "short"
2838}
2839```
2840
28412. Long format:
2842
2843```json [settings]
2844{
2845 "line_indicator_format": "long"
2846}
2847```
2848
2849## Linked Edits
2850
2851- 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.
2852- Setting: `linked_edits`
2853- Default: `true`
2854
2855**Options**
2856
2857`boolean` values
2858
2859## LSP Document Colors
2860
2861- Description: How to render LSP `textDocument/documentColor` colors in the editor
2862- Setting: `lsp_document_colors`
2863- Default: `inlay`
2864
2865**Options**
2866
28671. `inlay`: Render document colors as inlay hints near the color text.
28682. `background`: Draw a background behind the color text.
28693. `border`: Draw a border around the color text.
28704. `none`: Do not query and render document colors.
2871
2872## Max Tabs
2873
2874- Description: Maximum number of tabs to show in the tab bar
2875- Setting: `max_tabs`
2876- Default: `null`
2877
2878**Options**
2879
2880Positive `integer` values or `null` for unlimited tabs
2881
2882## Middle Click Paste (Linux only)
2883
2884- Description: Enable middle-click paste on Linux
2885- Setting: `middle_click_paste`
2886- Default: `true`
2887
2888**Options**
2889
2890`boolean` values
2891
2892## Multi Cursor Modifier
2893
2894- 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.
2895- Setting: `multi_cursor_modifier`
2896- Default: `alt`
2897
2898**Options**
2899
29001. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2901
2902```json [settings]
2903{
2904 "multi_cursor_modifier": "alt"
2905}
2906```
2907
29082. Maps `Control` on Linux and Windows and to `Command` on macOS:
2909
2910```json [settings]
2911{
2912 "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2913}
2914```
2915
2916## Node
2917
2918- Description: Configuration for Node.js integration
2919- Setting: `node`
2920- Default:
2921
2922```json [settings]
2923{
2924 "node": {
2925 "ignore_system_version": false,
2926 "path": null,
2927 "npm_path": null
2928 }
2929}
2930```
2931
2932**Options**
2933
2934- `ignore_system_version`: Whether to ignore the system Node.js version
2935- `path`: Custom path to Node.js binary
2936- `npm_path`: Custom path to npm binary
2937
2938## Network Proxy
2939
2940- Description: Configure a network proxy for Zed.
2941- Setting: `proxy`
2942- Default: `null`
2943
2944**Options**
2945
2946The proxy setting must contain a URL to the proxy.
2947
2948The following URI schemes are supported:
2949
2950- `http`
2951- `https`
2952- `socks4` - SOCKS4 proxy with local DNS
2953- `socks4a` - SOCKS4 proxy with remote DNS
2954- `socks5` - SOCKS5 proxy with local DNS
2955- `socks5h` - SOCKS5 proxy with remote DNS
2956
2957`http` will be used when no scheme is specified.
2958
2959By 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`.
2960
2961For example, to set an `http` proxy, add the following to your settings:
2962
2963```json [settings]
2964{
2965 "proxy": "http://127.0.0.1:10809"
2966}
2967```
2968
2969Or to set a `socks5` proxy:
2970
2971```json [settings]
2972{
2973 "proxy": "socks5h://localhost:10808"
2974}
2975```
2976
2977If 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.
2978
2979## On Last Window Closed
2980
2981- Description: What to do when the last window is closed
2982- Setting: `on_last_window_closed`
2983- Default: `"platform_default"`
2984
2985**Options**
2986
29871. Use platform default behavior:
2988
2989```json [settings]
2990{
2991 "on_last_window_closed": "platform_default"
2992}
2993```
2994
29952. Always quit the application:
2996
2997```json [settings]
2998{
2999 "on_last_window_closed": "quit_app"
3000}
3001```
3002
3003## Profiles
3004
3005- Description: Configuration profiles that can be temporarily applied on top of existing settings or Zed's defaults.
3006- Setting: `profiles`
3007- Default: `{}`
3008
3009**Options**
3010
3011Each profile is an object with the following optional fields:
3012
3013- `base`: What settings to start from before applying the profile's overrides.
3014 - `"user"` (default): Apply on top of your current user settings.
3015 - `"default"`: Apply on top of Zed's default settings, ignoring user customizations.
3016- `settings`: The settings overrides for this profile.
3017
3018Examples:
3019
3020```json [settings]
3021{
3022 "profiles": {
3023 "Presentation": {
3024 "settings": {
3025 "buffer_font_size": 20,
3026 "ui_font_size": 18,
3027 "theme": "One Light"
3028 }
3029 },
3030 "Clean Slate": {
3031 "base": "default",
3032 "settings": {
3033 "theme": "Ayu Dark"
3034 }
3035 }
3036 }
3037}
3038```
3039
3040## Preview tabs
3041
3042- Description:
3043 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. \
3044 There are several ways to convert a preview tab into a regular tab:
3045
3046 - Double-clicking on the file
3047 - Double-clicking on the tab header
3048 - Using the {#action project_panel::OpenPermanent} action
3049 - Editing the file
3050 - Dragging the file to a different pane
3051
3052- Setting: `preview_tabs`
3053- Default:
3054
3055```json [settings]
3056{
3057 "preview_tabs": {
3058 "enabled": true,
3059 "enable_preview_from_project_panel": true,
3060 "enable_preview_from_file_finder": false,
3061 "enable_preview_from_multibuffer": true,
3062 "enable_preview_multibuffer_from_code_navigation": false,
3063 "enable_preview_file_from_code_navigation": true,
3064 "enable_keep_preview_on_code_navigation": false
3065 }
3066}
3067```
3068
3069### Enable preview from project panel
3070
3071- Description: Determines whether to open files in preview mode when opened from the project panel with a single click.
3072- Setting: `enable_preview_from_project_panel`
3073- Default: `true`
3074
3075**Options**
3076
3077`boolean` values
3078
3079### Enable preview from file finder
3080
3081- Description: Determines whether to open files in preview mode when selected from the file finder.
3082- Setting: `enable_preview_from_file_finder`
3083- Default: `false`
3084
3085**Options**
3086
3087`boolean` values
3088
3089### Enable preview from multibuffer
3090
3091- Description: Determines whether to open files in preview mode when opened from a multibuffer.
3092- Setting: `enable_preview_from_multibuffer`
3093- Default: `true`
3094
3095**Options**
3096
3097`boolean` values
3098
3099### Enable preview multibuffer from code navigation
3100
3101- Description: Determines whether to open tabs in preview mode when code navigation is used to open a multibuffer.
3102- Setting: `enable_preview_multibuffer_from_code_navigation`
3103- Default: `false`
3104
3105**Options**
3106
3107`boolean` values
3108
3109### Enable preview file from code navigation
3110
3111- Description: Determines whether to open tabs in preview mode when code navigation is used to open a single file.
3112- Setting: `enable_preview_file_from_code_navigation`
3113- Default: `true`
3114
3115**Options**
3116
3117`boolean` values
3118
3119### Enable keep preview on code navigation
3120
3121- Description: Determines whether to keep tabs in preview mode when code navigation is used to navigate away from them. If `enable_preview_file_from_code_navigation` or `enable_preview_multibuffer_from_code_navigation` is also true, the new tab may replace the existing one.
3122- Setting: `enable_keep_preview_on_code_navigation`
3123- Default: `false`
3124
3125**Options**
3126
3127`boolean` values
3128
3129## File Finder
3130
3131### File Icons
3132
3133- Description: Whether to show file icons in the file finder.
3134- Setting: `file_icons`
3135- Default: `true`
3136
3137### Modal Max Width
3138
3139- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
3140- Setting: `modal_max_width`
3141- Default: `small`
3142
3143### Skip Focus For Active In Search
3144
3145- Description: Determines whether the file finder should skip focus for the active file in search results.
3146- Setting: `skip_focus_for_active_in_search`
3147- Default: `true`
3148
3149## Pane Split Direction Horizontal
3150
3151- Description: The direction that you want to split panes horizontally
3152- Setting: `pane_split_direction_horizontal`
3153- Default: `"up"`
3154
3155**Options**
3156
31571. Split upward:
3158
3159```json [settings]
3160{
3161 "pane_split_direction_horizontal": "up"
3162}
3163```
3164
31652. Split downward:
3166
3167```json [settings]
3168{
3169 "pane_split_direction_horizontal": "down"
3170}
3171```
3172
3173## Pane Split Direction Vertical
3174
3175- Description: The direction that you want to split panes vertically
3176- Setting: `pane_split_direction_vertical`
3177- Default: `"left"`
3178
3179**Options**
3180
31811. Split to the left:
3182
3183```json [settings]
3184{
3185 "pane_split_direction_vertical": "left"
3186}
3187```
3188
31892. Split to the right:
3190
3191```json [settings]
3192{
3193 "pane_split_direction_vertical": "right"
3194}
3195```
3196
3197## Preferred Line Length
3198
3199- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
3200- Setting: `preferred_line_length`
3201- Default: `80`
3202
3203**Options**
3204
3205`integer` values
3206
3207## Private Files
3208
3209- Description: Globs to match against file paths to determine if a file is private
3210- Setting: `private_files`
3211- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
3212
3213**Options**
3214
3215List of `string` glob patterns
3216
3217## Projects Online By Default
3218
3219- Description: Whether or not to show the online projects view by default.
3220- Setting: `projects_online_by_default`
3221- Default: `true`
3222
3223**Options**
3224
3225`boolean` values
3226
3227## Read SSH Config
3228
3229- Description: Whether to read SSH configuration files
3230- Setting: `read_ssh_config`
3231- Default: `true`
3232
3233**Options**
3234
3235`boolean` values
3236
3237## Redact Private Values
3238
3239- Description: Hide the values of variables from visual display in private files
3240- Setting: `redact_private_values`
3241- Default: `false`
3242
3243**Options**
3244
3245`boolean` values
3246
3247## Relative Line Numbers
3248
3249- Description: Whether to show relative line numbers in the gutter
3250- Setting: `relative_line_numbers`
3251- Default: `"disabled"`
3252
3253**Options**
3254
32551. Show relative line numbers in the gutter whilst counting wrapped lines as one line:
3256
3257```json [settings]
3258{
3259 "relative_line_numbers": "enabled"
3260}
3261```
3262
32632. Show relative line numbers in the gutter, including wrapped lines in the counting:
3264
3265```json [settings]
3266{
3267 "relative_line_numbers": "wrapped"
3268}
3269```
3270
32712. Do not use relative line numbers:
3272
3273```json [settings]
3274{
3275 "relative_line_numbers": "disabled"
3276}
3277```
3278
3279## Remove Trailing Whitespace On Save
3280
3281- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3282- Setting: `remove_trailing_whitespace_on_save`
3283- Default: `true`
3284
3285**Options**
3286
3287`boolean` values
3288
3289## Resize All Panels In Dock
3290
3291- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3292- Setting: `resize_all_panels_in_dock`
3293- Default: `["left"]`
3294
3295**Options**
3296
3297List of strings containing any combination of:
3298
3299- `"left"`: Resize left dock panels together
3300- `"right"`: Resize right dock panels together
3301- `"bottom"`: Resize bottom dock panels together
3302
3303## Restore on File Reopen
3304
3305- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3306- Setting: `restore_on_file_reopen`
3307- Default: `true`
3308
3309**Options**
3310
3311`boolean` values
3312
3313## Restore on Startup
3314
3315- Description: Controls session restoration on startup.
3316- Setting: `restore_on_startup`
3317- Default: `last_session`
3318
3319**Options**
3320
33211. Restore all workspaces that were open when quitting Zed:
3322
3323```json [settings]
3324{
3325 "restore_on_startup": "last_session"
3326}
3327```
3328
33292. Restore the workspace that was closed last:
3330
3331```json [settings]
3332{
3333 "restore_on_startup": "last_workspace"
3334}
3335```
3336
33373. Always start with an empty editor:
3338
3339```json [settings]
3340{
3341 "restore_on_startup": "empty_tab"
3342}
3343```
3344
33454. Always start with the welcome launchpad:
3346
3347```json [settings]
3348{
3349 "restore_on_startup": "launchpad"
3350}
3351```
3352
3353## Scroll Beyond Last Line
3354
3355- Description: Whether the editor will scroll beyond the last line
3356- Setting: `scroll_beyond_last_line`
3357- Default: `"one_page"`
3358
3359**Options**
3360
33611. Scroll one page beyond the last line by one page:
3362
3363```json [settings]
3364{
3365 "scroll_beyond_last_line": "one_page"
3366}
3367```
3368
33692. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3370
3371```json [settings]
3372{
3373 "scroll_beyond_last_line": "vertical_scroll_margin"
3374}
3375```
3376
33773. The editor will not scroll beyond the last line:
3378
3379```json [settings]
3380{
3381 "scroll_beyond_last_line": "off"
3382}
3383```
3384
3385**Options**
3386
3387`boolean` values
3388
3389## Scroll Sensitivity
3390
3391- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3392- Setting: `scroll_sensitivity`
3393- Default: `1.0`
3394
3395**Options**
3396
3397Positive `float` values
3398
3399### Mouse Wheel Zoom
3400
3401- Description: Whether to zoom the editor font size with the mouse wheel while holding the primary modifier key (Cmd on macOS, Ctrl on other platforms).
3402- Setting: `mouse_wheel_zoom`
3403- Default: `false`
3404
3405**Options**
3406
3407`boolean` values
3408
3409### Fast Scroll Sensitivity
3410
3411- 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.
3412- Setting: `fast_scroll_sensitivity`
3413- Default: `4.0`
3414
3415**Options**
3416
3417Positive `float` values
3418
3419### Horizontal Scroll Margin
3420
3421- Description: The number of characters to keep on either side when scrolling with the mouse
3422- Setting: `horizontal_scroll_margin`
3423- Default: `5`
3424
3425**Options**
3426
3427Non-negative `integer` values
3428
3429### Vertical Scroll Margin
3430
3431- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3432- Setting: `vertical_scroll_margin`
3433- Default: `3`
3434
3435**Options**
3436
3437Non-negative `integer` values
3438
3439## Search
3440
3441- Description: Search options to enable by default when opening new project and buffer searches.
3442- Setting: `search`
3443- Default:
3444
3445```json [settings]
3446{
3447 "search": {
3448 "button": true,
3449 "whole_word": false,
3450 "case_sensitive": false,
3451 "include_ignored": false,
3452 "regex": false,
3453 "center_on_match": false
3454 }
3455}
3456```
3457
3458### Button
3459
3460- Description: Whether to show the project search button in the status bar.
3461- Setting: `button`
3462- Default: `true`
3463
3464### Whole Word
3465
3466- Description: Whether to only match on whole words.
3467- Setting: `whole_word`
3468- Default: `false`
3469
3470### Case Sensitive
3471
3472- Description: Whether to match case sensitively. This setting affects both
3473 searches and editor actions like "Select Next Occurrence", "Select Previous
3474 Occurrence", and "Select All Occurrences".
3475- Setting: `case_sensitive`
3476- Default: `false`
3477
3478### Include Ignore
3479
3480- Description: Whether to include gitignored files in search results.
3481- Setting: `include_ignored`
3482- Default: `false`
3483
3484### Regex
3485
3486- Description: Whether to interpret the search query as a regular expression.
3487- Setting: `regex`
3488- Default: `false`
3489
3490### Center On Match
3491
3492- Description: Whether to center the cursor on each search match when navigating.
3493- Setting: `center_on_match`
3494- Default: `false`
3495
3496## Search Wrap
3497
3498- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3499- Setting: `search_wrap`
3500- Default: `true`
3501
3502## Seed Search Query From Cursor
3503
3504- Description: When to populate a new search's query based on the text under the cursor.
3505- Setting: `seed_search_query_from_cursor`
3506- Default: `always`
3507
3508**Options**
3509
35101. `always` always populate the search query with the word under the cursor
35112. `selection` only populate the search query when there is text selected
35123. `never` never populate the search query
3513
3514## Semantic Tokens
3515
3516- Description: Controls how semantic tokens from language servers are used for syntax highlighting.
3517- Setting: `semantic_tokens`
3518- Default: `off`
3519
3520**Options**
3521
35221. `off`: Do not request semantic tokens from language servers.
35232. `combined`: Use LSP semantic tokens together with tree-sitter highlighting.
35243. `full`: Use LSP semantic tokens exclusively, replacing tree-sitter highlighting.
3525
3526To enable semantic tokens globally:
3527
3528```json [settings]
3529{
3530 "semantic_tokens": "combined"
3531}
3532```
3533
3534To enable semantic tokens for a specific language:
3535
3536```json [settings]
3537{
3538 "languages": {
3539 "Rust": {
3540 "semantic_tokens": "full"
3541 }
3542 }
3543}
3544```
3545
3546May require language server restart to properly apply.
3547
3548## LSP Folding Ranges
3549
3550- Description: Controls whether folding ranges from language servers are used instead of tree-sitter and indent-based folding. Tree-sitter and indent-based folding is the default; it is used as a fallback when LSP folding data is not returned or this setting is turned off.
3551- Setting: `document_folding_ranges`
3552- Default: `off`
3553
3554**Options**
3555
35561. `off`: Use tree-sitter and indent-based folding.
35572. `on`: Use LSP folding wherever possible, falling back to tree-sitter and indent-based folding when no results were returned by the server.
3558
3559To enable LSP folding ranges globally:
3560
3561```json [settings]
3562{
3563 "document_folding_ranges": "on"
3564}
3565```
3566
3567To enable LSP folding ranges for a specific language:
3568
3569```json [settings]
3570{
3571 "languages": {
3572 "Rust": {
3573 "document_folding_ranges": "on"
3574 }
3575 }
3576}
3577```
3578
3579## LSP Document Symbols
3580
3581- Description: Controls the source of document symbols used for outlines and breadcrumbs. This is an LSP feature — when enabled, tree-sitter is not used for document symbols, and the language server's `textDocument/documentSymbol` response is used instead.
3582- Setting: `document_symbols`
3583- Default: `off`
3584
3585**Options**
3586
35871. `off`: Use tree-sitter queries to compute document symbols.
35882. `on`: Use the language server's `textDocument/documentSymbol` LSP response. When enabled, tree-sitter is not used for document symbols.
3589
3590To enable LSP document symbols globally:
3591
3592```json [settings]
3593{
3594 "document_symbols": "on"
3595}
3596```
3597
3598To enable LSP document symbols for a specific language:
3599
3600```json [settings]
3601{
3602 "languages": {
3603 "Rust": {
3604 "document_symbols": "on"
3605 }
3606 }
3607}
3608```
3609
3610## Use Smartcase Search
3611
3612- 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. \
3613 This applies to both in-file searches and project-wide searches.
3614- Setting: `use_smartcase_search`
3615- Default: `false`
3616
3617**Options**
3618
3619`boolean` values
3620
3621Examples:
3622
3623- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3624- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3625
3626## Show Call Status Icon
3627
3628- Description: Whether or not to show the call status icon in the status bar.
3629- Setting: `show_call_status_icon`
3630- Default: `true`
3631
3632**Options**
3633
3634`boolean` values
3635
3636## Completions
3637
3638- Description: Controls how completions are processed for this language.
3639- Setting: `completions`
3640- Default:
3641
3642```json [settings]
3643{
3644 "completions": {
3645 "words": "fallback",
3646 "words_min_length": 3,
3647 "lsp": true,
3648 "lsp_fetch_timeout_ms": 0,
3649 "lsp_insert_mode": "replace_suffix"
3650 }
3651}
3652```
3653
3654### Words
3655
3656- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3657- Setting: `words`
3658- Default: `fallback`
3659
3660**Options**
3661
36621. `enabled` - Always fetch document's words for completions along with LSP completions
36632. `fallback` - Only if LSP response errors or times out, use document's words to show completions
36643. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3665
3666### Min Words Query Length
3667
3668- Description: Minimum number of characters required to automatically trigger word-based completions.
3669 Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3670- Setting: `words_min_length`
3671- Default: `3`
3672
3673**Options**
3674
3675Positive integer values
3676
3677### LSP
3678
3679- Description: Whether to fetch LSP completions or not.
3680- Setting: `lsp`
3681- Default: `true`
3682
3683**Options**
3684
3685`boolean` values
3686
3687### LSP Fetch Timeout (ms)
3688
3689- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3690- Setting: `lsp_fetch_timeout_ms`
3691- Default: `0`
3692
3693**Options**
3694
3695`integer` values representing milliseconds
3696
3697### LSP Insert Mode
3698
3699- Description: Controls what range to replace when accepting LSP completions.
3700- Setting: `lsp_insert_mode`
3701- Default: `replace_suffix`
3702
3703**Options**
3704
37051. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
37062. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
37073. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
37084. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3709
3710## Show Completions On Input
3711
3712- Description: Whether or not to show completions as you type.
3713- Setting: `show_completions_on_input`
3714- Default: `true`
3715
3716**Options**
3717
3718`boolean` values
3719
3720## Show Completion Documentation
3721
3722- Description: Whether to display inline and alongside documentation for items in the completions menu.
3723- Setting: `show_completion_documentation`
3724- Default: `true`
3725
3726**Options**
3727
3728`boolean` values
3729
3730## Show Edit Predictions
3731
3732- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3733- Setting: `show_edit_predictions`
3734- Default: `true`
3735
3736**Options**
3737
3738`boolean` values
3739
3740## Show Whitespaces
3741
3742- Description: Whether or not to render whitespace characters in the editor.
3743- Setting: `show_whitespaces`
3744- Default: `selection`
3745
3746**Options**
3747
37481. `all`
37492. `selection`
37503. `none`
37514. `boundary`
3752
3753## Whitespace Map
3754
3755- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3756- Setting: `whitespace_map`
3757- Default:
3758
3759```json [settings]
3760{
3761 "whitespace_map": {
3762 "space": "•",
3763 "tab": "→"
3764 }
3765}
3766```
3767
3768## Soft Wrap
3769
3770- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3771- Setting: `soft_wrap`
3772- Default: `none`
3773
3774**Options**
3775
37761. `none` to avoid wrapping generally, unless the line is too long
37772. `prefer_line` (deprecated, same as `none`)
37783. `editor_width` to wrap lines that overflow the editor width
37794. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
37805. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3781
3782## Show Wrap Guides
3783
3784- 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.
3785- Setting: `show_wrap_guides`
3786- Default: `true`
3787
3788**Options**
3789
3790`boolean` values
3791
3792## Use On Type Format
3793
3794- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3795- Setting: `use_on_type_format`
3796- Default: `true`
3797
3798**Options**
3799
3800`boolean` values
3801
3802## Use Auto Surround
3803
3804- 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 ().
3805- Setting: `use_auto_surround`
3806- Default: `true`
3807
3808**Options**
3809
3810`boolean` values
3811
3812## Use System Path Prompts
3813
3814- 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.
3815- Setting: `use_system_path_prompts`
3816- Default: `true`
3817
3818**Options**
3819
3820`boolean` values
3821
3822## Use System Prompts
3823
3824- 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.
3825- Setting: `use_system_prompts`
3826- Default: `true`
3827
3828**Options**
3829
3830`boolean` values
3831
3832## Wrap Guides (Vertical Rulers)
3833
3834- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3835- Setting: `wrap_guides`
3836- Default: []
3837
3838**Options**
3839
3840List of `integer` column numbers
3841
3842## Tab Size
3843
3844- Description: The number of spaces to use for each tab character.
3845- Setting: `tab_size`
3846- Default: `4`
3847
3848**Options**
3849
3850`integer` values
3851
3852## Tasks
3853
3854- Description: Configuration for tasks that can be run within Zed
3855- Setting: `tasks`
3856- Default:
3857
3858```json [settings]
3859{
3860 "tasks": {
3861 "variables": {},
3862 "enabled": true,
3863 "prefer_lsp": false
3864 }
3865}
3866```
3867
3868**Options**
3869
3870- `variables`: Custom variables for task configuration
3871- `enabled`: Whether tasks are enabled
3872- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3873
3874## Telemetry
3875
3876- Description: Control what info is collected by Zed.
3877- Setting: `telemetry`
3878- Default:
3879
3880```json [settings]
3881{
3882 "telemetry": {
3883 "diagnostics": true,
3884 "metrics": true
3885 }
3886}
3887```
3888
3889**Options**
3890
3891### Diagnostics
3892
3893- Description: Setting for sending debug-related data, such as crash reports.
3894- Setting: `diagnostics`
3895- Default: `true`
3896
3897**Options**
3898
3899`boolean` values
3900
3901### Metrics
3902
3903- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3904- Setting: `metrics`
3905- Default: `true`
3906
3907**Options**
3908
3909`boolean` values
3910
3911## Terminal
3912
3913- Description: Configuration for the terminal.
3914- Setting: `terminal`
3915- Default:
3916
3917```json [settings]
3918{
3919 "terminal": {
3920 "alternate_scroll": "off",
3921 "blinking": "terminal_controlled",
3922 "copy_on_select": false,
3923 "keep_selection_on_copy": true,
3924 "dock": "bottom",
3925 "default_width": 640,
3926 "default_height": 320,
3927 "detect_venv": {
3928 "on": {
3929 "directories": [".env", "env", ".venv", "venv"],
3930 "activate_script": "default"
3931 }
3932 },
3933 "env": {},
3934 "font_family": null,
3935 "font_features": null,
3936 "font_size": null,
3937 "line_height": "comfortable",
3938 "minimum_contrast": 45,
3939 "option_as_meta": false,
3940 "button": true,
3941 "shell": "system",
3942 "scroll_multiplier": 3.0,
3943 "toolbar": {
3944 "breadcrumbs": false
3945 },
3946 "working_directory": "current_project_directory",
3947 "scrollbar": {
3948 "show": null
3949 }
3950 }
3951}
3952```
3953
3954### Terminal: Dock
3955
3956- Description: Control the position of the dock
3957- Setting: `dock`
3958- Default: `bottom`
3959
3960**Options**
3961
3962`"bottom"`, `"left"` or `"right"`
3963
3964### Terminal: Alternate Scroll
3965
3966- 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.
3967- Setting: `alternate_scroll`
3968- Default: `off`
3969
3970**Options**
3971
39721. Default alternate scroll mode to off
3973
3974```json [settings]
3975{
3976 "terminal": {
3977 "alternate_scroll": "off"
3978 }
3979}
3980```
3981
39822. Default alternate scroll mode to on
3983
3984```json [settings]
3985{
3986 "terminal": {
3987 "alternate_scroll": "on"
3988 }
3989}
3990```
3991
3992### Terminal: Blinking
3993
3994- Description: Set the cursor blinking behavior in the terminal
3995- Setting: `blinking`
3996- Default: `terminal_controlled`
3997
3998**Options**
3999
40001. Never blink the cursor, ignore the terminal mode
4001
4002```json [settings]
4003{
4004 "terminal": {
4005 "blinking": "off"
4006 }
4007}
4008```
4009
40102. Default the cursor blink to off, but allow the terminal to turn blinking on
4011
4012```json [settings]
4013{
4014 "terminal": {
4015 "blinking": "terminal_controlled"
4016 }
4017}
4018```
4019
40203. Always blink the cursor, ignore the terminal mode
4021
4022```json [settings]
4023{
4024 "terminal": {
4025 "blinking": "on"
4026 }
4027}
4028```
4029
4030### Terminal: Copy On Select
4031
4032- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
4033- Setting: `copy_on_select`
4034- Default: `false`
4035
4036**Options**
4037
4038`boolean` values
4039
4040**Example**
4041
4042```json [settings]
4043{
4044 "terminal": {
4045 "copy_on_select": true
4046 }
4047}
4048```
4049
4050### Terminal: Cursor Shape
4051
4052- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
4053- Setting: `cursor_shape`
4054- Default: `null` (defaults to block)
4055
4056**Options**
4057
40581. A block that surrounds the following character
4059
4060```json [settings]
4061{
4062 "terminal": {
4063 "cursor_shape": "block"
4064 }
4065}
4066```
4067
40682. A vertical bar
4069
4070```json [settings]
4071{
4072 "terminal": {
4073 "cursor_shape": "bar"
4074 }
4075}
4076```
4077
40783. An underline / underscore that runs along the following character
4079
4080```json [settings]
4081{
4082 "terminal": {
4083 "cursor_shape": "underline"
4084 }
4085}
4086```
4087
40884. A box drawn around the following character
4089
4090```json [settings]
4091{
4092 "terminal": {
4093 "cursor_shape": "hollow"
4094 }
4095}
4096```
4097
4098### Terminal: Keep Selection On Copy
4099
4100- Description: Whether or not to keep the selection in the terminal after copying text.
4101- Setting: `keep_selection_on_copy`
4102- Default: `true`
4103
4104**Options**
4105
4106`boolean` values
4107
4108**Example**
4109
4110```json [settings]
4111{
4112 "terminal": {
4113 "keep_selection_on_copy": false
4114 }
4115}
4116```
4117
4118### Terminal: Env
4119
4120- 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
4121- Setting: `env`
4122- Default: `{}`
4123
4124**Example**
4125
4126```json [settings]
4127{
4128 "terminal": {
4129 "env": {
4130 "ZED": "1",
4131 "KEY": "value1:value2"
4132 }
4133 }
4134}
4135```
4136
4137### Terminal: Font Size
4138
4139- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
4140- Setting: `font_size`
4141- Default: `null`
4142
4143**Options**
4144
4145`integer` values
4146
4147```json [settings]
4148{
4149 "terminal": {
4150 "font_size": 15
4151 }
4152}
4153```
4154
4155### Terminal: Font Family
4156
4157- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
4158- Setting: `font_family`
4159- Default: `null`
4160
4161**Options**
4162
4163The name of any font family installed on the user's system
4164
4165```json [settings]
4166{
4167 "terminal": {
4168 "font_family": "Berkeley Mono"
4169 }
4170}
4171```
4172
4173### Terminal: Font Features
4174
4175- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
4176- Setting: `font_features`
4177- Default: `null`
4178- Platform: macOS and Windows.
4179
4180**Options**
4181
4182See Buffer Font Features
4183
4184```json [settings]
4185{
4186 "terminal": {
4187 "font_features": {
4188 "calt": false
4189 // See Buffer Font Features for more features
4190 }
4191 }
4192}
4193```
4194
4195### Terminal: Line Height
4196
4197- Description: Set the terminal's line height.
4198- Setting: `line_height`
4199- Default: `standard`
4200
4201**Options**
4202
42031. Use a line height that's `comfortable` for reading, 1.618.
4204
4205```json [settings]
4206{
4207 "terminal": {
4208 "line_height": "comfortable"
4209 }
4210}
4211```
4212
42132. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
4214
4215```json [settings]
4216{
4217 "terminal": {
4218 "line_height": "standard"
4219 }
4220}
4221```
4222
42233. Use a custom line height.
4224
4225```json [settings]
4226{
4227 "terminal": {
4228 "line_height": {
4229 "custom": 2
4230 }
4231 }
4232}
4233```
4234
4235### Terminal: Minimum Contrast
4236
4237- 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.
4238- Setting: `minimum_contrast`
4239- Default: `45`
4240
4241**Options**
4242
4243`integer` values from 0 to 106. Common recommended values:
4244
4245- `0`: No contrast adjustment
4246- `45`: Minimum for large fluent text (default)
4247- `60`: Minimum for other content text
4248- `75`: Minimum for body text
4249- `90`: Preferred for body text
4250
4251```json [settings]
4252{
4253 "terminal": {
4254 "minimum_contrast": 45
4255 }
4256}
4257```
4258
4259### Terminal: Option As Meta
4260
4261- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
4262- Setting: `option_as_meta`
4263- Default: `false`
4264
4265**Options**
4266
4267`boolean` values
4268
4269```json [settings]
4270{
4271 "terminal": {
4272 "option_as_meta": true
4273 }
4274}
4275```
4276
4277### Terminal: Shell
4278
4279- Description: What shell to use when launching the terminal.
4280- Setting: `shell`
4281- Default: `system`
4282
4283**Options**
4284
42851. Use the system's default terminal configuration (usually the `/etc/passwd` file).
4286
4287```json [settings]
4288{
4289 "terminal": {
4290 "shell": "system"
4291 }
4292}
4293```
4294
42952. A program to launch:
4296
4297```json [settings]
4298{
4299 "terminal": {
4300 "shell": {
4301 "program": "sh"
4302 }
4303 }
4304}
4305```
4306
43073. A program with arguments:
4308
4309```json [settings]
4310{
4311 "terminal": {
4312 "shell": {
4313 "with_arguments": {
4314 "program": "/bin/bash",
4315 "args": ["--login"]
4316 }
4317 }
4318 }
4319}
4320```
4321
4322## Terminal: Detect Virtual Environments {#terminal-detect_venv}
4323
4324- 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.
4325- Setting: `detect_venv`
4326- Default:
4327
4328```json [settings]
4329{
4330 "terminal": {
4331 "detect_venv": {
4332 "on": {
4333 // Default directories to search for virtual environments, relative
4334 // to the current working directory. We recommend overriding this
4335 // in your project's settings, rather than globally.
4336 "directories": [".env", "env", ".venv", "venv"],
4337 // Can also be `csh`, `fish`, and `nushell`
4338 "activate_script": "default"
4339 }
4340 }
4341 }
4342}
4343```
4344
4345Disable with:
4346
4347```json [settings]
4348{
4349 "terminal": {
4350 "detect_venv": "off"
4351 }
4352}
4353```
4354
4355### Terminal: Scroll Multiplier
4356
4357- Description: The multiplier for scrolling speed in the terminal when using mouse wheel or trackpad.
4358- Setting: `scroll_multiplier`
4359- Default: `1.0`
4360
4361**Options**
4362
4363Positive floating point values. Values less than or equal to 0 will be clamped to a minimum of 0.01.
4364
4365**Example**
4366
4367```json
4368{
4369 "terminal": {
4370 "scroll_multiplier": 5.0
4371 }
4372}
4373```
4374
4375## Terminal: Toolbar
4376
4377- Description: Whether or not to show various elements in the terminal toolbar.
4378- Setting: `toolbar`
4379- Default:
4380
4381```json [settings]
4382{
4383 "terminal": {
4384 "toolbar": {
4385 "breadcrumbs": false
4386 }
4387 }
4388}
4389```
4390
4391**Options**
4392
4393At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
4394
4395If the terminal title is empty, the breadcrumbs won't be shown.
4396
4397The shell running in the terminal needs to be configured to emit the title.
4398
4399Example command to set the title: `echo -e "\e]2;New Title\007";`
4400
4401### Terminal: Button
4402
4403- Description: Control to show or hide the terminal button in the status bar
4404- Setting: `button`
4405- Default: `true`
4406
4407**Options**
4408
4409`boolean` values
4410
4411```json [settings]
4412{
4413 "terminal": {
4414 "button": false
4415 }
4416}
4417```
4418
4419### Terminal: Working Directory
4420
4421- Description: What working directory to use when launching the terminal.
4422- Setting: `working_directory`
4423- Default: `"current_project_directory"`
4424
4425**Options**
4426
44271. Use the current file's directory, falling back to the project directory, then the first project in the workspace.
4428
4429```json [settings]
4430{
4431 "terminal": {
4432 "working_directory": "current_file_directory"
4433 }
4434}
4435```
4436
44372. Use the current file's project directory. Fallback to the first project directory strategy if unsuccessful.
4438
4439```json [settings]
4440{
4441 "terminal": {
4442 "working_directory": "current_project_directory"
4443 }
4444}
4445```
4446
44473. Use the first project in this workspace's directory. Fallback to using this platform's home directory.
4448
4449```json [settings]
4450{
4451 "terminal": {
4452 "working_directory": "first_project_directory"
4453 }
4454}
4455```
4456
44574. Always use this platform's home directory if it can be found.
4458
4459```json [settings]
4460{
4461 "terminal": {
4462 "working_directory": "always_home"
4463 }
4464}
4465```
4466
44675. 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.
4468
4469```json [settings]
4470{
4471 "terminal": {
4472 "working_directory": {
4473 "always": {
4474 "directory": "~/zed/projects/"
4475 }
4476 }
4477 }
4478}
4479```
4480
4481### Terminal: Path Hyperlink Regexes
4482
4483- Description: Regexes used to identify path hyperlinks. The regexes can be specified in two forms - a single regex string, or an array of strings (which will be collected into a single multi-line regex string).
4484- Setting: `path_hyperlink_regexes`
4485- Default:
4486
4487```json [settings]
4488{
4489 "terminal": {
4490 "path_hyperlink_regexes": [
4491 // Python-style diagnostics
4492 "File \"(?<path>[^\"]+)\", line (?<line>[0-9]+)",
4493 // Common path syntax with optional line, column, description, trailing punctuation, or
4494 // surrounding symbols or quotes
4495 [
4496 "(?x)",
4497 "# optionally starts with 0-2 opening prefix symbols",
4498 "[({\\[<]{0,2}",
4499 "# which may be followed by an opening quote",
4500 "(?<quote>[\"'`])?",
4501 "# `path` is the shortest sequence of any non-space character",
4502 "(?<link>(?<path>[^ ]+?",
4503 " # which may end with a line and optionally a column,",
4504 " (?<line_column>:+[0-9]+(:[0-9]+)?|:?\\([0-9]+([,:][0-9]+)?\\))?",
4505 "))",
4506 "# which must be followed by a matching quote",
4507 "(?(<quote>)\\k<quote>)",
4508 "# and optionally a single closing symbol",
4509 "[)}\\]>]?",
4510 "# if line/column matched, may be followed by a description",
4511 "(?(<line_column>):[^ 0-9][^ ]*)?",
4512 "# which may be followed by trailing punctuation",
4513 "[.,:)}\\]>]*",
4514 "# and always includes trailing whitespace or end of line",
4515 "([ ]+|$)"
4516 ]
4517 ]
4518 }
4519}
4520```
4521
4522### Terminal: Path Hyperlink Timeout (ms)
4523
4524- Description: Maximum time to search for a path hyperlink. When set to 0, path hyperlinks are disabled.
4525- Setting: `path_hyperlink_timeout_ms`
4526- Default: `1`
4527
4528## REPL
4529
4530- Description: Repl settings.
4531- Setting: `repl`
4532- Default:
4533
4534```json [settings]
4535{
4536 "repl": {
4537 // Maximum number of columns to keep in REPL's scrollback buffer.
4538 // Clamped with [20, 512] range.
4539 "max_columns": 128,
4540 // Maximum number of lines to keep in REPL's scrollback buffer.
4541 // Clamped with [4, 256] range.
4542 "max_lines": 32
4543 }
4544}
4545```
4546
4547## Theme
4548
4549- 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.
4550- Setting: `theme`
4551- Default: `One Dark`
4552
4553### Theme Object
4554
4555- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4556- Setting: `theme`
4557- Default:
4558
4559```json [settings]
4560{
4561 "theme": {
4562 "mode": "system",
4563 "dark": "One Dark",
4564 "light": "One Light"
4565 }
4566}
4567```
4568
4569### Mode
4570
4571- Description: Specify theme mode.
4572- Setting: `mode`
4573- Default: `system`
4574
4575**Options**
4576
45771. Set the theme to dark mode
4578
4579```json [settings]
4580{
4581 "theme": {
4582 "mode": "dark",
4583 "dark": "One Dark",
4584 "light": "One Light"
4585 }
4586}
4587```
4588
45892. Set the theme to light mode
4590
4591```json [settings]
4592{
4593 "theme": {
4594 "mode": "light",
4595 "dark": "One Dark",
4596 "light": "One Light"
4597 }
4598}
4599```
4600
46013. Set the theme to system mode
4602
4603```json [settings]
4604{
4605 "theme": {
4606 "mode": "system",
4607 "dark": "One Dark",
4608 "light": "One Light"
4609 }
4610}
4611```
4612
4613### Dark
4614
4615- Description: The name of the dark Zed theme to use for the UI.
4616- Setting: `dark`
4617- Default: `One Dark`
4618
4619**Options**
4620
4621Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4622
4623### Light
4624
4625- Description: The name of the light Zed theme to use for the UI.
4626- Setting: `light`
4627- Default: `One Light`
4628
4629**Options**
4630
4631Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4632
4633## Title Bar
4634
4635- Description: Whether or not to show various elements in the title bar
4636- Setting: `title_bar`
4637- Default:
4638
4639```json [settings]
4640{
4641 "title_bar": {
4642 "show_branch_icon": false,
4643 "show_branch_name": true,
4644 "show_project_items": true,
4645 "show_onboarding_banner": true,
4646 "show_user_picture": true,
4647 "show_user_menu": true,
4648 "show_sign_in": true,
4649 "show_menus": false,
4650 "button_layout": "platform_default"
4651 }
4652}
4653```
4654
4655**Options**
4656
4657- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4658- `show_branch_name`: Whether to show the branch name button in the titlebar
4659- `show_project_items`: Whether to show the project host and name in the titlebar
4660- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4661- `show_user_picture`: Whether to show user picture in the titlebar
4662- `show_user_menu`: Whether to show the user menu button in the titlebar (the one that displays your avatar by default and contains options like Settings, Keymap, Themes, etc.)
4663- `show_sign_in`: Whether to show the sign in button in the titlebar
4664- `show_menus`: Whether to show the menus in the titlebar
4665- `button_layout`: The layout of window control buttons in the title bar (Linux only). Can be set to `"platform_default"` to follow the system setting, `"standard"` to use Zed's built-in layout, or a custom format like `"close:minimize,maximize"`
4666
4667## Vim
4668
4669- Description: Whether or not to enable vim mode.
4670- Setting: `vim_mode`
4671- Default: `false`
4672
4673## When Closing With No Tabs
4674
4675- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4676- Setting: `when_closing_with_no_tabs`
4677- Default: `"platform_default"`
4678
4679**Options**
4680
46811. Use platform default behavior:
4682
4683```json [settings]
4684{
4685 "when_closing_with_no_tabs": "platform_default"
4686}
4687```
4688
46892. Always close the window:
4690
4691```json [settings]
4692{
4693 "when_closing_with_no_tabs": "close_window"
4694}
4695```
4696
46973. Never close the window:
4698
4699```json [settings]
4700{
4701 "when_closing_with_no_tabs": "keep_window_open"
4702}
4703```
4704
4705## Project Panel
4706
4707- Description: Customize project panel
4708- Setting: `project_panel`
4709- Default:
4710
4711```json [settings]
4712{
4713 "project_panel": {
4714 "button": true,
4715 "default_width": 240,
4716 "dock": "left",
4717 "entry_spacing": "comfortable",
4718 "file_icons": true,
4719 "folder_icons": true,
4720 "git_status": true,
4721 "indent_size": 20,
4722 "auto_reveal_entries": true,
4723 "auto_fold_dirs": true,
4724 "bold_folder_labels": false,
4725 "drag_and_drop": true,
4726 "scrollbar": {
4727 "show": null,
4728 "horizontal_scroll": true
4729 },
4730 "sticky_scroll": true,
4731 "show_diagnostics": "all",
4732 "indent_guides": {
4733 "show": "always"
4734 },
4735 "sort_mode": "directories_first",
4736 "hide_root": false,
4737 "hide_hidden": false,
4738 "starts_open": true,
4739 "auto_open": {
4740 "on_create": true,
4741 "on_paste": true,
4742 "on_drop": true
4743 }
4744 }
4745}
4746```
4747
4748### Dock
4749
4750- Description: Control the position of the dock
4751- Setting: `dock`
4752- Default: `left`
4753
4754**Options**
4755
47561. Default dock position to left
4757
4758```json [settings]
4759{
4760 "project_panel": {
4761 "dock": "left"
4762 }
4763}
4764```
4765
47662. Default dock position to right
4767
4768```json [settings]
4769{
4770 "project_panel": {
4771 "dock": "right"
4772 }
4773}
4774```
4775
4776### Entry Spacing
4777
4778- Description: Spacing between worktree entries
4779- Setting: `entry_spacing`
4780- Default: `comfortable`
4781
4782**Options**
4783
47841. Comfortable entry spacing
4785
4786```json [settings]
4787{
4788 "project_panel": {
4789 "entry_spacing": "comfortable"
4790 }
4791}
4792```
4793
47942. Standard entry spacing
4795
4796```json [settings]
4797{
4798 "project_panel": {
4799 "entry_spacing": "standard"
4800 }
4801}
4802```
4803
4804### Git Status
4805
4806- Description: Indicates newly created and updated files
4807- Setting: `git_status`
4808- Default: `true`
4809
4810**Options**
4811
48121. Default enable git status
4813
4814```json [settings]
4815{
4816 "project_panel": {
4817 "git_status": true
4818 }
4819}
4820```
4821
48222. Default disable git status
4823
4824```json [settings]
4825{
4826 "project_panel": {
4827 "git_status": false
4828 }
4829}
4830```
4831
4832### Default Width
4833
4834- Description: Customize default width taken by project panel
4835- Setting: `default_width`
4836- Default: `240`
4837
4838**Options**
4839
4840`float` values
4841
4842### Auto Reveal Entries
4843
4844- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4845- Setting: `auto_reveal_entries`
4846- Default: `true`
4847
4848**Options**
4849
48501. Enable auto reveal entries
4851
4852```json [settings]
4853{
4854 "project_panel": {
4855 "auto_reveal_entries": true
4856 }
4857}
4858```
4859
48602. Disable auto reveal entries
4861
4862```json [settings]
4863{
4864 "project_panel": {
4865 "auto_reveal_entries": false
4866 }
4867}
4868```
4869
4870### Auto Fold Dirs
4871
4872- Description: Whether to fold directories automatically when directory has only one directory inside.
4873- Setting: `auto_fold_dirs`
4874- Default: `true`
4875
4876**Options**
4877
48781. Enable auto fold dirs
4879
4880```json [settings]
4881{
4882 "project_panel": {
4883 "auto_fold_dirs": true
4884 }
4885}
4886```
4887
48882. Disable auto fold dirs
4889
4890```json [settings]
4891{
4892 "project_panel": {
4893 "auto_fold_dirs": false
4894 }
4895}
4896```
4897
4898### Bold Folder Labels
4899
4900- Description: Whether to show folder names with bold text in the project panel.
4901- Setting: `bold_folder_labels`
4902- Default: `false`
4903
4904**Options**
4905
49061. Enable bold folder labels
4907
4908```json [settings]
4909{
4910 "project_panel": {
4911 "bold_folder_labels": true
4912 }
4913}
4914```
4915
49162. Disable bold folder labels
4917
4918```json [settings]
4919{
4920 "project_panel": {
4921 "bold_folder_labels": false
4922 }
4923}
4924```
4925
4926### Indent Size
4927
4928- Description: Amount of indentation (in pixels) for nested items.
4929- Setting: `indent_size`
4930- Default: `20`
4931
4932### Indent Guides: Show
4933
4934- Description: Whether to show indent guides in the project panel.
4935- Setting: `indent_guides`
4936- Default:
4937
4938```json [settings]
4939{
4940 "project_panel": {
4941 "indent_guides": {
4942 "show": "always"
4943 }
4944 }
4945}
4946```
4947
4948**Options**
4949
49501. Show indent guides in the project panel
4951
4952```json [settings]
4953{
4954 "project_panel": {
4955 "indent_guides": {
4956 "show": "always"
4957 }
4958 }
4959}
4960```
4961
49622. Hide indent guides in the project panel
4963
4964```json [settings]
4965{
4966 "project_panel": {
4967 "indent_guides": {
4968 "show": "never"
4969 }
4970 }
4971}
4972```
4973
4974### Scrollbar
4975
4976- Description: Scrollbar-related settings for the project panel.
4977- Setting: `scrollbar`
4978- Default:
4979
4980```json [settings]
4981{
4982 "project_panel": {
4983 "scrollbar": {
4984 "show": null,
4985 "horizontal_scroll": true
4986 }
4987 }
4988}
4989```
4990
4991**Options**
4992
4993- `show`: 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.
4994- `horizontal_scroll`: Whether to allow horizontal scrolling in the project panel. When `false`, the view is locked to the leftmost position and long file names are clipped.
4995
4996### Sort Mode
4997
4998- Description: Sort order for entries in the project panel
4999- Setting: `sort_mode`
5000- Default: `directories_first`
5001
5002**Options**
5003
50041. Show directories first, then files
5005
5006```json [settings]
5007{
5008 "project_panel": {
5009 "sort_mode": "directories_first"
5010 }
5011}
5012```
5013
50142. Mix directories and files together
5015
5016```json [settings]
5017{
5018 "project_panel": {
5019 "sort_mode": "mixed"
5020 }
5021}
5022```
5023
50243. Show files first, then directories
5025
5026```json [settings]
5027{
5028 "project_panel": {
5029 "sort_mode": "files_first"
5030 }
5031}
5032```
5033
5034### Sort Order
5035
5036- Description: Whether to sort file and folder names case-sensitively in the project panel. This setting works in combination with `sort_mode`. `sort_mode` controls how files and directories are grouped (e.g., directories first), while this setting controls how names are compared within those groups.
5037- Setting: `sort_order`
5038- Default: `default`
5039
5040**Options**
5041
50421. Case-insensitive natural sort with lowercase preferred in ties. Numbers in file names are compared by their numeric value (e.g., `file2` sorts before `file10`). Names that differ only in casing are sorted with lowercase first (e.g., `apple` before `Apple`).
5043
5044```json [settings]
5045{
5046 "project_panel": {
5047 "sort_order": "default"
5048 }
5049}
5050```
5051
50522. Uppercase names are grouped before lowercase names, with case-insensitive natural sort within each group. Dot-prefixed names (e.g., `.gitignore`) sort before both groups. Accented uppercase letters like `É` are treated as uppercase.
5053
5054```json [settings]
5055{
5056 "project_panel": {
5057 "sort_order": "upper"
5058 }
5059}
5060```
5061
50623. Lowercase names are grouped before uppercase names, with case-insensitive natural sort within each group. Dot-prefixed names sort before both groups.
5063
5064```json [settings]
5065{
5066 "project_panel": {
5067 "sort_order": "lower"
5068 }
5069}
5070```
5071
50724. Pure Unicode codepoint comparison. No case folding and no natural number sorting. Uppercase ASCII letters (`A`–`Z`) sort before lowercase (`a`–`z`) as a natural consequence of their codepoint values. Accented characters like `É` (U+00C9) sort after all ASCII letters. Numbers are compared lexicographically (`file10` sorts before `file2`).
5073
5074```json [settings]
5075{
5076 "project_panel": {
5077 "sort_order": "unicode"
5078 }
5079}
5080```
5081
5082### Auto Open
5083
5084- Description: Control whether files are opened automatically after different creation flows in the project panel.
5085- Setting: `auto_open`
5086- Default:
5087
5088```json [settings]
5089{
5090 "project_panel": {
5091 "auto_open": {
5092 "on_create": true,
5093 "on_paste": true,
5094 "on_drop": true
5095 }
5096 }
5097}
5098```
5099
5100**Options**
5101
5102- `on_create`: Whether to automatically open newly created files in the editor.
5103- `on_paste`: Whether to automatically open files after pasting or duplicating them.
5104- `on_drop`: Whether to automatically open files dropped from external sources.
5105
5106## Agent
5107
5108Visit [the Configuration page](../ai/configuration.md) under the AI section to learn more about all the agent-related settings.
5109
5110## Collaboration Panel
5111
5112- Description: Customizations for the collaboration panel.
5113- Setting: `collaboration_panel`
5114- Default:
5115
5116```json [settings]
5117{
5118 "collaboration_panel": {
5119 "button": true,
5120 "dock": "left",
5121 "default_width": 240
5122 }
5123}
5124```
5125
5126**Options**
5127
5128- `button`: Whether to show the collaboration panel button in the status bar
5129- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
5130- `default_width`: Default width of the collaboration panel
5131
5132## Debugger
5133
5134- Description: Configuration for debugger panel and settings
5135- Setting: `debugger`
5136- Default:
5137
5138```json [settings]
5139{
5140 "debugger": {
5141 "stepping_granularity": "line",
5142 "save_breakpoints": true,
5143 "dock": "bottom",
5144 "button": true
5145 }
5146}
5147```
5148
5149See the [debugger page](../debugger.md) for more information about debugging support within Zed.
5150
5151## Git Panel
5152
5153- Description: Setting to customize the behavior of the git panel.
5154- Setting: `git_panel`
5155- Default:
5156
5157```json [settings]
5158{
5159 "git_panel": {
5160 "button": true,
5161 "dock": "left",
5162 "default_width": 360,
5163 "status_style": "icon",
5164 "fallback_branch_name": "main",
5165 "sort_by_path": false,
5166 "collapse_untracked_diff": false,
5167 "scrollbar": {
5168 "show": null
5169 },
5170 "starts_open": false
5171 }
5172}
5173```
5174
5175**Options**
5176
5177- `button`: Whether to show the git panel button in the status bar
5178- `dock`: Where to dock the git panel. Can be `left` or `right`
5179- `default_width`: Default width of the git panel
5180- `status_style`: How to display git status. Can be `label_color` or `icon`
5181- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
5182- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
5183- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
5184- `scrollbar`: When to show the scrollbar in the git panel
5185- `starts_open`: Whether the git panel should open on startup
5186
5187## Git Worktree Directory
5188
5189- Description: Directory where git worktrees are created, relative to the repository working directory.
5190- Setting: `git.worktree_directory`
5191- Default: `"../worktrees"`
5192
5193When the resolved directory falls outside the project root, the project's directory name is automatically appended so that sibling repos don't collide. For example, with the default `"../worktrees"` and a project at `~/code/zed`, worktrees are created under `~/code/worktrees/zed/`.
5194
5195When the resolved directory is inside the project root, no extra component is added (it's already project-scoped).
5196
5197**Examples**:
5198
5199- `"../worktrees"` — `~/code/worktrees/<project>/` (default)
5200- `".git/zed-worktrees"` — `<project>/.git/zed-worktrees/`
5201- `"my-worktrees"` — `<project>/my-worktrees/`
5202
5203Trailing slashes are ignored.
5204
5205```json [settings]
5206{
5207 "git": {
5208 "worktree_directory": "../worktrees"
5209 }
5210}
5211```
5212
5213## Git Hosting Providers
5214
5215- Description: Register self-hosted GitHub, GitLab, or Bitbucket instances so commit hashes, issue references, and permalinks resolve to the right host.
5216- Setting: `git_hosting_providers`
5217- Default: `[]`
5218
5219**Options**
5220
5221Each entry accepts:
5222
5223- `provider`: One of `github`, `gitlab`, or `bitbucket`
5224- `name`: Display name for the instance
5225- `base_url`: Base URL, e.g. `https://git.example.corp`
5226
5227You can define these in user or project settings; project settings are merged on top of user settings.
5228
5229```json [settings]
5230{
5231 "git_hosting_providers": [
5232 {
5233 "provider": "github",
5234 "name": "BigCorp GitHub",
5235 "base_url": "https://git.example.corp"
5236 }
5237 ]
5238}
5239```
5240
5241## Outline Panel
5242
5243- Description: Customize outline Panel
5244- Setting: `outline_panel`
5245- Default:
5246
5247```json [settings]
5248{
5249 "outline_panel": {
5250 "button": true,
5251 "default_width": 300,
5252 "dock": "left",
5253 "file_icons": true,
5254 "folder_icons": true,
5255 "git_status": true,
5256 "indent_size": 20,
5257 "auto_reveal_entries": true,
5258 "auto_fold_dirs": true,
5259 "indent_guides": {
5260 "show": "always"
5261 },
5262 "scrollbar": {
5263 "show": null
5264 }
5265 }
5266}
5267```
5268
5269## Calls
5270
5271- Description: Customize behavior when participating in a call
5272- Setting: `calls`
5273- Default:
5274
5275```json [settings]
5276{
5277 "calls": {
5278 // Join calls with the microphone live by default
5279 "mute_on_join": false,
5280 // Share your project when you are the first to join a channel
5281 "share_on_join": false
5282 }
5283}
5284```
5285
5286## Colorize Brackets
5287
5288- Description: Whether to use tree-sitter bracket queries to detect and colorize the brackets in the editor (also known as "rainbow brackets").
5289- Setting: `colorize_brackets`
5290- Default: `false`
5291
5292**Options**
5293
5294`boolean` values
5295
5296The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
5297
5298## Unnecessary Code Fade
5299
5300- Description: How much to fade out unused code.
5301- Setting: `unnecessary_code_fade`
5302- Default: `0.3`
5303
5304**Options**
5305
5306Float values between `0.0` and `0.9`, where:
5307
5308- `0.0` means no fading (unused code looks the same as used code)
5309- `0.9` means maximum fading (unused code is very faint but still visible)
5310
5311**Example**
5312
5313```json [settings]
5314{
5315 "unnecessary_code_fade": 0.5
5316}
5317```
5318
5319## UI Font Family
5320
5321- Description: The name of the font to use for text in the UI.
5322- Setting: `ui_font_family`
5323- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
5324
5325**Options**
5326
5327The 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).
5328
5329## UI Font Features
5330
5331- Description: The OpenType features to enable for text in the UI.
5332- Setting: `ui_font_features`
5333- Default:
5334
5335```json [settings]
5336{
5337 "ui_font_features": {
5338 "calt": false
5339 }
5340}
5341```
5342
5343- Platform: macOS and Windows.
5344
5345**Options**
5346
5347Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
5348
5349For example, to disable font ligatures, add the following to your settings:
5350
5351```json [settings]
5352{
5353 "ui_font_features": {
5354 "calt": false
5355 }
5356}
5357```
5358
5359You can also set other OpenType features, like setting `cv01` to `7`:
5360
5361```json [settings]
5362{
5363 "ui_font_features": {
5364 "cv01": 7
5365 }
5366}
5367```
5368
5369## UI Font Fallbacks
5370
5371- Description: The font fallbacks to use for text in the UI.
5372- Setting: `ui_font_fallbacks`
5373- Default: `null`
5374- Platform: macOS and Windows.
5375
5376**Options**
5377
5378For example, to use `Nerd Font` as a fallback, add the following to your settings:
5379
5380```json [settings]
5381{
5382 "ui_font_fallbacks": ["Nerd Font"]
5383}
5384```
5385
5386## UI Font Size
5387
5388- Description: The default font size for text in the UI.
5389- Setting: `ui_font_size`
5390- Default: `16`
5391
5392**Options**
5393
5394`integer` values from `6` to `100` pixels (inclusive)
5395
5396## UI Font Weight
5397
5398- Description: The default font weight for text in the UI.
5399- Setting: `ui_font_weight`
5400- Default: `400`
5401
5402**Options**
5403
5404`integer` values between `100` and `900`
5405
5406## Settings Profiles
5407
5408- Description: Configure any number of settings profiles that are temporarily applied when selected from `settings profile selector: toggle`.
5409- Setting: `profiles`
5410- Default: `{}`
5411
5412In your `settings.json` file, add the `profiles` object.
5413Each key within this object is the name of a settings profile. Each profile has an optional `base` field (`"user"` or `"default"`) and a `settings` object containing any of Zed's settings.
5414
5415Example:
5416
5417```json [settings]
5418{
5419 "profiles": {
5420 "Presenting (Dark)": {
5421 "settings": {
5422 "agent_buffer_font_size": 18.0,
5423 "buffer_font_size": 18.0,
5424 "theme": "One Dark",
5425 "ui_font_size": 18.0
5426 }
5427 },
5428 "Presenting (Light)": {
5429 "settings": {
5430 "agent_buffer_font_size": 18.0,
5431 "buffer_font_size": 18.0,
5432 "theme": "One Light",
5433 "ui_font_size": 18.0
5434 }
5435 },
5436 "Writing": {
5437 "settings": {
5438 "agent_buffer_font_size": 15.0,
5439 "buffer_font_size": 15.0,
5440 "theme": "Catppuccin Frappé - No Italics",
5441 "ui_font_size": 15.0,
5442 "tab_bar": { "show": false },
5443 "toolbar": { "breadcrumbs": false }
5444 }
5445 }
5446 }
5447}
5448```
5449
5450To preview and enable a settings profile, open the command palette via {#kb command_palette::Toggle} and search for `settings profile selector: toggle`.
5451
5452## An example configuration:
5453
5454```json [settings]
5455// ~/.config/zed/settings.json
5456{
5457 "theme": "cave-light",
5458 "tab_size": 2,
5459 "preferred_line_length": 80,
5460 "soft_wrap": "none",
5461
5462 "buffer_font_size": 18,
5463 "buffer_font_family": ".ZedMono",
5464
5465 "autosave": "on_focus_change",
5466 "format_on_save": "off",
5467 "vim_mode": false,
5468 "terminal": {
5469 "font_family": "FiraCode Nerd Font Mono",
5470 "blinking": "off"
5471 },
5472 "languages": {
5473 "C": {
5474 "format_on_save": "on",
5475 "formatter": "language_server",
5476 "preferred_line_length": 64,
5477 "soft_wrap": "preferred_line_length"
5478 }
5479 }
5480}
5481```