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