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