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