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