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
1911## Auto close
1912
1913- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1914- Setting: `use_autoclose`
1915- Default: `true`
1916
1917**Options**
1918
1919`boolean` values
1920
1921## Always Treat Brackets As Autoclosed
1922
1923- Description: Controls how the editor handles the autoclosed characters.
1924- Setting: `always_treat_brackets_as_autoclosed`
1925- Default: `false`
1926
1927**Options**
1928
1929`boolean` values
1930
1931**Example**
1932
1933If the setting is set to `true`:
1934
19351. Enter in the editor: `)))`
19362. Move the cursor to the start: `^)))`
19373. Enter again: `)))`
1938
1939The result is still `)))` and not `))))))`, which is what it would be by default.
1940
1941## File Scan Exclusions
1942
1943- Setting: `file_scan_exclusions`
1944- 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`.
1945- Default:
1946
1947```json [settings]
1948{
1949 "file_scan_exclusions": [
1950 "**/.git",
1951 "**/.svn",
1952 "**/.hg",
1953 "**/.jj",
1954 "**/CVS",
1955 "**/.DS_Store",
1956 "**/Thumbs.db",
1957 "**/.classpath",
1958 "**/.settings"
1959 ]
1960}
1961```
1962
1963Note, 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.
1964
1965## File Scan Inclusions
1966
1967- Setting: `file_scan_inclusions`
1968- 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.
1969- Default:
1970
1971```json [settings]
1972{
1973 "file_scan_inclusions": [".env*"]
1974}
1975```
1976
1977## File Types
1978
1979- Setting: `file_types`
1980- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1981- Default:
1982
1983```json [settings]
1984{
1985 "file_types": {
1986 "JSONC": [
1987 "**/.zed/**/*.json",
1988 "**/zed/**/*.json",
1989 "**/Zed/**/*.json",
1990 "**/.vscode/**/*.json"
1991 ],
1992 "Shell Script": [".env.*"]
1993 }
1994}
1995```
1996
1997**Examples**
1998
1999To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
2000
2001```json [settings]
2002{
2003 "file_types": {
2004 "C++": ["c"],
2005 "TOML": ["MyLockFile"],
2006 "Dockerfile": ["Dockerfile*"]
2007 }
2008}
2009```
2010
2011## Diagnostics
2012
2013- Description: Configuration for diagnostics-related features.
2014- Setting: `diagnostics`
2015- Default:
2016
2017```json [settings]
2018{
2019 "diagnostics": {
2020 "include_warnings": true,
2021 "inline": {
2022 "enabled": false
2023 }
2024 }
2025}
2026```
2027
2028### Inline Diagnostics
2029
2030- Description: Whether or not to show diagnostics information inline.
2031- Setting: `inline`
2032- Default:
2033
2034```json [settings]
2035{
2036 "diagnostics": {
2037 "inline": {
2038 "enabled": false,
2039 "update_debounce_ms": 150,
2040 "padding": 4,
2041 "min_column": 0,
2042 "max_severity": null
2043 }
2044 }
2045}
2046```
2047
2048**Options**
2049
20501. Enable inline diagnostics.
2051
2052```json [settings]
2053{
2054 "diagnostics": {
2055 "inline": {
2056 "enabled": true
2057 }
2058 }
2059}
2060```
2061
20622. Delay diagnostic updates until some time after the last diagnostic update.
2063
2064```json [settings]
2065{
2066 "diagnostics": {
2067 "inline": {
2068 "enabled": true,
2069 "update_debounce_ms": 150
2070 }
2071 }
2072}
2073```
2074
20753. Set padding between the end of the source line and the start of the diagnostic.
2076
2077```json [settings]
2078{
2079 "diagnostics": {
2080 "inline": {
2081 "enabled": true,
2082 "padding": 4
2083 }
2084 }
2085}
2086```
2087
20884. Horizontally align inline diagnostics at the given column.
2089
2090```json [settings]
2091{
2092 "diagnostics": {
2093 "inline": {
2094 "enabled": true,
2095 "min_column": 80
2096 }
2097 }
2098}
2099```
2100
21015. Show only warning and error diagnostics.
2102
2103```json [settings]
2104{
2105 "diagnostics": {
2106 "inline": {
2107 "enabled": true,
2108 "max_severity": "warning"
2109 }
2110 }
2111}
2112```
2113
2114## Git
2115
2116- Description: Configuration for git-related features.
2117- Setting: `git`
2118- Default:
2119
2120```json [settings]
2121{
2122 "git": {
2123 "git_gutter": "tracked_files",
2124 "inline_blame": {
2125 "enabled": true
2126 },
2127 "branch_picker": {
2128 "show_author_name": true
2129 },
2130 "hunk_style": "staged_hollow"
2131 }
2132}
2133```
2134
2135### Git Gutter
2136
2137- Description: Whether or not to show the git gutter.
2138- Setting: `git_gutter`
2139- Default: `tracked_files`
2140
2141**Options**
2142
21431. Show git gutter in tracked files
2144
2145```json [settings]
2146{
2147 "git": {
2148 "git_gutter": "tracked_files"
2149 }
2150}
2151```
2152
21532. Hide git gutter
2154
2155```json [settings]
2156{
2157 "git": {
2158 "git_gutter": "hide"
2159 }
2160}
2161```
2162
2163### Gutter Debounce
2164
2165- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2166- Setting: `gutter_debounce`
2167- Default: `null`
2168
2169**Options**
2170
2171`integer` values representing milliseconds
2172
2173Example:
2174
2175```json [settings]
2176{
2177 "git": {
2178 "gutter_debounce": 100
2179 }
2180}
2181```
2182
2183### Inline Git Blame
2184
2185- Description: Whether or not to show git blame information inline, on the currently focused line.
2186- Setting: `inline_blame`
2187- Default:
2188
2189```json [settings]
2190{
2191 "git": {
2192 "inline_blame": {
2193 "enabled": true
2194 }
2195 }
2196}
2197```
2198
2199**Options**
2200
22011. Disable inline git blame:
2202
2203```json [settings]
2204{
2205 "git": {
2206 "inline_blame": {
2207 "enabled": false
2208 }
2209 }
2210}
2211```
2212
22132. Only show inline git blame after a delay (that starts after cursor stops moving):
2214
2215```json [settings]
2216{
2217 "git": {
2218 "inline_blame": {
2219 "delay_ms": 500
2220 }
2221 }
2222}
2223```
2224
22253. Show a commit summary next to the commit date and author:
2226
2227```json [settings]
2228{
2229 "git": {
2230 "inline_blame": {
2231 "show_commit_summary": true
2232 }
2233 }
2234}
2235```
2236
22374. Use this as the minimum column at which to display inline blame information:
2238
2239```json [settings]
2240{
2241 "git": {
2242 "inline_blame": {
2243 "min_column": 80
2244 }
2245 }
2246}
2247```
2248
22495. Set the padding between the end of the line and the inline blame hint, in ems:
2250
2251```json [settings]
2252{
2253 "git": {
2254 "inline_blame": {
2255 "padding": 10
2256 }
2257 }
2258}
2259```
2260
2261### Branch Picker
2262
2263- Description: Configuration related to the branch picker.
2264- Setting: `branch_picker`
2265- Default:
2266
2267```json [settings]
2268{
2269 "git": {
2270 "branch_picker": {
2271 "show_author_name": false
2272 }
2273 }
2274}
2275```
2276
2277**Options**
2278
22791. Show the author name in the branch picker:
2280
2281```json [settings]
2282{
2283 "git": {
2284 "branch_picker": {
2285 "show_author_name": true
2286 }
2287 }
2288}
2289```
2290
2291### Hunk Style
2292
2293- Description: What styling we should use for the diff hunks.
2294- Setting: `hunk_style`
2295- Default:
2296
2297```json [settings]
2298{
2299 "git": {
2300 "hunk_style": "staged_hollow"
2301 }
2302}
2303```
2304
2305**Options**
2306
23071. Show the staged hunks faded out and with a border:
2308
2309```json [settings]
2310{
2311 "git": {
2312 "hunk_style": "staged_hollow"
2313 }
2314}
2315```
2316
23172. Show unstaged hunks faded out and with a border:
2318
2319```json [settings]
2320{
2321 "git": {
2322 "hunk_style": "unstaged_hollow"
2323 }
2324}
2325```
2326
2327## Go to Definition Fallback
2328
2329- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2330- Setting: `go_to_definition_fallback`
2331- Default: `"find_all_references"`
2332
2333**Options**
2334
23351. Do nothing:
2336
2337```json [settings]
2338{
2339 "go_to_definition_fallback": "none"
2340}
2341```
2342
23432. Find references for the same symbol (default):
2344
2345```json [settings]
2346{
2347 "go_to_definition_fallback": "find_all_references"
2348}
2349```
2350
2351## Hard Tabs
2352
2353- Description: Whether to indent lines using tab characters or multiple spaces.
2354- Setting: `hard_tabs`
2355- Default: `false`
2356
2357**Options**
2358
2359`boolean` values
2360
2361## Helix Mode
2362
2363- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](../helix.md) for more details.
2364- Setting: `helix_mode`
2365- Default: `false`
2366
2367**Options**
2368
2369`boolean` values
2370
2371## Indent Guides
2372
2373- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2374- Setting: `indent_guides`
2375- Default:
2376
2377```json [settings]
2378{
2379 "indent_guides": {
2380 "enabled": true,
2381 "line_width": 1,
2382 "active_line_width": 1,
2383 "coloring": "fixed",
2384 "background_coloring": "disabled"
2385 }
2386}
2387```
2388
2389**Options**
2390
23911. Disable indent guides
2392
2393```json [settings]
2394{
2395 "indent_guides": {
2396 "enabled": false
2397 }
2398}
2399```
2400
24012. Enable indent guides for a specific language.
2402
2403```json [settings]
2404{
2405 "languages": {
2406 "Python": {
2407 "indent_guides": {
2408 "enabled": true
2409 }
2410 }
2411 }
2412}
2413```
2414
24153. Enable indent aware coloring ("rainbow indentation").
2416 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.
2417
2418```json [settings]
2419{
2420 "indent_guides": {
2421 "enabled": true,
2422 "coloring": "indent_aware"
2423 }
2424}
2425```
2426
24274. Enable indent aware background coloring ("rainbow indentation").
2428 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.
2429
2430```json [settings]
2431{
2432 "indent_guides": {
2433 "enabled": true,
2434 "coloring": "indent_aware",
2435 "background_coloring": "indent_aware"
2436 }
2437}
2438```
2439
2440## Hover Popover Enabled
2441
2442- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2443- Setting: `hover_popover_enabled`
2444- Default: `true`
2445
2446**Options**
2447
2448`boolean` values
2449
2450## Hover Popover Delay
2451
2452- 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.
2453- Setting: `hover_popover_delay`
2454- Default: `300`
2455
2456**Options**
2457
2458`integer` values representing milliseconds
2459
2460## Icon Theme
2461
2462- 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.
2463- Setting: `icon_theme`
2464- Default: `Zed (Default)`
2465
2466### Icon Theme Object
2467
2468- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2469- Setting: `icon_theme`
2470- Default:
2471
2472```json [settings]
2473{
2474 "icon_theme": {
2475 "mode": "system",
2476 "dark": "Zed (Default)",
2477 "light": "Zed (Default)"
2478 }
2479}
2480```
2481
2482### Mode
2483
2484- Description: Specify the icon theme mode.
2485- Setting: `mode`
2486- Default: `system`
2487
2488**Options**
2489
24901. Set the icon theme to dark mode
2491
2492```json [settings]
2493{
2494 "icon_theme": {
2495 "mode": "dark",
2496 "dark": "Zed (Default)",
2497 "light": "Zed (Default)"
2498 }
2499}
2500```
2501
25022. Set the icon theme to light mode
2503
2504```json [settings]
2505{
2506 "icon_theme": {
2507 "mode": "light",
2508 "dark": "Zed (Default)",
2509 "light": "Zed (Default)"
2510 }
2511}
2512```
2513
25143. Set the icon theme to system mode
2515
2516```json [settings]
2517{
2518 "icon_theme": {
2519 "mode": "system",
2520 "dark": "Zed (Default)",
2521 "light": "Zed (Default)"
2522 }
2523}
2524```
2525
2526### Dark
2527
2528- Description: The name of the dark icon theme.
2529- Setting: `dark`
2530- Default: `Zed (Default)`
2531
2532**Options**
2533
2534Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2535
2536### Light
2537
2538- Description: The name of the light icon theme.
2539- Setting: `light`
2540- Default: `Zed (Default)`
2541
2542**Options**
2543
2544Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2545
2546## Image Viewer
2547
2548- Description: Settings for image viewer functionality
2549- Setting: `image_viewer`
2550- Default:
2551
2552```json [settings]
2553{
2554 "image_viewer": {
2555 "unit": "binary"
2556 }
2557}
2558```
2559
2560**Options**
2561
2562### Unit
2563
2564- Description: The unit for image file sizes
2565- Setting: `unit`
2566- Default: `"binary"`
2567
2568**Options**
2569
25701. Use binary units (KiB, MiB):
2571
2572```json [settings]
2573{
2574 "image_viewer": {
2575 "unit": "binary"
2576 }
2577}
2578```
2579
25802. Use decimal units (KB, MB):
2581
2582```json [settings]
2583{
2584 "image_viewer": {
2585 "unit": "decimal"
2586 }
2587}
2588```
2589
2590## Inlay hints
2591
2592- Description: Configuration for displaying extra text with hints in the editor.
2593- Setting: `inlay_hints`
2594- Default:
2595
2596```json [settings]
2597{
2598 "inlay_hints": {
2599 "enabled": false,
2600 "show_type_hints": true,
2601 "show_parameter_hints": true,
2602 "show_other_hints": true,
2603 "show_background": false,
2604 "edit_debounce_ms": 700,
2605 "scroll_debounce_ms": 50,
2606 "toggle_on_modifiers_press": null
2607 }
2608}
2609```
2610
2611**Options**
2612
2613Inlay hints querying consists of two parts: editor (client) and LSP server.
2614With 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.
2615At 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.
2616
2617The following languages have inlay hints preconfigured by Zed:
2618
2619- [Go](https://docs.zed.dev/languages/go)
2620- [Rust](https://docs.zed.dev/languages/rust)
2621- [Svelte](https://docs.zed.dev/languages/svelte)
2622- [TypeScript](https://docs.zed.dev/languages/typescript)
2623
2624Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2625
2626Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2627Settings-related hint updates are not debounced.
2628
2629All possible config values for `toggle_on_modifiers_press` are:
2630
2631```json [settings]
2632{
2633 "inlay_hints": {
2634 "toggle_on_modifiers_press": {
2635 "control": true,
2636 "shift": true,
2637 "alt": true,
2638 "platform": true,
2639 "function": true
2640 }
2641 }
2642}
2643```
2644
2645Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2646
2647## Journal
2648
2649- Description: Configuration for the journal.
2650- Setting: `journal`
2651- Default:
2652
2653```json [settings]
2654{
2655 "journal": {
2656 "path": "~",
2657 "hour_format": "hour12"
2658 }
2659}
2660```
2661
2662### Path
2663
2664- 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).
2665- Setting: `path`
2666- Default: `~`
2667
2668**Options**
2669
2670`string` values
2671
2672### Hour Format
2673
2674- Description: The format to use for displaying hours in the journal.
2675- Setting: `hour_format`
2676- Default: `hour12`
2677
2678**Options**
2679
26801. 12-hour format:
2681
2682```json [settings]
2683{
2684 "journal": {
2685 "hour_format": "hour12"
2686 }
2687}
2688```
2689
26902. 24-hour format:
2691
2692```json [settings]
2693{
2694 "journal": {
2695 "hour_format": "hour24"
2696 }
2697}
2698```
2699
2700## JSX Tag Auto Close
2701
2702- Description: Whether to automatically close JSX tags
2703- Setting: `jsx_tag_auto_close`
2704- Default:
2705
2706```json [settings]
2707{
2708 "jsx_tag_auto_close": {
2709 "enabled": true
2710 }
2711}
2712```
2713
2714**Options**
2715
2716- `enabled`: Whether to enable automatic JSX tag closing
2717
2718## Languages
2719
2720- Description: Configuration for specific languages.
2721- Setting: `languages`
2722- Default: `null`
2723
2724**Options**
2725
2726To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2727
2728```json [settings]
2729{
2730 "languages": {
2731 "C": {
2732 "format_on_save": "off",
2733 "preferred_line_length": 64,
2734 "soft_wrap": "preferred_line_length"
2735 },
2736 "JSON": {
2737 "tab_size": 4
2738 }
2739 }
2740}
2741```
2742
2743The following settings can be overridden for each specific language:
2744
2745- [`enable_language_server`](#enable-language-server)
2746- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2747- [`format_on_save`](#format-on-save)
2748- [`formatter`](#formatter)
2749- [`hard_tabs`](#hard-tabs)
2750- [`preferred_line_length`](#preferred-line-length)
2751- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2752- [`semantic_tokens`](#semantic-tokens)
2753- [`show_edit_predictions`](#show-edit-predictions)
2754- [`show_whitespaces`](#show-whitespaces)
2755- [`whitespace_map`](#whitespace-map)
2756- [`soft_wrap`](#soft-wrap)
2757- [`tab_size`](#tab-size)
2758- [`use_autoclose`](#use-autoclose)
2759- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2760
2761These values take in the same options as the root-level settings with the same name.
2762
2763### Document Symbols
2764
2765- Description: Controls the source of document symbols used for outlines and breadcrumbs.
2766- Setting: `document_symbols`
2767- Default: `off`
2768
2769**Options**
2770
2771- `"off"`: Use tree-sitter queries to compute document symbols (default)
2772- `"on"`: Use the language server's `textDocument/documentSymbol` LSP response. When enabled, tree-sitter is not used for document symbols
2773
2774LSP 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.
2775
2776Example:
2777
2778```json [settings]
2779{
2780 "languages": {
2781 "TypeScript": {
2782 "document_symbols": "on"
2783 }
2784 }
2785}
2786```
2787
2788## Language Models
2789
2790- Description: Configuration for language model providers
2791- Setting: `language_models`
2792- Default:
2793
2794```json [settings]
2795{
2796 "language_models": {
2797 "anthropic": {
2798 "api_url": "https://api.anthropic.com"
2799 },
2800 "google": {
2801 "api_url": "https://generativelanguage.googleapis.com"
2802 },
2803 "ollama": {
2804 "api_url": "http://localhost:11434"
2805 },
2806 "openai": {
2807 "api_url": "https://api.openai.com/v1"
2808 }
2809 }
2810}
2811```
2812
2813**Options**
2814
2815Configuration for various AI model providers including API URLs and authentication settings.
2816
2817## Line Indicator Format
2818
2819- Description: Format for line indicator in the status bar
2820- Setting: `line_indicator_format`
2821- Default: `"short"`
2822
2823**Options**
2824
28251. Short format:
2826
2827```json [settings]
2828{
2829 "line_indicator_format": "short"
2830}
2831```
2832
28332. Long format:
2834
2835```json [settings]
2836{
2837 "line_indicator_format": "long"
2838}
2839```
2840
2841## Linked Edits
2842
2843- 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.
2844- Setting: `linked_edits`
2845- Default: `true`
2846
2847**Options**
2848
2849`boolean` values
2850
2851## LSP Document Colors
2852
2853- Description: How to render LSP `textDocument/documentColor` colors in the editor
2854- Setting: `lsp_document_colors`
2855- Default: `inlay`
2856
2857**Options**
2858
28591. `inlay`: Render document colors as inlay hints near the color text.
28602. `background`: Draw a background behind the color text.
28613. `border`: Draw a border around the color text.
28624. `none`: Do not query and render document colors.
2863
2864## Max Tabs
2865
2866- Description: Maximum number of tabs to show in the tab bar
2867- Setting: `max_tabs`
2868- Default: `null`
2869
2870**Options**
2871
2872Positive `integer` values or `null` for unlimited tabs
2873
2874## Middle Click Paste (Linux only)
2875
2876- Description: Enable middle-click paste on Linux
2877- Setting: `middle_click_paste`
2878- Default: `true`
2879
2880**Options**
2881
2882`boolean` values
2883
2884## Multi Cursor Modifier
2885
2886- 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.
2887- Setting: `multi_cursor_modifier`
2888- Default: `alt`
2889
2890**Options**
2891
28921. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2893
2894```json [settings]
2895{
2896 "multi_cursor_modifier": "alt"
2897}
2898```
2899
29002. Maps `Control` on Linux and Windows and to `Command` on macOS:
2901
2902```json [settings]
2903{
2904 "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2905}
2906```
2907
2908## Node
2909
2910- Description: Configuration for Node.js integration
2911- Setting: `node`
2912- Default:
2913
2914```json [settings]
2915{
2916 "node": {
2917 "ignore_system_version": false,
2918 "path": null,
2919 "npm_path": null
2920 }
2921}
2922```
2923
2924**Options**
2925
2926- `ignore_system_version`: Whether to ignore the system Node.js version
2927- `path`: Custom path to Node.js binary
2928- `npm_path`: Custom path to npm binary
2929
2930## Network Proxy
2931
2932- Description: Configure a network proxy for Zed.
2933- Setting: `proxy`
2934- Default: `null`
2935
2936**Options**
2937
2938The proxy setting must contain a URL to the proxy.
2939
2940The following URI schemes are supported:
2941
2942- `http`
2943- `https`
2944- `socks4` - SOCKS4 proxy with local DNS
2945- `socks4a` - SOCKS4 proxy with remote DNS
2946- `socks5` - SOCKS5 proxy with local DNS
2947- `socks5h` - SOCKS5 proxy with remote DNS
2948
2949`http` will be used when no scheme is specified.
2950
2951By 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`.
2952
2953For example, to set an `http` proxy, add the following to your settings:
2954
2955```json [settings]
2956{
2957 "proxy": "http://127.0.0.1:10809"
2958}
2959```
2960
2961Or to set a `socks5` proxy:
2962
2963```json [settings]
2964{
2965 "proxy": "socks5h://localhost:10808"
2966}
2967```
2968
2969If 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.
2970
2971## On Last Window Closed
2972
2973- Description: What to do when the last window is closed
2974- Setting: `on_last_window_closed`
2975- Default: `"platform_default"`
2976
2977**Options**
2978
29791. Use platform default behavior:
2980
2981```json [settings]
2982{
2983 "on_last_window_closed": "platform_default"
2984}
2985```
2986
29872. Always quit the application:
2988
2989```json [settings]
2990{
2991 "on_last_window_closed": "quit_app"
2992}
2993```
2994
2995## Profiles
2996
2997- Description: Configuration profiles that can be applied on top of existing settings
2998- Setting: `profiles`
2999- Default: `{}`
3000
3001**Options**
3002
3003Configuration object for defining settings profiles. Example:
3004
3005```json [settings]
3006{
3007 "profiles": {
3008 "presentation": {
3009 "buffer_font_size": 20,
3010 "ui_font_size": 18,
3011 "theme": "One Light"
3012 }
3013 }
3014}
3015```
3016
3017## Preview tabs
3018
3019- Description:
3020 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. \
3021 There are several ways to convert a preview tab into a regular tab:
3022
3023 - Double-clicking on the file
3024 - Double-clicking on the tab header
3025 - Using the {#action project_panel::OpenPermanent} action
3026 - Editing the file
3027 - Dragging the file to a different pane
3028
3029- Setting: `preview_tabs`
3030- Default:
3031
3032```json [settings]
3033{
3034 "preview_tabs": {
3035 "enabled": true,
3036 "enable_preview_from_project_panel": true,
3037 "enable_preview_from_file_finder": false,
3038 "enable_preview_from_multibuffer": true,
3039 "enable_preview_multibuffer_from_code_navigation": false,
3040 "enable_preview_file_from_code_navigation": true,
3041 "enable_keep_preview_on_code_navigation": false
3042 }
3043}
3044```
3045
3046### Enable preview from project panel
3047
3048- Description: Determines whether to open files in preview mode when opened from the project panel with a single click.
3049- Setting: `enable_preview_from_project_panel`
3050- Default: `true`
3051
3052**Options**
3053
3054`boolean` values
3055
3056### Enable preview from file finder
3057
3058- Description: Determines whether to open files in preview mode when selected from the file finder.
3059- Setting: `enable_preview_from_file_finder`
3060- Default: `false`
3061
3062**Options**
3063
3064`boolean` values
3065
3066### Enable preview from multibuffer
3067
3068- Description: Determines whether to open files in preview mode when opened from a multibuffer.
3069- Setting: `enable_preview_from_multibuffer`
3070- Default: `true`
3071
3072**Options**
3073
3074`boolean` values
3075
3076### Enable preview multibuffer from code navigation
3077
3078- Description: Determines whether to open tabs in preview mode when code navigation is used to open a multibuffer.
3079- Setting: `enable_preview_multibuffer_from_code_navigation`
3080- Default: `false`
3081
3082**Options**
3083
3084`boolean` values
3085
3086### Enable preview file from code navigation
3087
3088- Description: Determines whether to open tabs in preview mode when code navigation is used to open a single file.
3089- Setting: `enable_preview_file_from_code_navigation`
3090- Default: `true`
3091
3092**Options**
3093
3094`boolean` values
3095
3096### Enable keep preview on code navigation
3097
3098- 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.
3099- Setting: `enable_keep_preview_on_code_navigation`
3100- Default: `false`
3101
3102**Options**
3103
3104`boolean` values
3105
3106## File Finder
3107
3108### File Icons
3109
3110- Description: Whether to show file icons in the file finder.
3111- Setting: `file_icons`
3112- Default: `true`
3113
3114### Modal Max Width
3115
3116- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
3117- Setting: `modal_max_width`
3118- Default: `small`
3119
3120### Skip Focus For Active In Search
3121
3122- Description: Determines whether the file finder should skip focus for the active file in search results.
3123- Setting: `skip_focus_for_active_in_search`
3124- Default: `true`
3125
3126## Pane Split Direction Horizontal
3127
3128- Description: The direction that you want to split panes horizontally
3129- Setting: `pane_split_direction_horizontal`
3130- Default: `"up"`
3131
3132**Options**
3133
31341. Split upward:
3135
3136```json [settings]
3137{
3138 "pane_split_direction_horizontal": "up"
3139}
3140```
3141
31422. Split downward:
3143
3144```json [settings]
3145{
3146 "pane_split_direction_horizontal": "down"
3147}
3148```
3149
3150## Pane Split Direction Vertical
3151
3152- Description: The direction that you want to split panes vertically
3153- Setting: `pane_split_direction_vertical`
3154- Default: `"left"`
3155
3156**Options**
3157
31581. Split to the left:
3159
3160```json [settings]
3161{
3162 "pane_split_direction_vertical": "left"
3163}
3164```
3165
31662. Split to the right:
3167
3168```json [settings]
3169{
3170 "pane_split_direction_vertical": "right"
3171}
3172```
3173
3174## Preferred Line Length
3175
3176- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
3177- Setting: `preferred_line_length`
3178- Default: `80`
3179
3180**Options**
3181
3182`integer` values
3183
3184## Private Files
3185
3186- Description: Globs to match against file paths to determine if a file is private
3187- Setting: `private_files`
3188- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
3189
3190**Options**
3191
3192List of `string` glob patterns
3193
3194## Projects Online By Default
3195
3196- Description: Whether or not to show the online projects view by default.
3197- Setting: `projects_online_by_default`
3198- Default: `true`
3199
3200**Options**
3201
3202`boolean` values
3203
3204## Read SSH Config
3205
3206- Description: Whether to read SSH configuration files
3207- Setting: `read_ssh_config`
3208- Default: `true`
3209
3210**Options**
3211
3212`boolean` values
3213
3214## Redact Private Values
3215
3216- Description: Hide the values of variables from visual display in private files
3217- Setting: `redact_private_values`
3218- Default: `false`
3219
3220**Options**
3221
3222`boolean` values
3223
3224## Relative Line Numbers
3225
3226- Description: Whether to show relative line numbers in the gutter
3227- Setting: `relative_line_numbers`
3228- Default: `"disabled"`
3229
3230**Options**
3231
32321. Show relative line numbers in the gutter whilst counting wrapped lines as one line:
3233
3234```json [settings]
3235{
3236 "relative_line_numbers": "enabled"
3237}
3238```
3239
32402. Show relative line numbers in the gutter, including wrapped lines in the counting:
3241
3242```json [settings]
3243{
3244 "relative_line_numbers": "wrapped"
3245}
3246```
3247
32482. Do not use relative line numbers:
3249
3250```json [settings]
3251{
3252 "relative_line_numbers": "disabled"
3253}
3254```
3255
3256## Remove Trailing Whitespace On Save
3257
3258- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3259- Setting: `remove_trailing_whitespace_on_save`
3260- Default: `true`
3261
3262**Options**
3263
3264`boolean` values
3265
3266## Resize All Panels In Dock
3267
3268- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3269- Setting: `resize_all_panels_in_dock`
3270- Default: `["left"]`
3271
3272**Options**
3273
3274List of strings containing any combination of:
3275
3276- `"left"`: Resize left dock panels together
3277- `"right"`: Resize right dock panels together
3278- `"bottom"`: Resize bottom dock panels together
3279
3280## Restore on File Reopen
3281
3282- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3283- Setting: `restore_on_file_reopen`
3284- Default: `true`
3285
3286**Options**
3287
3288`boolean` values
3289
3290## Restore on Startup
3291
3292- Description: Controls session restoration on startup.
3293- Setting: `restore_on_startup`
3294- Default: `last_session`
3295
3296**Options**
3297
32981. Restore all workspaces that were open when quitting Zed:
3299
3300```json [settings]
3301{
3302 "restore_on_startup": "last_session"
3303}
3304```
3305
33062. Restore the workspace that was closed last:
3307
3308```json [settings]
3309{
3310 "restore_on_startup": "last_workspace"
3311}
3312```
3313
33143. Always start with an empty editor:
3315
3316```json [settings]
3317{
3318 "restore_on_startup": "empty_tab"
3319}
3320```
3321
33224. Always start with the welcome launchpad:
3323
3324```json [settings]
3325{
3326 "restore_on_startup": "launchpad"
3327}
3328```
3329
3330## Scroll Beyond Last Line
3331
3332- Description: Whether the editor will scroll beyond the last line
3333- Setting: `scroll_beyond_last_line`
3334- Default: `"one_page"`
3335
3336**Options**
3337
33381. Scroll one page beyond the last line by one page:
3339
3340```json [settings]
3341{
3342 "scroll_beyond_last_line": "one_page"
3343}
3344```
3345
33462. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3347
3348```json [settings]
3349{
3350 "scroll_beyond_last_line": "vertical_scroll_margin"
3351}
3352```
3353
33543. The editor will not scroll beyond the last line:
3355
3356```json [settings]
3357{
3358 "scroll_beyond_last_line": "off"
3359}
3360```
3361
3362**Options**
3363
3364`boolean` values
3365
3366## Scroll Sensitivity
3367
3368- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3369- Setting: `scroll_sensitivity`
3370- Default: `1.0`
3371
3372**Options**
3373
3374Positive `float` values
3375
3376### Fast Scroll Sensitivity
3377
3378- 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.
3379- Setting: `fast_scroll_sensitivity`
3380- Default: `4.0`
3381
3382**Options**
3383
3384Positive `float` values
3385
3386### Horizontal Scroll Margin
3387
3388- Description: The number of characters to keep on either side when scrolling with the mouse
3389- Setting: `horizontal_scroll_margin`
3390- Default: `5`
3391
3392**Options**
3393
3394Non-negative `integer` values
3395
3396### Vertical Scroll Margin
3397
3398- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3399- Setting: `vertical_scroll_margin`
3400- Default: `3`
3401
3402**Options**
3403
3404Non-negative `integer` values
3405
3406## Search
3407
3408- Description: Search options to enable by default when opening new project and buffer searches.
3409- Setting: `search`
3410- Default:
3411
3412```json [settings]
3413{
3414 "search": {
3415 "button": true,
3416 "whole_word": false,
3417 "case_sensitive": false,
3418 "include_ignored": false,
3419 "regex": false,
3420 "center_on_match": false
3421 }
3422}
3423```
3424
3425### Button
3426
3427- Description: Whether to show the project search button in the status bar.
3428- Setting: `button`
3429- Default: `true`
3430
3431### Whole Word
3432
3433- Description: Whether to only match on whole words.
3434- Setting: `whole_word`
3435- Default: `false`
3436
3437### Case Sensitive
3438
3439- Description: Whether to match case sensitively. This setting affects both
3440 searches and editor actions like "Select Next Occurrence", "Select Previous
3441 Occurrence", and "Select All Occurrences".
3442- Setting: `case_sensitive`
3443- Default: `false`
3444
3445### Include Ignore
3446
3447- Description: Whether to include gitignored files in search results.
3448- Setting: `include_ignored`
3449- Default: `false`
3450
3451### Regex
3452
3453- Description: Whether to interpret the search query as a regular expression.
3454- Setting: `regex`
3455- Default: `false`
3456
3457### Search On Input
3458
3459- Description: Whether to search on input in project search.
3460- Setting: `search_on_input`
3461- Default: `true`
3462
3463### Center On Match
3464
3465- Description: Whether to center the cursor on each search match when navigating.
3466- Setting: `center_on_match`
3467- Default: `false`
3468
3469## Search Wrap
3470
3471- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3472- Setting: `search_wrap`
3473- Default: `true`
3474
3475## Seed Search Query From Cursor
3476
3477- Description: When to populate a new search's query based on the text under the cursor.
3478- Setting: `seed_search_query_from_cursor`
3479- Default: `always`
3480
3481**Options**
3482
34831. `always` always populate the search query with the word under the cursor
34842. `selection` only populate the search query when there is text selected
34853. `never` never populate the search query
3486
3487## Semantic Tokens
3488
3489- Description: Controls how semantic tokens from language servers are used for syntax highlighting.
3490- Setting: `semantic_tokens`
3491- Default: `off`
3492
3493**Options**
3494
34951. `off`: Do not request semantic tokens from language servers.
34962. `combined`: Use LSP semantic tokens together with tree-sitter highlighting.
34973. `full`: Use LSP semantic tokens exclusively, replacing tree-sitter highlighting.
3498
3499To enable semantic tokens globally:
3500
3501```json [settings]
3502{
3503 "semantic_tokens": "combined"
3504}
3505```
3506
3507To enable semantic tokens for a specific language:
3508
3509```json [settings]
3510{
3511 "languages": {
3512 "Rust": {
3513 "semantic_tokens": "full"
3514 }
3515 }
3516}
3517```
3518
3519May require language server restart to properly apply.
3520
3521## LSP Folding Ranges
3522
3523- 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.
3524- Setting: `document_folding_ranges`
3525- Default: `off`
3526
3527**Options**
3528
35291. `off`: Use tree-sitter and indent-based folding.
35302. `on`: Use LSP folding wherever possible, falling back to tree-sitter and indent-based folding when no results were returned by the server.
3531
3532To enable LSP folding ranges globally:
3533
3534```json [settings]
3535{
3536 "document_folding_ranges": "on"
3537}
3538```
3539
3540To enable LSP folding ranges for a specific language:
3541
3542```json [settings]
3543{
3544 "languages": {
3545 "Rust": {
3546 "document_folding_ranges": "on"
3547 }
3548 }
3549}
3550```
3551
3552## LSP Document Symbols
3553
3554- 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.
3555- Setting: `document_symbols`
3556- Default: `off`
3557
3558**Options**
3559
35601. `off`: Use tree-sitter queries to compute document symbols.
35612. `on`: Use the language server's `textDocument/documentSymbol` LSP response. When enabled, tree-sitter is not used for document symbols.
3562
3563To enable LSP document symbols globally:
3564
3565```json [settings]
3566{
3567 "document_symbols": "on"
3568}
3569```
3570
3571To enable LSP document symbols for a specific language:
3572
3573```json [settings]
3574{
3575 "languages": {
3576 "Rust": {
3577 "document_symbols": "on"
3578 }
3579 }
3580}
3581```
3582
3583## Use Smartcase Search
3584
3585- 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. \
3586 This applies to both in-file searches and project-wide searches.
3587- Setting: `use_smartcase_search`
3588- Default: `false`
3589
3590**Options**
3591
3592`boolean` values
3593
3594Examples:
3595
3596- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3597- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3598
3599## Show Call Status Icon
3600
3601- Description: Whether or not to show the call status icon in the status bar.
3602- Setting: `show_call_status_icon`
3603- Default: `true`
3604
3605**Options**
3606
3607`boolean` values
3608
3609## Completions
3610
3611- Description: Controls how completions are processed for this language.
3612- Setting: `completions`
3613- Default:
3614
3615```json [settings]
3616{
3617 "completions": {
3618 "words": "fallback",
3619 "words_min_length": 3,
3620 "lsp": true,
3621 "lsp_fetch_timeout_ms": 0,
3622 "lsp_insert_mode": "replace_suffix"
3623 }
3624}
3625```
3626
3627### Words
3628
3629- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3630- Setting: `words`
3631- Default: `fallback`
3632
3633**Options**
3634
36351. `enabled` - Always fetch document's words for completions along with LSP completions
36362. `fallback` - Only if LSP response errors or times out, use document's words to show completions
36373. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3638
3639### Min Words Query Length
3640
3641- Description: Minimum number of characters required to automatically trigger word-based completions.
3642 Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3643- Setting: `words_min_length`
3644- Default: `3`
3645
3646**Options**
3647
3648Positive integer values
3649
3650### LSP
3651
3652- Description: Whether to fetch LSP completions or not.
3653- Setting: `lsp`
3654- Default: `true`
3655
3656**Options**
3657
3658`boolean` values
3659
3660### LSP Fetch Timeout (ms)
3661
3662- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3663- Setting: `lsp_fetch_timeout_ms`
3664- Default: `0`
3665
3666**Options**
3667
3668`integer` values representing milliseconds
3669
3670### LSP Insert Mode
3671
3672- Description: Controls what range to replace when accepting LSP completions.
3673- Setting: `lsp_insert_mode`
3674- Default: `replace_suffix`
3675
3676**Options**
3677
36781. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
36792. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
36803. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
36814. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3682
3683## Show Completions On Input
3684
3685- Description: Whether or not to show completions as you type.
3686- Setting: `show_completions_on_input`
3687- Default: `true`
3688
3689**Options**
3690
3691`boolean` values
3692
3693## Show Completion Documentation
3694
3695- Description: Whether to display inline and alongside documentation for items in the completions menu.
3696- Setting: `show_completion_documentation`
3697- Default: `true`
3698
3699**Options**
3700
3701`boolean` values
3702
3703## Show Edit Predictions
3704
3705- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3706- Setting: `show_edit_predictions`
3707- Default: `true`
3708
3709**Options**
3710
3711`boolean` values
3712
3713## Show Whitespaces
3714
3715- Description: Whether or not to render whitespace characters in the editor.
3716- Setting: `show_whitespaces`
3717- Default: `selection`
3718
3719**Options**
3720
37211. `all`
37222. `selection`
37233. `none`
37244. `boundary`
3725
3726## Whitespace Map
3727
3728- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3729- Setting: `whitespace_map`
3730- Default:
3731
3732```json [settings]
3733{
3734 "whitespace_map": {
3735 "space": "•",
3736 "tab": "→"
3737 }
3738}
3739```
3740
3741## Soft Wrap
3742
3743- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3744- Setting: `soft_wrap`
3745- Default: `none`
3746
3747**Options**
3748
37491. `none` to avoid wrapping generally, unless the line is too long
37502. `prefer_line` (deprecated, same as `none`)
37513. `editor_width` to wrap lines that overflow the editor width
37524. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
37535. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3754
3755## Show Wrap Guides
3756
3757- 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.
3758- Setting: `show_wrap_guides`
3759- Default: `true`
3760
3761**Options**
3762
3763`boolean` values
3764
3765## Use On Type Format
3766
3767- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3768- Setting: `use_on_type_format`
3769- Default: `true`
3770
3771**Options**
3772
3773`boolean` values
3774
3775## Use Auto Surround
3776
3777- 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 ().
3778- Setting: `use_auto_surround`
3779- Default: `true`
3780
3781**Options**
3782
3783`boolean` values
3784
3785## Use System Path Prompts
3786
3787- 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.
3788- Setting: `use_system_path_prompts`
3789- Default: `true`
3790
3791**Options**
3792
3793`boolean` values
3794
3795## Use System Prompts
3796
3797- 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.
3798- Setting: `use_system_prompts`
3799- Default: `true`
3800
3801**Options**
3802
3803`boolean` values
3804
3805## Wrap Guides (Vertical Rulers)
3806
3807- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3808- Setting: `wrap_guides`
3809- Default: []
3810
3811**Options**
3812
3813List of `integer` column numbers
3814
3815## Tab Size
3816
3817- Description: The number of spaces to use for each tab character.
3818- Setting: `tab_size`
3819- Default: `4`
3820
3821**Options**
3822
3823`integer` values
3824
3825## Tasks
3826
3827- Description: Configuration for tasks that can be run within Zed
3828- Setting: `tasks`
3829- Default:
3830
3831```json [settings]
3832{
3833 "tasks": {
3834 "variables": {},
3835 "enabled": true,
3836 "prefer_lsp": false
3837 }
3838}
3839```
3840
3841**Options**
3842
3843- `variables`: Custom variables for task configuration
3844- `enabled`: Whether tasks are enabled
3845- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3846
3847## Telemetry
3848
3849- Description: Control what info is collected by Zed.
3850- Setting: `telemetry`
3851- Default:
3852
3853```json [settings]
3854{
3855 "telemetry": {
3856 "diagnostics": true,
3857 "metrics": true
3858 }
3859}
3860```
3861
3862**Options**
3863
3864### Diagnostics
3865
3866- Description: Setting for sending debug-related data, such as crash reports.
3867- Setting: `diagnostics`
3868- Default: `true`
3869
3870**Options**
3871
3872`boolean` values
3873
3874### Metrics
3875
3876- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3877- Setting: `metrics`
3878- Default: `true`
3879
3880**Options**
3881
3882`boolean` values
3883
3884## Terminal
3885
3886- Description: Configuration for the terminal.
3887- Setting: `terminal`
3888- Default:
3889
3890```json [settings]
3891{
3892 "terminal": {
3893 "alternate_scroll": "off",
3894 "blinking": "terminal_controlled",
3895 "copy_on_select": false,
3896 "keep_selection_on_copy": true,
3897 "dock": "bottom",
3898 "default_width": 640,
3899 "default_height": 320,
3900 "detect_venv": {
3901 "on": {
3902 "directories": [".env", "env", ".venv", "venv"],
3903 "activate_script": "default"
3904 }
3905 },
3906 "env": {},
3907 "font_family": null,
3908 "font_features": null,
3909 "font_size": null,
3910 "line_height": "comfortable",
3911 "minimum_contrast": 45,
3912 "option_as_meta": false,
3913 "button": true,
3914 "shell": "system",
3915 "scroll_multiplier": 3.0,
3916 "toolbar": {
3917 "breadcrumbs": false
3918 },
3919 "working_directory": "current_project_directory",
3920 "scrollbar": {
3921 "show": null
3922 }
3923 }
3924}
3925```
3926
3927### Terminal: Dock
3928
3929- Description: Control the position of the dock
3930- Setting: `dock`
3931- Default: `bottom`
3932
3933**Options**
3934
3935`"bottom"`, `"left"` or `"right"`
3936
3937### Terminal: Alternate Scroll
3938
3939- 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.
3940- Setting: `alternate_scroll`
3941- Default: `off`
3942
3943**Options**
3944
39451. Default alternate scroll mode to off
3946
3947```json [settings]
3948{
3949 "terminal": {
3950 "alternate_scroll": "off"
3951 }
3952}
3953```
3954
39552. Default alternate scroll mode to on
3956
3957```json [settings]
3958{
3959 "terminal": {
3960 "alternate_scroll": "on"
3961 }
3962}
3963```
3964
3965### Terminal: Blinking
3966
3967- Description: Set the cursor blinking behavior in the terminal
3968- Setting: `blinking`
3969- Default: `terminal_controlled`
3970
3971**Options**
3972
39731. Never blink the cursor, ignore the terminal mode
3974
3975```json [settings]
3976{
3977 "terminal": {
3978 "blinking": "off"
3979 }
3980}
3981```
3982
39832. Default the cursor blink to off, but allow the terminal to turn blinking on
3984
3985```json [settings]
3986{
3987 "terminal": {
3988 "blinking": "terminal_controlled"
3989 }
3990}
3991```
3992
39933. Always blink the cursor, ignore the terminal mode
3994
3995```json [settings]
3996{
3997 "terminal": {
3998 "blinking": "on"
3999 }
4000}
4001```
4002
4003### Terminal: Copy On Select
4004
4005- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
4006- Setting: `copy_on_select`
4007- Default: `false`
4008
4009**Options**
4010
4011`boolean` values
4012
4013**Example**
4014
4015```json [settings]
4016{
4017 "terminal": {
4018 "copy_on_select": true
4019 }
4020}
4021```
4022
4023### Terminal: Cursor Shape
4024
4025- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
4026- Setting: `cursor_shape`
4027- Default: `null` (defaults to block)
4028
4029**Options**
4030
40311. A block that surrounds the following character
4032
4033```json [settings]
4034{
4035 "terminal": {
4036 "cursor_shape": "block"
4037 }
4038}
4039```
4040
40412. A vertical bar
4042
4043```json [settings]
4044{
4045 "terminal": {
4046 "cursor_shape": "bar"
4047 }
4048}
4049```
4050
40513. An underline / underscore that runs along the following character
4052
4053```json [settings]
4054{
4055 "terminal": {
4056 "cursor_shape": "underline"
4057 }
4058}
4059```
4060
40614. A box drawn around the following character
4062
4063```json [settings]
4064{
4065 "terminal": {
4066 "cursor_shape": "hollow"
4067 }
4068}
4069```
4070
4071### Terminal: Keep Selection On Copy
4072
4073- Description: Whether or not to keep the selection in the terminal after copying text.
4074- Setting: `keep_selection_on_copy`
4075- Default: `true`
4076
4077**Options**
4078
4079`boolean` values
4080
4081**Example**
4082
4083```json [settings]
4084{
4085 "terminal": {
4086 "keep_selection_on_copy": false
4087 }
4088}
4089```
4090
4091### Terminal: Env
4092
4093- 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
4094- Setting: `env`
4095- Default: `{}`
4096
4097**Example**
4098
4099```json [settings]
4100{
4101 "terminal": {
4102 "env": {
4103 "ZED": "1",
4104 "KEY": "value1:value2"
4105 }
4106 }
4107}
4108```
4109
4110### Terminal: Font Size
4111
4112- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
4113- Setting: `font_size`
4114- Default: `null`
4115
4116**Options**
4117
4118`integer` values
4119
4120```json [settings]
4121{
4122 "terminal": {
4123 "font_size": 15
4124 }
4125}
4126```
4127
4128### Terminal: Font Family
4129
4130- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
4131- Setting: `font_family`
4132- Default: `null`
4133
4134**Options**
4135
4136The name of any font family installed on the user's system
4137
4138```json [settings]
4139{
4140 "terminal": {
4141 "font_family": "Berkeley Mono"
4142 }
4143}
4144```
4145
4146### Terminal: Font Features
4147
4148- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
4149- Setting: `font_features`
4150- Default: `null`
4151- Platform: macOS and Windows.
4152
4153**Options**
4154
4155See Buffer Font Features
4156
4157```json [settings]
4158{
4159 "terminal": {
4160 "font_features": {
4161 "calt": false
4162 // See Buffer Font Features for more features
4163 }
4164 }
4165}
4166```
4167
4168### Terminal: Line Height
4169
4170- Description: Set the terminal's line height.
4171- Setting: `line_height`
4172- Default: `standard`
4173
4174**Options**
4175
41761. Use a line height that's `comfortable` for reading, 1.618.
4177
4178```json [settings]
4179{
4180 "terminal": {
4181 "line_height": "comfortable"
4182 }
4183}
4184```
4185
41862. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
4187
4188```json [settings]
4189{
4190 "terminal": {
4191 "line_height": "standard"
4192 }
4193}
4194```
4195
41963. Use a custom line height.
4197
4198```json [settings]
4199{
4200 "terminal": {
4201 "line_height": {
4202 "custom": 2
4203 }
4204 }
4205}
4206```
4207
4208### Terminal: Minimum Contrast
4209
4210- 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.
4211- Setting: `minimum_contrast`
4212- Default: `45`
4213
4214**Options**
4215
4216`integer` values from 0 to 106. Common recommended values:
4217
4218- `0`: No contrast adjustment
4219- `45`: Minimum for large fluent text (default)
4220- `60`: Minimum for other content text
4221- `75`: Minimum for body text
4222- `90`: Preferred for body text
4223
4224```json [settings]
4225{
4226 "terminal": {
4227 "minimum_contrast": 45
4228 }
4229}
4230```
4231
4232### Terminal: Option As Meta
4233
4234- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
4235- Setting: `option_as_meta`
4236- Default: `false`
4237
4238**Options**
4239
4240`boolean` values
4241
4242```json [settings]
4243{
4244 "terminal": {
4245 "option_as_meta": true
4246 }
4247}
4248```
4249
4250### Terminal: Shell
4251
4252- Description: What shell to use when launching the terminal.
4253- Setting: `shell`
4254- Default: `system`
4255
4256**Options**
4257
42581. Use the system's default terminal configuration (usually the `/etc/passwd` file).
4259
4260```json [settings]
4261{
4262 "terminal": {
4263 "shell": "system"
4264 }
4265}
4266```
4267
42682. A program to launch:
4269
4270```json [settings]
4271{
4272 "terminal": {
4273 "shell": {
4274 "program": "sh"
4275 }
4276 }
4277}
4278```
4279
42803. A program with arguments:
4281
4282```json [settings]
4283{
4284 "terminal": {
4285 "shell": {
4286 "with_arguments": {
4287 "program": "/bin/bash",
4288 "args": ["--login"]
4289 }
4290 }
4291 }
4292}
4293```
4294
4295## Terminal: Detect Virtual Environments {#terminal-detect_venv}
4296
4297- 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.
4298- Setting: `detect_venv`
4299- Default:
4300
4301```json [settings]
4302{
4303 "terminal": {
4304 "detect_venv": {
4305 "on": {
4306 // Default directories to search for virtual environments, relative
4307 // to the current working directory. We recommend overriding this
4308 // in your project's settings, rather than globally.
4309 "directories": [".env", "env", ".venv", "venv"],
4310 // Can also be `csh`, `fish`, and `nushell`
4311 "activate_script": "default"
4312 }
4313 }
4314 }
4315}
4316```
4317
4318Disable with:
4319
4320```json [settings]
4321{
4322 "terminal": {
4323 "detect_venv": "off"
4324 }
4325}
4326```
4327
4328### Terminal: Scroll Multiplier
4329
4330- Description: The multiplier for scrolling speed in the terminal when using mouse wheel or trackpad.
4331- Setting: `scroll_multiplier`
4332- Default: `1.0`
4333
4334**Options**
4335
4336Positive floating point values. Values less than or equal to 0 will be clamped to a minimum of 0.01.
4337
4338**Example**
4339
4340```json
4341{
4342 "terminal": {
4343 "scroll_multiplier": 5.0
4344 }
4345}
4346```
4347
4348## Terminal: Toolbar
4349
4350- Description: Whether or not to show various elements in the terminal toolbar.
4351- Setting: `toolbar`
4352- Default:
4353
4354```json [settings]
4355{
4356 "terminal": {
4357 "toolbar": {
4358 "breadcrumbs": false
4359 }
4360 }
4361}
4362```
4363
4364**Options**
4365
4366At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
4367
4368If the terminal title is empty, the breadcrumbs won't be shown.
4369
4370The shell running in the terminal needs to be configured to emit the title.
4371
4372Example command to set the title: `echo -e "\e]2;New Title\007";`
4373
4374### Terminal: Button
4375
4376- Description: Control to show or hide the terminal button in the status bar
4377- Setting: `button`
4378- Default: `true`
4379
4380**Options**
4381
4382`boolean` values
4383
4384```json [settings]
4385{
4386 "terminal": {
4387 "button": false
4388 }
4389}
4390```
4391
4392### Terminal: Working Directory
4393
4394- Description: What working directory to use when launching the terminal.
4395- Setting: `working_directory`
4396- Default: `"current_project_directory"`
4397
4398**Options**
4399
44001. Use the current file's directory, falling back to the project directory, then the first project in the workspace.
4401
4402```json [settings]
4403{
4404 "terminal": {
4405 "working_directory": "current_file_directory"
4406 }
4407}
4408```
4409
44102. Use the current file's project directory. Fallback to the first project directory strategy if unsuccessful.
4411
4412```json [settings]
4413{
4414 "terminal": {
4415 "working_directory": "current_project_directory"
4416 }
4417}
4418```
4419
44203. Use the first project in this workspace's directory. Fallback to using this platform's home directory.
4421
4422```json [settings]
4423{
4424 "terminal": {
4425 "working_directory": "first_project_directory"
4426 }
4427}
4428```
4429
44304. Always use this platform's home directory if it can be found.
4431
4432```json [settings]
4433{
4434 "terminal": {
4435 "working_directory": "always_home"
4436 }
4437}
4438```
4439
44405. 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.
4441
4442```json [settings]
4443{
4444 "terminal": {
4445 "working_directory": {
4446 "always": {
4447 "directory": "~/zed/projects/"
4448 }
4449 }
4450 }
4451}
4452```
4453
4454### Terminal: Path Hyperlink Regexes
4455
4456- 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).
4457- Setting: `path_hyperlink_regexes`
4458- Default:
4459
4460```json [settings]
4461{
4462 "terminal": {
4463 "path_hyperlink_regexes": [
4464 // Python-style diagnostics
4465 "File \"(?<path>[^\"]+)\", line (?<line>[0-9]+)",
4466 // Common path syntax with optional line, column, description, trailing punctuation, or
4467 // surrounding symbols or quotes
4468 [
4469 "(?x)",
4470 "# optionally starts with 0-2 opening prefix symbols",
4471 "[({\\[<]{0,2}",
4472 "# which may be followed by an opening quote",
4473 "(?<quote>[\"'`])?",
4474 "# `path` is the shortest sequence of any non-space character",
4475 "(?<link>(?<path>[^ ]+?",
4476 " # which may end with a line and optionally a column,",
4477 " (?<line_column>:+[0-9]+(:[0-9]+)?|:?\\([0-9]+([,:][0-9]+)?\\))?",
4478 "))",
4479 "# which must be followed by a matching quote",
4480 "(?(<quote>)\\k<quote>)",
4481 "# and optionally a single closing symbol",
4482 "[)}\\]>]?",
4483 "# if line/column matched, may be followed by a description",
4484 "(?(<line_column>):[^ 0-9][^ ]*)?",
4485 "# which may be followed by trailing punctuation",
4486 "[.,:)}\\]>]*",
4487 "# and always includes trailing whitespace or end of line",
4488 "([ ]+|$)"
4489 ]
4490 ]
4491 }
4492}
4493```
4494
4495### Terminal: Path Hyperlink Timeout (ms)
4496
4497- Description: Maximum time to search for a path hyperlink. When set to 0, path hyperlinks are disabled.
4498- Setting: `path_hyperlink_timeout_ms`
4499- Default: `1`
4500
4501## REPL
4502
4503- Description: Repl settings.
4504- Setting: `repl`
4505- Default:
4506
4507```json [settings]
4508{
4509 "repl": {
4510 // Maximum number of columns to keep in REPL's scrollback buffer.
4511 // Clamped with [20, 512] range.
4512 "max_columns": 128,
4513 // Maximum number of lines to keep in REPL's scrollback buffer.
4514 // Clamped with [4, 256] range.
4515 "max_lines": 32
4516 }
4517}
4518```
4519
4520## Theme
4521
4522- 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.
4523- Setting: `theme`
4524- Default: `One Dark`
4525
4526### Theme Object
4527
4528- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4529- Setting: `theme`
4530- Default:
4531
4532```json [settings]
4533{
4534 "theme": {
4535 "mode": "system",
4536 "dark": "One Dark",
4537 "light": "One Light"
4538 }
4539}
4540```
4541
4542### Mode
4543
4544- Description: Specify theme mode.
4545- Setting: `mode`
4546- Default: `system`
4547
4548**Options**
4549
45501. Set the theme to dark mode
4551
4552```json [settings]
4553{
4554 "theme": {
4555 "mode": "dark",
4556 "dark": "One Dark",
4557 "light": "One Light"
4558 }
4559}
4560```
4561
45622. Set the theme to light mode
4563
4564```json [settings]
4565{
4566 "theme": {
4567 "mode": "light",
4568 "dark": "One Dark",
4569 "light": "One Light"
4570 }
4571}
4572```
4573
45743. Set the theme to system mode
4575
4576```json [settings]
4577{
4578 "theme": {
4579 "mode": "system",
4580 "dark": "One Dark",
4581 "light": "One Light"
4582 }
4583}
4584```
4585
4586### Dark
4587
4588- Description: The name of the dark Zed theme to use for the UI.
4589- Setting: `dark`
4590- Default: `One Dark`
4591
4592**Options**
4593
4594Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4595
4596### Light
4597
4598- Description: The name of the light Zed theme to use for the UI.
4599- Setting: `light`
4600- Default: `One Light`
4601
4602**Options**
4603
4604Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4605
4606## Title Bar
4607
4608- Description: Whether or not to show various elements in the title bar
4609- Setting: `title_bar`
4610- Default:
4611
4612```json [settings]
4613{
4614 "title_bar": {
4615 "show_branch_icon": false,
4616 "show_branch_name": true,
4617 "show_project_items": true,
4618 "show_onboarding_banner": true,
4619 "show_user_picture": true,
4620 "show_user_menu": true,
4621 "show_sign_in": true,
4622 "show_menus": false
4623 }
4624}
4625```
4626
4627**Options**
4628
4629- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4630- `show_branch_name`: Whether to show the branch name button in the titlebar
4631- `show_project_items`: Whether to show the project host and name in the titlebar
4632- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4633- `show_user_picture`: Whether to show user picture in the titlebar
4634- `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.)
4635- `show_sign_in`: Whether to show the sign in button in the titlebar
4636- `show_menus`: Whether to show the menus in the titlebar
4637
4638## Vim
4639
4640- Description: Whether or not to enable vim mode.
4641- Setting: `vim_mode`
4642- Default: `false`
4643
4644## When Closing With No Tabs
4645
4646- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4647- Setting: `when_closing_with_no_tabs`
4648- Default: `"platform_default"`
4649
4650**Options**
4651
46521. Use platform default behavior:
4653
4654```json [settings]
4655{
4656 "when_closing_with_no_tabs": "platform_default"
4657}
4658```
4659
46602. Always close the window:
4661
4662```json [settings]
4663{
4664 "when_closing_with_no_tabs": "close_window"
4665}
4666```
4667
46683. Never close the window:
4669
4670```json [settings]
4671{
4672 "when_closing_with_no_tabs": "keep_window_open"
4673}
4674```
4675
4676## Project Panel
4677
4678- Description: Customize project panel
4679- Setting: `project_panel`
4680- Default:
4681
4682```json [settings]
4683{
4684 "project_panel": {
4685 "button": true,
4686 "default_width": 240,
4687 "dock": "left",
4688 "entry_spacing": "comfortable",
4689 "file_icons": true,
4690 "folder_icons": true,
4691 "git_status": true,
4692 "indent_size": 20,
4693 "auto_reveal_entries": true,
4694 "auto_fold_dirs": true,
4695 "bold_folder_labels": false,
4696 "drag_and_drop": true,
4697 "scrollbar": {
4698 "show": null
4699 },
4700 "sticky_scroll": true,
4701 "show_diagnostics": "all",
4702 "indent_guides": {
4703 "show": "always"
4704 },
4705 "sort_mode": "directories_first",
4706 "hide_root": false,
4707 "hide_hidden": false,
4708 "starts_open": true,
4709 "auto_open": {
4710 "on_create": true,
4711 "on_paste": true,
4712 "on_drop": true
4713 }
4714 }
4715}
4716```
4717
4718### Dock
4719
4720- Description: Control the position of the dock
4721- Setting: `dock`
4722- Default: `left`
4723
4724**Options**
4725
47261. Default dock position to left
4727
4728```json [settings]
4729{
4730 "project_panel": {
4731 "dock": "left"
4732 }
4733}
4734```
4735
47362. Default dock position to right
4737
4738```json [settings]
4739{
4740 "project_panel": {
4741 "dock": "right"
4742 }
4743}
4744```
4745
4746### Entry Spacing
4747
4748- Description: Spacing between worktree entries
4749- Setting: `entry_spacing`
4750- Default: `comfortable`
4751
4752**Options**
4753
47541. Comfortable entry spacing
4755
4756```json [settings]
4757{
4758 "project_panel": {
4759 "entry_spacing": "comfortable"
4760 }
4761}
4762```
4763
47642. Standard entry spacing
4765
4766```json [settings]
4767{
4768 "project_panel": {
4769 "entry_spacing": "standard"
4770 }
4771}
4772```
4773
4774### Git Status
4775
4776- Description: Indicates newly created and updated files
4777- Setting: `git_status`
4778- Default: `true`
4779
4780**Options**
4781
47821. Default enable git status
4783
4784```json [settings]
4785{
4786 "project_panel": {
4787 "git_status": true
4788 }
4789}
4790```
4791
47922. Default disable git status
4793
4794```json [settings]
4795{
4796 "project_panel": {
4797 "git_status": false
4798 }
4799}
4800```
4801
4802### Default Width
4803
4804- Description: Customize default width taken by project panel
4805- Setting: `default_width`
4806- Default: `240`
4807
4808**Options**
4809
4810`float` values
4811
4812### Auto Reveal Entries
4813
4814- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4815- Setting: `auto_reveal_entries`
4816- Default: `true`
4817
4818**Options**
4819
48201. Enable auto reveal entries
4821
4822```json [settings]
4823{
4824 "project_panel": {
4825 "auto_reveal_entries": true
4826 }
4827}
4828```
4829
48302. Disable auto reveal entries
4831
4832```json [settings]
4833{
4834 "project_panel": {
4835 "auto_reveal_entries": false
4836 }
4837}
4838```
4839
4840### Auto Fold Dirs
4841
4842- Description: Whether to fold directories automatically when directory has only one directory inside.
4843- Setting: `auto_fold_dirs`
4844- Default: `true`
4845
4846**Options**
4847
48481. Enable auto fold dirs
4849
4850```json [settings]
4851{
4852 "project_panel": {
4853 "auto_fold_dirs": true
4854 }
4855}
4856```
4857
48582. Disable auto fold dirs
4859
4860```json [settings]
4861{
4862 "project_panel": {
4863 "auto_fold_dirs": false
4864 }
4865}
4866```
4867
4868### Bold Folder Labels
4869
4870- Description: Whether to show folder names with bold text in the project panel.
4871- Setting: `bold_folder_labels`
4872- Default: `false`
4873
4874**Options**
4875
48761. Enable bold folder labels
4877
4878```json [settings]
4879{
4880 "project_panel": {
4881 "bold_folder_labels": true
4882 }
4883}
4884```
4885
48862. Disable bold folder labels
4887
4888```json [settings]
4889{
4890 "project_panel": {
4891 "bold_folder_labels": false
4892 }
4893}
4894```
4895
4896### Indent Size
4897
4898- Description: Amount of indentation (in pixels) for nested items.
4899- Setting: `indent_size`
4900- Default: `20`
4901
4902### Indent Guides: Show
4903
4904- Description: Whether to show indent guides in the project panel.
4905- Setting: `indent_guides`
4906- Default:
4907
4908```json [settings]
4909{
4910 "project_panel": {
4911 "indent_guides": {
4912 "show": "always"
4913 }
4914 }
4915}
4916```
4917
4918**Options**
4919
49201. Show indent guides in the project panel
4921
4922```json [settings]
4923{
4924 "project_panel": {
4925 "indent_guides": {
4926 "show": "always"
4927 }
4928 }
4929}
4930```
4931
49322. Hide indent guides in the project panel
4933
4934```json [settings]
4935{
4936 "project_panel": {
4937 "indent_guides": {
4938 "show": "never"
4939 }
4940 }
4941}
4942```
4943
4944### Scrollbar: Show
4945
4946- Description: Whether to show a scrollbar in the project panel. Possible values: null, "auto", "system", "always", "never". Inherits editor settings when absent, see its description for more details.
4947- Setting: `scrollbar`
4948- Default:
4949
4950```json [settings]
4951{
4952 "project_panel": {
4953 "scrollbar": {
4954 "show": null
4955 }
4956 }
4957}
4958```
4959
4960**Options**
4961
49621. Show scrollbar in the project panel
4963
4964```json [settings]
4965{
4966 "project_panel": {
4967 "scrollbar": {
4968 "show": "always"
4969 }
4970 }
4971}
4972```
4973
49742. Hide scrollbar in the project panel
4975
4976```json [settings]
4977{
4978 "project_panel": {
4979 "scrollbar": {
4980 "show": "never"
4981 }
4982 }
4983}
4984```
4985
4986### Sort Mode
4987
4988- Description: Sort order for entries in the project panel
4989- Setting: `sort_mode`
4990- Default: `directories_first`
4991
4992**Options**
4993
49941. Show directories first, then files
4995
4996```json [settings]
4997{
4998 "project_panel": {
4999 "sort_mode": "directories_first"
5000 }
5001}
5002```
5003
50042. Mix directories and files together
5005
5006```json [settings]
5007{
5008 "project_panel": {
5009 "sort_mode": "mixed"
5010 }
5011}
5012```
5013
50143. Show files first, then directories
5015
5016```json [settings]
5017{
5018 "project_panel": {
5019 "sort_mode": "files_first"
5020 }
5021}
5022```
5023
5024### Auto Open
5025
5026- Description: Control whether files are opened automatically after different creation flows in the project panel.
5027- Setting: `auto_open`
5028- Default:
5029
5030```json [settings]
5031{
5032 "project_panel": {
5033 "auto_open": {
5034 "on_create": true,
5035 "on_paste": true,
5036 "on_drop": true
5037 }
5038 }
5039}
5040```
5041
5042**Options**
5043
5044- `on_create`: Whether to automatically open newly created files in the editor.
5045- `on_paste`: Whether to automatically open files after pasting or duplicating them.
5046- `on_drop`: Whether to automatically open files dropped from external sources.
5047
5048## Agent
5049
5050Visit [the Configuration page](../ai/configuration.md) under the AI section to learn more about all the agent-related settings.
5051
5052## Collaboration Panel
5053
5054- Description: Customizations for the collaboration panel.
5055- Setting: `collaboration_panel`
5056- Default:
5057
5058```json [settings]
5059{
5060 "collaboration_panel": {
5061 "button": true,
5062 "dock": "left",
5063 "default_width": 240
5064 }
5065}
5066```
5067
5068**Options**
5069
5070- `button`: Whether to show the collaboration panel button in the status bar
5071- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
5072- `default_width`: Default width of the collaboration panel
5073
5074## Debugger
5075
5076- Description: Configuration for debugger panel and settings
5077- Setting: `debugger`
5078- Default:
5079
5080```json [settings]
5081{
5082 "debugger": {
5083 "stepping_granularity": "line",
5084 "save_breakpoints": true,
5085 "dock": "bottom",
5086 "button": true
5087 }
5088}
5089```
5090
5091See the [debugger page](../debugger.md) for more information about debugging support within Zed.
5092
5093## Git Panel
5094
5095- Description: Setting to customize the behavior of the git panel.
5096- Setting: `git_panel`
5097- Default:
5098
5099```json [settings]
5100{
5101 "git_panel": {
5102 "button": true,
5103 "dock": "left",
5104 "default_width": 360,
5105 "status_style": "icon",
5106 "fallback_branch_name": "main",
5107 "sort_by_path": false,
5108 "collapse_untracked_diff": false,
5109 "scrollbar": {
5110 "show": null
5111 }
5112 }
5113}
5114```
5115
5116**Options**
5117
5118- `button`: Whether to show the git panel button in the status bar
5119- `dock`: Where to dock the git panel. Can be `left` or `right`
5120- `default_width`: Default width of the git panel
5121- `status_style`: How to display git status. Can be `label_color` or `icon`
5122- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
5123- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
5124- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
5125- `scrollbar`: When to show the scrollbar in the git panel
5126
5127## Git Worktree Directory
5128
5129- Description: Directory where git worktrees are created, relative to the repository working directory.
5130- Setting: `git.worktree_directory`
5131- Default: `"../worktrees"`
5132
5133When 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/`.
5134
5135When the resolved directory is inside the project root, no extra component is added (it's already project-scoped).
5136
5137**Examples**:
5138
5139- `"../worktrees"` — `~/code/worktrees/<project>/` (default)
5140- `".git/zed-worktrees"` — `<project>/.git/zed-worktrees/`
5141- `"my-worktrees"` — `<project>/my-worktrees/`
5142
5143Trailing slashes are ignored.
5144
5145```json [settings]
5146{
5147 "git": {
5148 "worktree_directory": "../worktrees"
5149 }
5150}
5151```
5152
5153## Git Hosting Providers
5154
5155- Description: Register self-hosted GitHub, GitLab, or Bitbucket instances so commit hashes, issue references, and permalinks resolve to the right host.
5156- Setting: `git_hosting_providers`
5157- Default: `[]`
5158
5159**Options**
5160
5161Each entry accepts:
5162
5163- `provider`: One of `github`, `gitlab`, or `bitbucket`
5164- `name`: Display name for the instance
5165- `base_url`: Base URL, e.g. `https://git.example.corp`
5166
5167You can define these in user or project settings; project settings are merged on top of user settings.
5168
5169```json [settings]
5170{
5171 "git_hosting_providers": [
5172 {
5173 "provider": "github",
5174 "name": "BigCorp GitHub",
5175 "base_url": "https://git.example.corp"
5176 }
5177 ]
5178}
5179```
5180
5181## Outline Panel
5182
5183- Description: Customize outline Panel
5184- Setting: `outline_panel`
5185- Default:
5186
5187```json [settings]
5188{
5189 "outline_panel": {
5190 "button": true,
5191 "default_width": 300,
5192 "dock": "left",
5193 "file_icons": true,
5194 "folder_icons": true,
5195 "git_status": true,
5196 "indent_size": 20,
5197 "auto_reveal_entries": true,
5198 "auto_fold_dirs": true,
5199 "indent_guides": {
5200 "show": "always"
5201 },
5202 "scrollbar": {
5203 "show": null
5204 }
5205 }
5206}
5207```
5208
5209## Calls
5210
5211- Description: Customize behavior when participating in a call
5212- Setting: `calls`
5213- Default:
5214
5215```json [settings]
5216{
5217 "calls": {
5218 // Join calls with the microphone live by default
5219 "mute_on_join": false,
5220 // Share your project when you are the first to join a channel
5221 "share_on_join": false
5222 }
5223}
5224```
5225
5226## Colorize Brackets
5227
5228- Description: Whether to use tree-sitter bracket queries to detect and colorize the brackets in the editor (also known as "rainbow brackets").
5229- Setting: `colorize_brackets`
5230- Default: `false`
5231
5232**Options**
5233
5234`boolean` values
5235
5236The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
5237
5238## Unnecessary Code Fade
5239
5240- Description: How much to fade out unused code.
5241- Setting: `unnecessary_code_fade`
5242- Default: `0.3`
5243
5244**Options**
5245
5246Float values between `0.0` and `0.9`, where:
5247
5248- `0.0` means no fading (unused code looks the same as used code)
5249- `0.9` means maximum fading (unused code is very faint but still visible)
5250
5251**Example**
5252
5253```json [settings]
5254{
5255 "unnecessary_code_fade": 0.5
5256}
5257```
5258
5259## UI Font Family
5260
5261- Description: The name of the font to use for text in the UI.
5262- Setting: `ui_font_family`
5263- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
5264
5265**Options**
5266
5267The 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).
5268
5269## UI Font Features
5270
5271- Description: The OpenType features to enable for text in the UI.
5272- Setting: `ui_font_features`
5273- Default:
5274
5275```json [settings]
5276{
5277 "ui_font_features": {
5278 "calt": false
5279 }
5280}
5281```
5282
5283- Platform: macOS and Windows.
5284
5285**Options**
5286
5287Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
5288
5289For example, to disable font ligatures, add the following to your settings:
5290
5291```json [settings]
5292{
5293 "ui_font_features": {
5294 "calt": false
5295 }
5296}
5297```
5298
5299You can also set other OpenType features, like setting `cv01` to `7`:
5300
5301```json [settings]
5302{
5303 "ui_font_features": {
5304 "cv01": 7
5305 }
5306}
5307```
5308
5309## UI Font Fallbacks
5310
5311- Description: The font fallbacks to use for text in the UI.
5312- Setting: `ui_font_fallbacks`
5313- Default: `null`
5314- Platform: macOS and Windows.
5315
5316**Options**
5317
5318For example, to use `Nerd Font` as a fallback, add the following to your settings:
5319
5320```json [settings]
5321{
5322 "ui_font_fallbacks": ["Nerd Font"]
5323}
5324```
5325
5326## UI Font Size
5327
5328- Description: The default font size for text in the UI.
5329- Setting: `ui_font_size`
5330- Default: `16`
5331
5332**Options**
5333
5334`integer` values from `6` to `100` pixels (inclusive)
5335
5336## UI Font Weight
5337
5338- Description: The default font weight for text in the UI.
5339- Setting: `ui_font_weight`
5340- Default: `400`
5341
5342**Options**
5343
5344`integer` values between `100` and `900`
5345
5346## Settings Profiles
5347
5348- Description: Configure any number of settings profiles that are temporarily applied on top of your existing user settings when selected from `settings profile selector: toggle`.
5349- Setting: `profiles`
5350- Default: `{}`
5351
5352In your `settings.json` file, add the `profiles` object.
5353Each key within this object is the name of a settings profile, and each value is an object that can include any of Zed's settings.
5354
5355Example:
5356
5357```json [settings]
5358{
5359 "profiles": {
5360 "Presenting (Dark)": {
5361 "agent_buffer_font_size": 18.0,
5362 "buffer_font_size": 18.0,
5363 "theme": "One Dark",
5364 "ui_font_size": 18.0
5365 },
5366 "Presenting (Light)": {
5367 "agent_buffer_font_size": 18.0,
5368 "buffer_font_size": 18.0,
5369 "theme": "One Light",
5370 "ui_font_size": 18.0
5371 },
5372 "Writing": {
5373 "agent_buffer_font_size": 15.0,
5374 "buffer_font_size": 15.0,
5375 "theme": "Catppuccin Frappé - No Italics",
5376 "ui_font_size": 15.0,
5377 "tab_bar": { "show": false },
5378 "toolbar": { "breadcrumbs": false }
5379 }
5380 }
5381}
5382```
5383
5384To preview and enable a settings profile, open the command palette via {#kb command_palette::Toggle} and search for `settings profile selector: toggle`.
5385
5386## An example configuration:
5387
5388```json [settings]
5389// ~/.config/zed/settings.json
5390{
5391 "theme": "cave-light",
5392 "tab_size": 2,
5393 "preferred_line_length": 80,
5394 "soft_wrap": "none",
5395
5396 "buffer_font_size": 18,
5397 "buffer_font_family": ".ZedMono",
5398
5399 "autosave": "on_focus_change",
5400 "format_on_save": "off",
5401 "vim_mode": false,
5402 "terminal": {
5403 "font_family": "FiraCode Nerd Font Mono",
5404 "blinking": "off"
5405 },
5406 "languages": {
5407 "C": {
5408 "format_on_save": "on",
5409 "formatter": "language_server",
5410 "preferred_line_length": 64,
5411 "soft_wrap": "preferred_line_length"
5412 }
5413 }
5414}
5415```