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## Features
1583
1584- Description: Features that can be globally enabled or disabled
1585- Setting: `features`
1586- Default:
1587
1588```json
1589{
1590 "features": {
1591 "edit_prediction_provider": "zed"
1592 }
1593}
1594```
1595
1596### Edit Prediction Provider
1597
1598- Description: Which edit prediction provider to use
1599- Setting: `edit_prediction_provider`
1600- Default: `"zed"`
1601
1602**Options**
1603
16041. Use Zeta as the edit prediction provider:
1605
1606```json
1607{
1608 "features": {
1609 "edit_prediction_provider": "zed"
1610 }
1611}
1612```
1613
16142. Use Copilot as the edit prediction provider:
1615
1616```json
1617{
1618 "features": {
1619 "edit_prediction_provider": "copilot"
1620 }
1621}
1622```
1623
16243. Use Supermaven as the edit prediction provider:
1625
1626```json
1627{
1628 "features": {
1629 "edit_prediction_provider": "supermaven"
1630 }
1631}
1632```
1633
16344. Turn off edit predictions across all providers
1635
1636```json
1637{
1638 "features": {
1639 "edit_prediction_provider": "none"
1640 }
1641}
1642```
1643
1644## Format On Save
1645
1646- Description: Whether or not to perform a buffer format before saving.
1647- Setting: `format_on_save`
1648- Default: `on`
1649
1650**Options**
1651
16521. `on`, enables format on save obeying `formatter` setting:
1653
1654```json
1655{
1656 "format_on_save": "on"
1657}
1658```
1659
16602. `off`, disables format on save:
1661
1662```json
1663{
1664 "format_on_save": "off"
1665}
1666```
1667
1668## Formatter
1669
1670- Description: How to perform a buffer format.
1671- Setting: `formatter`
1672- Default: `auto`
1673
1674**Options**
1675
16761. To use the current language server, use `"language_server"`:
1677
1678```json
1679{
1680 "formatter": "language_server"
1681}
1682```
1683
16842. 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):
1685
1686```json
1687{
1688 "formatter": {
1689 "external": {
1690 "command": "sed",
1691 "arguments": ["-e", "s/ *$//"]
1692 }
1693 }
1694}
1695```
1696
16973. 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.
1698
1699WARNING: `{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.
1700
1701```json
1702 "formatter": {
1703 "external": {
1704 "command": "prettier",
1705 "arguments": ["--stdin-filepath", "{buffer_path}"]
1706 }
1707 }
1708```
1709
17104. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1711
1712```json
1713{
1714 "formatter": {
1715 "code_actions": {
1716 // Use ESLint's --fix:
1717 "source.fixAll.eslint": true,
1718 // Organize imports on save:
1719 "source.organizeImports": true
1720 }
1721 }
1722}
1723```
1724
17255. Or to use multiple formatters consecutively, use an array of formatters:
1726
1727```json
1728{
1729 "formatter": [
1730 { "language_server": { "name": "rust-analyzer" } },
1731 {
1732 "external": {
1733 "command": "sed",
1734 "arguments": ["-e", "s/ *$//"]
1735 }
1736 }
1737 ]
1738}
1739```
1740
1741Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1742If any of the formatters fails, the subsequent ones will still be executed.
1743
1744## Code Actions On Format
1745
1746- Description: The code actions to perform with the primary language server when formatting the buffer.
1747- Setting: `code_actions_on_format`
1748- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
1749
1750**Examples**
1751
1752<!--
1753TBD: Add Python Ruff source.organizeImports example
1754-->
1755
17561. Organize imports on format in TypeScript and TSX buffers:
1757
1758```json
1759{
1760 "languages": {
1761 "TypeScript": {
1762 "code_actions_on_format": {
1763 "source.organizeImports": true
1764 }
1765 },
1766 "TSX": {
1767 "code_actions_on_format": {
1768 "source.organizeImports": true
1769 }
1770 }
1771 }
1772}
1773```
1774
17752. Run ESLint `fixAll` code action when formatting:
1776
1777```json
1778{
1779 "languages": {
1780 "JavaScript": {
1781 "code_actions_on_format": {
1782 "source.fixAll.eslint": true
1783 }
1784 }
1785 }
1786}
1787```
1788
17893. Run only a single ESLint rule when using `fixAll`:
1790
1791```json
1792{
1793 "languages": {
1794 "JavaScript": {
1795 "code_actions_on_format": {
1796 "source.fixAll.eslint": true
1797 }
1798 }
1799 },
1800 "lsp": {
1801 "eslint": {
1802 "settings": {
1803 "codeActionOnSave": {
1804 "rules": ["import/order"]
1805 }
1806 }
1807 }
1808 }
1809}
1810```
1811
1812## Auto close
1813
1814- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1815- Setting: `use_autoclose`
1816- Default: `true`
1817
1818**Options**
1819
1820`boolean` values
1821
1822## Always Treat Brackets As Autoclosed
1823
1824- Description: Controls how the editor handles the autoclosed characters.
1825- Setting: `always_treat_brackets_as_autoclosed`
1826- Default: `false`
1827
1828**Options**
1829
1830`boolean` values
1831
1832**Example**
1833
1834If the setting is set to `true`:
1835
18361. Enter in the editor: `)))`
18372. Move the cursor to the start: `^)))`
18383. Enter again: `)))`
1839
1840The result is still `)))` and not `))))))`, which is what it would be by default.
1841
1842## File Scan Exclusions
1843
1844- Setting: `file_scan_exclusions`
1845- 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`.
1846- Default:
1847
1848```json
1849"file_scan_exclusions": [
1850 "**/.git",
1851 "**/.svn",
1852 "**/.hg",
1853 "**/.jj",
1854 "**/CVS",
1855 "**/.DS_Store",
1856 "**/Thumbs.db",
1857 "**/.classpath",
1858 "**/.settings"
1859],
1860```
1861
1862Note, 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.
1863
1864## File Scan Inclusions
1865
1866- Setting: `file_scan_inclusions`
1867- 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.
1868- Default:
1869
1870```json
1871"file_scan_inclusions": [".env*"],
1872```
1873
1874## File Types
1875
1876- Setting: `file_types`
1877- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1878- Default:
1879
1880```json
1881"file_types": {
1882 "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1883 "Shell Script": [".env.*"]
1884}
1885```
1886
1887**Examples**
1888
1889To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1890
1891```json
1892{
1893 "file_types": {
1894 "C++": ["c"],
1895 "TOML": ["MyLockFile"],
1896 "Dockerfile": ["Dockerfile*"]
1897 }
1898}
1899```
1900
1901## Diagnostics
1902
1903- Description: Configuration for diagnostics-related features.
1904- Setting: `diagnostics`
1905- Default:
1906
1907```json
1908{
1909 "diagnostics": {
1910 "include_warnings": true,
1911 "inline": {
1912 "enabled": false
1913 },
1914 "update_with_cursor": false,
1915 "primary_only": false,
1916 "use_rendered": false
1917 }
1918}
1919```
1920
1921### Inline Diagnostics
1922
1923- Description: Whether or not to show diagnostics information inline.
1924- Setting: `inline`
1925- Default:
1926
1927```json
1928{
1929 "diagnostics": {
1930 "inline": {
1931 "enabled": false,
1932 "update_debounce_ms": 150,
1933 "padding": 4,
1934 "min_column": 0,
1935 "max_severity": null
1936 }
1937 }
1938}
1939```
1940
1941**Options**
1942
19431. Enable inline diagnostics.
1944
1945```json
1946{
1947 "diagnostics": {
1948 "inline": {
1949 "enabled": true
1950 }
1951 }
1952}
1953```
1954
19552. Delay diagnostic updates until some time after the last diagnostic update.
1956
1957```json
1958{
1959 "diagnostics": {
1960 "inline": {
1961 "enabled": true,
1962 "update_debounce_ms": 150
1963 }
1964 }
1965}
1966```
1967
19683. Set padding between the end of the source line and the start of the diagnostic.
1969
1970```json
1971{
1972 "diagnostics": {
1973 "inline": {
1974 "enabled": true,
1975 "padding": 4
1976 }
1977 }
1978}
1979```
1980
19814. Horizontally align inline diagnostics at the given column.
1982
1983```json
1984{
1985 "diagnostics": {
1986 "inline": {
1987 "enabled": true,
1988 "min_column": 80
1989 }
1990 }
1991}
1992```
1993
19945. Show only warning and error diagnostics.
1995
1996```json
1997{
1998 "diagnostics": {
1999 "inline": {
2000 "enabled": true,
2001 "max_severity": "warning"
2002 }
2003 }
2004}
2005```
2006
2007## Git
2008
2009- Description: Configuration for git-related features.
2010- Setting: `git`
2011- Default:
2012
2013```json
2014{
2015 "git": {
2016 "git_gutter": "tracked_files",
2017 "inline_blame": {
2018 "enabled": true
2019 },
2020 "branch_picker": {
2021 "show_author_name": true
2022 },
2023 "hunk_style": "staged_hollow"
2024 }
2025}
2026```
2027
2028### Git Gutter
2029
2030- Description: Whether or not to show the git gutter.
2031- Setting: `git_gutter`
2032- Default: `tracked_files`
2033
2034**Options**
2035
20361. Show git gutter in tracked files
2037
2038```json
2039{
2040 "git": {
2041 "git_gutter": "tracked_files"
2042 }
2043}
2044```
2045
20462. Hide git gutter
2047
2048```json
2049{
2050 "git": {
2051 "git_gutter": "hide"
2052 }
2053}
2054```
2055
2056### Gutter Debounce
2057
2058- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2059- Setting: `gutter_debounce`
2060- Default: `null`
2061
2062**Options**
2063
2064`integer` values representing milliseconds
2065
2066Example:
2067
2068```json
2069{
2070 "git": {
2071 "gutter_debounce": 100
2072 }
2073}
2074```
2075
2076### Inline Git Blame
2077
2078- Description: Whether or not to show git blame information inline, on the currently focused line.
2079- Setting: `inline_blame`
2080- Default:
2081
2082```json
2083{
2084 "git": {
2085 "inline_blame": {
2086 "enabled": true
2087 }
2088 }
2089}
2090```
2091
2092**Options**
2093
20941. Disable inline git blame:
2095
2096```json
2097{
2098 "git": {
2099 "inline_blame": {
2100 "enabled": false
2101 }
2102 }
2103}
2104```
2105
21062. Only show inline git blame after a delay (that starts after cursor stops moving):
2107
2108```json
2109{
2110 "git": {
2111 "inline_blame": {
2112 "delay_ms": 500
2113 }
2114 }
2115}
2116```
2117
21183. Show a commit summary next to the commit date and author:
2119
2120```json
2121{
2122 "git": {
2123 "inline_blame": {
2124 "show_commit_summary": true
2125 }
2126 }
2127}
2128```
2129
21304. Use this as the minimum column at which to display inline blame information:
2131
2132```json
2133{
2134 "git": {
2135 "inline_blame": {
2136 "min_column": 80
2137 }
2138 }
2139}
2140```
2141
21425. Set the padding between the end of the line and the inline blame hint, in ems:
2143
2144```json
2145{
2146 "git": {
2147 "inline_blame": {
2148 "padding": 10
2149 }
2150 }
2151}
2152```
2153
2154### Branch Picker
2155
2156- Description: Configuration related to the branch picker.
2157- Setting: `branch_picker`
2158- Default:
2159
2160```json
2161{
2162 "git": {
2163 "branch_picker": {
2164 "show_author_name": false
2165 }
2166 }
2167}
2168```
2169
2170**Options**
2171
21721. Show the author name in the branch picker:
2173
2174```json
2175{
2176 "git": {
2177 "branch_picker": {
2178 "show_author_name": true
2179 }
2180 }
2181}
2182```
2183
2184### Hunk Style
2185
2186- Description: What styling we should use for the diff hunks.
2187- Setting: `hunk_style`
2188- Default:
2189
2190```json
2191{
2192 "git": {
2193 "hunk_style": "staged_hollow"
2194 }
2195}
2196```
2197
2198**Options**
2199
22001. Show the staged hunks faded out and with a border:
2201
2202```json
2203{
2204 "git": {
2205 "hunk_style": "staged_hollow"
2206 }
2207}
2208```
2209
22102. Show unstaged hunks faded out and with a border:
2211
2212```json
2213{
2214 "git": {
2215 "hunk_style": "unstaged_hollow"
2216 }
2217}
2218```
2219
2220## Go to Definition Fallback
2221
2222- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2223- Setting: `go_to_definition_fallback`
2224- Default: `"find_all_references"`
2225
2226**Options**
2227
22281. Do nothing:
2229
2230```json
2231{
2232 "go_to_definition_fallback": "none"
2233}
2234```
2235
22362. Find references for the same symbol (default):
2237
2238```json
2239{
2240 "go_to_definition_fallback": "find_all_references"
2241}
2242```
2243
2244## Hard Tabs
2245
2246- Description: Whether to indent lines using tab characters or multiple spaces.
2247- Setting: `hard_tabs`
2248- Default: `false`
2249
2250**Options**
2251
2252`boolean` values
2253
2254## Helix Mode
2255
2256- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2257- Setting: `helix_mode`
2258- Default: `false`
2259
2260**Options**
2261
2262`boolean` values
2263
2264## Indent Guides
2265
2266- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2267- Setting: `indent_guides`
2268- Default:
2269
2270```json
2271{
2272 "indent_guides": {
2273 "enabled": true,
2274 "line_width": 1,
2275 "active_line_width": 1,
2276 "coloring": "fixed",
2277 "background_coloring": "disabled"
2278 }
2279}
2280```
2281
2282**Options**
2283
22841. Disable indent guides
2285
2286```json
2287{
2288 "indent_guides": {
2289 "enabled": false
2290 }
2291}
2292```
2293
22942. Enable indent guides for a specific language.
2295
2296```json
2297{
2298 "languages": {
2299 "Python": {
2300 "indent_guides": {
2301 "enabled": true
2302 }
2303 }
2304 }
2305}
2306```
2307
23083. Enable indent aware coloring ("rainbow indentation").
2309 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.
2310
2311```json
2312{
2313 "indent_guides": {
2314 "enabled": true,
2315 "coloring": "indent_aware"
2316 }
2317}
2318```
2319
23204. Enable indent aware background coloring ("rainbow indentation").
2321 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.
2322
2323```json
2324{
2325 "indent_guides": {
2326 "enabled": true,
2327 "coloring": "indent_aware",
2328 "background_coloring": "indent_aware"
2329 }
2330}
2331```
2332
2333## Hover Popover Enabled
2334
2335- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2336- Setting: `hover_popover_enabled`
2337- Default: `true`
2338
2339**Options**
2340
2341`boolean` values
2342
2343## Hover Popover Delay
2344
2345- Description: Time to wait in milliseconds before showing the informational hover box.
2346- Setting: `hover_popover_delay`
2347- Default: `300`
2348
2349**Options**
2350
2351`integer` values representing milliseconds
2352
2353## Icon Theme
2354
2355- 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.
2356- Setting: `icon_theme`
2357- Default: `Zed (Default)`
2358
2359### Icon Theme Object
2360
2361- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2362- Setting: `icon_theme`
2363- Default:
2364
2365```json
2366"icon_theme": {
2367 "mode": "system",
2368 "dark": "Zed (Default)",
2369 "light": "Zed (Default)"
2370},
2371```
2372
2373### Mode
2374
2375- Description: Specify the icon theme mode.
2376- Setting: `mode`
2377- Default: `system`
2378
2379**Options**
2380
23811. Set the icon theme to dark mode
2382
2383```json
2384{
2385 "mode": "dark"
2386}
2387```
2388
23892. Set the icon theme to light mode
2390
2391```json
2392{
2393 "mode": "light"
2394}
2395```
2396
23973. Set the icon theme to system mode
2398
2399```json
2400{
2401 "mode": "system"
2402}
2403```
2404
2405### Dark
2406
2407- Description: The name of the dark icon theme.
2408- Setting: `dark`
2409- Default: `Zed (Default)`
2410
2411**Options**
2412
2413Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2414
2415### Light
2416
2417- Description: The name of the light icon theme.
2418- Setting: `light`
2419- Default: `Zed (Default)`
2420
2421**Options**
2422
2423Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2424
2425## Image Viewer
2426
2427- Description: Settings for image viewer functionality
2428- Setting: `image_viewer`
2429- Default:
2430
2431```json
2432{
2433 "image_viewer": {
2434 "unit": "binary"
2435 }
2436}
2437```
2438
2439**Options**
2440
2441### Unit
2442
2443- Description: The unit for image file sizes
2444- Setting: `unit`
2445- Default: `"binary"`
2446
2447**Options**
2448
24491. Use binary units (KiB, MiB):
2450
2451```json
2452{
2453 "image_viewer": {
2454 "unit": "binary"
2455 }
2456}
2457```
2458
24592. Use decimal units (KB, MB):
2460
2461```json
2462{
2463 "image_viewer": {
2464 "unit": "decimal"
2465 }
2466}
2467```
2468
2469## Inlay hints
2470
2471- Description: Configuration for displaying extra text with hints in the editor.
2472- Setting: `inlay_hints`
2473- Default:
2474
2475```json
2476"inlay_hints": {
2477 "enabled": false,
2478 "show_type_hints": true,
2479 "show_parameter_hints": true,
2480 "show_other_hints": true,
2481 "show_background": false,
2482 "edit_debounce_ms": 700,
2483 "scroll_debounce_ms": 50,
2484 "toggle_on_modifiers_press": null
2485}
2486```
2487
2488**Options**
2489
2490Inlay hints querying consists of two parts: editor (client) and LSP server.
2491With 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.
2492At 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.
2493
2494The following languages have inlay hints preconfigured by Zed:
2495
2496- [Go](https://docs.zed.dev/languages/go)
2497- [Rust](https://docs.zed.dev/languages/rust)
2498- [Svelte](https://docs.zed.dev/languages/svelte)
2499- [TypeScript](https://docs.zed.dev/languages/typescript)
2500
2501Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2502
2503Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2504Settings-related hint updates are not debounced.
2505
2506All possible config values for `toggle_on_modifiers_press` are:
2507
2508```json
2509"inlay_hints": {
2510 "toggle_on_modifiers_press": {
2511 "control": true,
2512 "shift": true,
2513 "alt": true,
2514 "platform": true,
2515 "function": true
2516 }
2517}
2518```
2519
2520Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2521
2522## Journal
2523
2524- Description: Configuration for the journal.
2525- Setting: `journal`
2526- Default:
2527
2528```json
2529"journal": {
2530 "path": "~",
2531 "hour_format": "hour12"
2532}
2533```
2534
2535### Path
2536
2537- Description: The path of the directory where journal entries are stored.
2538- Setting: `path`
2539- Default: `~`
2540
2541**Options**
2542
2543`string` values
2544
2545### Hour Format
2546
2547- Description: The format to use for displaying hours in the journal.
2548- Setting: `hour_format`
2549- Default: `hour12`
2550
2551**Options**
2552
25531. 12-hour format:
2554
2555```json
2556{
2557 "hour_format": "hour12"
2558}
2559```
2560
25612. 24-hour format:
2562
2563```json
2564{
2565 "hour_format": "hour24"
2566}
2567```
2568
2569## JSX Tag Auto Close
2570
2571- Description: Whether to automatically close JSX tags
2572- Setting: `jsx_tag_auto_close`
2573- Default:
2574
2575```json
2576{
2577 "jsx_tag_auto_close": {
2578 "enabled": true
2579 }
2580}
2581```
2582
2583**Options**
2584
2585- `enabled`: Whether to enable automatic JSX tag closing
2586
2587## Languages
2588
2589- Description: Configuration for specific languages.
2590- Setting: `languages`
2591- Default: `null`
2592
2593**Options**
2594
2595To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2596
2597```json
2598"languages": {
2599 "C": {
2600 "format_on_save": "off",
2601 "preferred_line_length": 64,
2602 "soft_wrap": "preferred_line_length"
2603 },
2604 "JSON": {
2605 "tab_size": 4
2606 }
2607}
2608```
2609
2610The following settings can be overridden for each specific language:
2611
2612- [`enable_language_server`](#enable-language-server)
2613- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2614- [`format_on_save`](#format-on-save)
2615- [`formatter`](#formatter)
2616- [`hard_tabs`](#hard-tabs)
2617- [`preferred_line_length`](#preferred-line-length)
2618- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2619- [`show_edit_predictions`](#show-edit-predictions)
2620- [`show_whitespaces`](#show-whitespaces)
2621- [`whitespace_map`](#whitespace-map)
2622- [`soft_wrap`](#soft-wrap)
2623- [`tab_size`](#tab-size)
2624- [`use_autoclose`](#use-autoclose)
2625- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2626
2627These values take in the same options as the root-level settings with the same name.
2628
2629## Language Models
2630
2631- Description: Configuration for language model providers
2632- Setting: `language_models`
2633- Default:
2634
2635```json
2636{
2637 "language_models": {
2638 "anthropic": {
2639 "api_url": "https://api.anthropic.com"
2640 },
2641 "google": {
2642 "api_url": "https://generativelanguage.googleapis.com"
2643 },
2644 "ollama": {
2645 "api_url": "http://localhost:11434"
2646 },
2647 "openai": {
2648 "api_url": "https://api.openai.com/v1"
2649 }
2650 }
2651}
2652```
2653
2654**Options**
2655
2656Configuration for various AI model providers including API URLs and authentication settings.
2657
2658## Line Indicator Format
2659
2660- Description: Format for line indicator in the status bar
2661- Setting: `line_indicator_format`
2662- Default: `"short"`
2663
2664**Options**
2665
26661. Short format:
2667
2668```json
2669{
2670 "line_indicator_format": "short"
2671}
2672```
2673
26742. Long format:
2675
2676```json
2677{
2678 "line_indicator_format": "long"
2679}
2680```
2681
2682## Linked Edits
2683
2684- 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.
2685- Setting: `linked_edits`
2686- Default: `true`
2687
2688**Options**
2689
2690`boolean` values
2691
2692## LSP Document Colors
2693
2694- Description: Whether to show document color information from the language server
2695- Setting: `lsp_document_colors`
2696- Default: `true`
2697
2698**Options**
2699
2700`boolean` values
2701
2702## Max Tabs
2703
2704- Description: Maximum number of tabs to show in the tab bar
2705- Setting: `max_tabs`
2706- Default: `null`
2707
2708**Options**
2709
2710Positive `integer` values or `null` for unlimited tabs
2711
2712## Middle Click Paste (Linux only)
2713
2714- Description: Enable middle-click paste on Linux
2715- Setting: `middle_click_paste`
2716- Default: `true`
2717
2718**Options**
2719
2720`boolean` values
2721
2722## Multi Cursor Modifier
2723
2724- 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.
2725- Setting: `multi_cursor_modifier`
2726- Default: `alt`
2727
2728**Options**
2729
27301. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2731
2732```json
2733{
2734 "multi_cursor_modifier": "alt"
2735}
2736```
2737
27382. Maps `Control` on Linux and Windows and to `Command` on macOS:
2739
2740```json
2741{
2742 "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2743}
2744```
2745
2746## Node
2747
2748- Description: Configuration for Node.js integration
2749- Setting: `node`
2750- Default:
2751
2752```json
2753{
2754 "node": {
2755 "ignore_system_version": false,
2756 "path": null,
2757 "npm_path": null
2758 }
2759}
2760```
2761
2762**Options**
2763
2764- `ignore_system_version`: Whether to ignore the system Node.js version
2765- `path`: Custom path to Node.js binary
2766- `npm_path`: Custom path to npm binary
2767
2768## Network Proxy
2769
2770- Description: Configure a network proxy for Zed.
2771- Setting: `proxy`
2772- Default: `null`
2773
2774**Options**
2775
2776The proxy setting must contain a URL to the proxy.
2777
2778The following URI schemes are supported:
2779
2780- `http`
2781- `https`
2782- `socks4` - SOCKS4 proxy with local DNS
2783- `socks4a` - SOCKS4 proxy with remote DNS
2784- `socks5` - SOCKS5 proxy with local DNS
2785- `socks5h` - SOCKS5 proxy with remote DNS
2786
2787`http` will be used when no scheme is specified.
2788
2789By 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`.
2790
2791For example, to set an `http` proxy, add the following to your settings:
2792
2793```json
2794{
2795 "proxy": "http://127.0.0.1:10809"
2796}
2797```
2798
2799Or to set a `socks5` proxy:
2800
2801```json
2802{
2803 "proxy": "socks5h://localhost:10808"
2804}
2805```
2806
2807If 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.
2808
2809## On Last Window Closed
2810
2811- Description: What to do when the last window is closed
2812- Setting: `on_last_window_closed`
2813- Default: `"platform_default"`
2814
2815**Options**
2816
28171. Use platform default behavior:
2818
2819```json
2820{
2821 "on_last_window_closed": "platform_default"
2822}
2823```
2824
28252. Always quit the application:
2826
2827```json
2828{
2829 "on_last_window_closed": "quit_app"
2830}
2831```
2832
2833## Profiles
2834
2835- Description: Configuration profiles that can be applied on top of existing settings
2836- Setting: `profiles`
2837- Default: `{}`
2838
2839**Options**
2840
2841Configuration object for defining settings profiles. Example:
2842
2843```json
2844{
2845 "profiles": {
2846 "presentation": {
2847 "buffer_font_size": 20,
2848 "ui_font_size": 18,
2849 "theme": "One Light"
2850 }
2851 }
2852}
2853```
2854
2855## Preview tabs
2856
2857- Description:
2858 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. \
2859 There are several ways to convert a preview tab into a regular tab:
2860
2861 - Double-clicking on the file
2862 - Double-clicking on the tab header
2863 - Using the {#action project_panel::OpenPermanent} action
2864 - Editing the file
2865 - Dragging the file to a different pane
2866
2867- Setting: `preview_tabs`
2868- Default:
2869
2870```json
2871"preview_tabs": {
2872 "enabled": true,
2873 "enable_preview_from_file_finder": false,
2874 "enable_preview_from_code_navigation": false,
2875}
2876```
2877
2878### Enable preview from file finder
2879
2880- Description: Determines whether to open files in preview mode when selected from the file finder.
2881- Setting: `enable_preview_from_file_finder`
2882- Default: `false`
2883
2884**Options**
2885
2886`boolean` values
2887
2888### Enable preview from code navigation
2889
2890- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
2891- Setting: `enable_preview_from_code_navigation`
2892- Default: `false`
2893
2894**Options**
2895
2896`boolean` values
2897
2898## File Finder
2899
2900### File Icons
2901
2902- Description: Whether to show file icons in the file finder.
2903- Setting: `file_icons`
2904- Default: `true`
2905
2906### Modal Max Width
2907
2908- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2909- Setting: `modal_max_width`
2910- Default: `small`
2911
2912### Skip Focus For Active In Search
2913
2914- Description: Determines whether the file finder should skip focus for the active file in search results.
2915- Setting: `skip_focus_for_active_in_search`
2916- Default: `true`
2917
2918## Pane Split Direction Horizontal
2919
2920- Description: The direction that you want to split panes horizontally
2921- Setting: `pane_split_direction_horizontal`
2922- Default: `"up"`
2923
2924**Options**
2925
29261. Split upward:
2927
2928```json
2929{
2930 "pane_split_direction_horizontal": "up"
2931}
2932```
2933
29342. Split downward:
2935
2936```json
2937{
2938 "pane_split_direction_horizontal": "down"
2939}
2940```
2941
2942## Pane Split Direction Vertical
2943
2944- Description: The direction that you want to split panes vertically
2945- Setting: `pane_split_direction_vertical`
2946- Default: `"left"`
2947
2948**Options**
2949
29501. Split to the left:
2951
2952```json
2953{
2954 "pane_split_direction_vertical": "left"
2955}
2956```
2957
29582. Split to the right:
2959
2960```json
2961{
2962 "pane_split_direction_vertical": "right"
2963}
2964```
2965
2966## Preferred Line Length
2967
2968- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
2969- Setting: `preferred_line_length`
2970- Default: `80`
2971
2972**Options**
2973
2974`integer` values
2975
2976## Private Files
2977
2978- Description: Globs to match against file paths to determine if a file is private
2979- Setting: `private_files`
2980- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
2981
2982**Options**
2983
2984List of `string` glob patterns
2985
2986## Projects Online By Default
2987
2988- Description: Whether or not to show the online projects view by default.
2989- Setting: `projects_online_by_default`
2990- Default: `true`
2991
2992**Options**
2993
2994`boolean` values
2995
2996## Read SSH Config
2997
2998- Description: Whether to read SSH configuration files
2999- Setting: `read_ssh_config`
3000- Default: `true`
3001
3002**Options**
3003
3004`boolean` values
3005
3006## Redact Private Values
3007
3008- Description: Hide the values of variables from visual display in private files
3009- Setting: `redact_private_values`
3010- Default: `false`
3011
3012**Options**
3013
3014`boolean` values
3015
3016## Relative Line Numbers
3017
3018- Description: Whether to show relative line numbers in the gutter
3019- Setting: `relative_line_numbers`
3020- Default: `false`
3021
3022**Options**
3023
3024`boolean` values
3025
3026## Remove Trailing Whitespace On Save
3027
3028- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3029- Setting: `remove_trailing_whitespace_on_save`
3030- Default: `true`
3031
3032**Options**
3033
3034`boolean` values
3035
3036## Resize All Panels In Dock
3037
3038- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3039- Setting: `resize_all_panels_in_dock`
3040- Default: `["left"]`
3041
3042**Options**
3043
3044List of strings containing any combination of:
3045
3046- `"left"`: Resize left dock panels together
3047- `"right"`: Resize right dock panels together
3048- `"bottom"`: Resize bottom dock panels together
3049
3050## Restore on File Reopen
3051
3052- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3053- Setting: `restore_on_file_reopen`
3054- Default: `true`
3055
3056**Options**
3057
3058`boolean` values
3059
3060## Restore on Startup
3061
3062- Description: Controls session restoration on startup.
3063- Setting: `restore_on_startup`
3064- Default: `last_session`
3065
3066**Options**
3067
30681. Restore all workspaces that were open when quitting Zed:
3069
3070```json
3071{
3072 "restore_on_startup": "last_session"
3073}
3074```
3075
30762. Restore the workspace that was closed last:
3077
3078```json
3079{
3080 "restore_on_startup": "last_workspace"
3081}
3082```
3083
30843. Always start with an empty editor:
3085
3086```json
3087{
3088 "restore_on_startup": "none"
3089}
3090```
3091
3092## Scroll Beyond Last Line
3093
3094- Description: Whether the editor will scroll beyond the last line
3095- Setting: `scroll_beyond_last_line`
3096- Default: `"one_page"`
3097
3098**Options**
3099
31001. Scroll one page beyond the last line by one page:
3101
3102```json
3103{
3104 "scroll_beyond_last_line": "one_page"
3105}
3106```
3107
31082. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3109
3110```json
3111{
3112 "scroll_beyond_last_line": "vertical_scroll_margin"
3113}
3114```
3115
31163. The editor will not scroll beyond the last line:
3117
3118```json
3119{
3120 "scroll_beyond_last_line": "off"
3121}
3122```
3123
3124**Options**
3125
3126`boolean` values
3127
3128## Scroll Sensitivity
3129
3130- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3131- Setting: `scroll_sensitivity`
3132- Default: `1.0`
3133
3134**Options**
3135
3136Positive `float` values
3137
3138### Fast Scroll Sensitivity
3139
3140- 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.
3141- Setting: `fast_scroll_sensitivity`
3142- Default: `4.0`
3143
3144**Options**
3145
3146Positive `float` values
3147
3148### Horizontal Scroll Margin
3149
3150- Description: The number of characters to keep on either side when scrolling with the mouse
3151- Setting: `horizontal_scroll_margin`
3152- Default: `5`
3153
3154**Options**
3155
3156Non-negative `integer` values
3157
3158### Vertical Scroll Margin
3159
3160- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3161- Setting: `vertical_scroll_margin`
3162- Default: `3`
3163
3164**Options**
3165
3166Non-negative `integer` values
3167
3168## Search
3169
3170- Description: Search options to enable by default when opening new project and buffer searches.
3171- Setting: `search`
3172- Default:
3173
3174```json
3175"search": {
3176 "whole_word": false,
3177 "case_sensitive": false,
3178 "include_ignored": false,
3179 "regex": false
3180},
3181```
3182
3183## Search Wrap
3184
3185- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3186- Setting: `search_wrap`
3187- Default: `true`
3188
3189## Seed Search Query From Cursor
3190
3191- Description: When to populate a new search's query based on the text under the cursor.
3192- Setting: `seed_search_query_from_cursor`
3193- Default: `always`
3194
3195**Options**
3196
31971. `always` always populate the search query with the word under the cursor
31982. `selection` only populate the search query when there is text selected
31993. `never` never populate the search query
3200
3201## Use Smartcase Search
3202
3203- 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. \
3204 This applies to both in-file searches and project-wide searches.
3205- Setting: `use_smartcase_search`
3206- Default: `false`
3207
3208**Options**
3209
3210`boolean` values
3211
3212Examples:
3213
3214- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3215- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3216
3217## Show Call Status Icon
3218
3219- Description: Whether or not to show the call status icon in the status bar.
3220- Setting: `show_call_status_icon`
3221- Default: `true`
3222
3223**Options**
3224
3225`boolean` values
3226
3227## Completions
3228
3229- Description: Controls how completions are processed for this language.
3230- Setting: `completions`
3231- Default:
3232
3233```json
3234{
3235 "completions": {
3236 "words": "fallback",
3237 "words_min_length": 3,
3238 "lsp": true,
3239 "lsp_fetch_timeout_ms": 0,
3240 "lsp_insert_mode": "replace_suffix"
3241 }
3242}
3243```
3244
3245### Words
3246
3247- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3248- Setting: `words`
3249- Default: `fallback`
3250
3251**Options**
3252
32531. `enabled` - Always fetch document's words for completions along with LSP completions
32542. `fallback` - Only if LSP response errors or times out, use document's words to show completions
32553. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3256
3257### Min Words Query Length
3258
3259- Description: Minimum number of characters required to automatically trigger word-based completions.
3260 Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3261- Setting: `words_min_length`
3262- Default: `3`
3263
3264**Options**
3265
3266Positive integer values
3267
3268### LSP
3269
3270- Description: Whether to fetch LSP completions or not.
3271- Setting: `lsp`
3272- Default: `true`
3273
3274**Options**
3275
3276`boolean` values
3277
3278### LSP Fetch Timeout (ms)
3279
3280- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3281- Setting: `lsp_fetch_timeout_ms`
3282- Default: `0`
3283
3284**Options**
3285
3286`integer` values representing milliseconds
3287
3288### LSP Insert Mode
3289
3290- Description: Controls what range to replace when accepting LSP completions.
3291- Setting: `lsp_insert_mode`
3292- Default: `replace_suffix`
3293
3294**Options**
3295
32961. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
32972. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
32983. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
32994. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3300
3301## Show Completions On Input
3302
3303- Description: Whether or not to show completions as you type.
3304- Setting: `show_completions_on_input`
3305- Default: `true`
3306
3307**Options**
3308
3309`boolean` values
3310
3311## Show Completion Documentation
3312
3313- Description: Whether to display inline and alongside documentation for items in the completions menu.
3314- Setting: `show_completion_documentation`
3315- Default: `true`
3316
3317**Options**
3318
3319`boolean` values
3320
3321## Show Edit Predictions
3322
3323- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3324- Setting: `show_edit_predictions`
3325- Default: `true`
3326
3327**Options**
3328
3329`boolean` values
3330
3331## Show Whitespaces
3332
3333- Description: Whether or not to render whitespace characters in the editor.
3334- Setting: `show_whitespaces`
3335- Default: `selection`
3336
3337**Options**
3338
33391. `all`
33402. `selection`
33413. `none`
33424. `boundary`
3343
3344## Whitespace Map
3345
3346- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3347- Setting: `whitespace_map`
3348- Default:
3349
3350```json
3351{
3352 "whitespace_map": {
3353 "space": "•",
3354 "tab": "→"
3355 },
3356```
3357
3358## Soft Wrap
3359
3360- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3361- Setting: `soft_wrap`
3362- Default: `none`
3363
3364**Options**
3365
33661. `none` to avoid wrapping generally, unless the line is too long
33672. `prefer_line` (deprecated, same as `none`)
33683. `editor_width` to wrap lines that overflow the editor width
33694. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
33705. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3371
3372## Show Wrap Guides
3373
3374- 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.
3375- Setting: `show_wrap_guides`
3376- Default: `true`
3377
3378**Options**
3379
3380`boolean` values
3381
3382## Use On Type Format
3383
3384- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3385- Setting: `use_on_type_format`
3386- Default: `true`
3387
3388**Options**
3389
3390`boolean` values
3391
3392## Use Auto Surround
3393
3394- 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 ().
3395- Setting: `use_auto_surround`
3396- Default: `true`
3397
3398**Options**
3399
3400`boolean` values
3401
3402## Use System Path Prompts
3403
3404- 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.
3405- Setting: `use_system_path_prompts`
3406- Default: `true`
3407
3408**Options**
3409
3410`boolean` values
3411
3412## Use System Prompts
3413
3414- 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.
3415- Setting: `use_system_prompts`
3416- Default: `true`
3417
3418**Options**
3419
3420`boolean` values
3421
3422## Wrap Guides (Vertical Rulers)
3423
3424- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3425- Setting: `wrap_guides`
3426- Default: []
3427
3428**Options**
3429
3430List of `integer` column numbers
3431
3432## Tab Size
3433
3434- Description: The number of spaces to use for each tab character.
3435- Setting: `tab_size`
3436- Default: `4`
3437
3438**Options**
3439
3440`integer` values
3441
3442## Tasks
3443
3444- Description: Configuration for tasks that can be run within Zed
3445- Setting: `tasks`
3446- Default:
3447
3448```json
3449{
3450 "tasks": {
3451 "variables": {},
3452 "enabled": true,
3453 "prefer_lsp": false
3454 }
3455}
3456```
3457
3458**Options**
3459
3460- `variables`: Custom variables for task configuration
3461- `enabled`: Whether tasks are enabled
3462- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3463
3464## Telemetry
3465
3466- Description: Control what info is collected by Zed.
3467- Setting: `telemetry`
3468- Default:
3469
3470```json
3471"telemetry": {
3472 "diagnostics": true,
3473 "metrics": true
3474},
3475```
3476
3477**Options**
3478
3479### Diagnostics
3480
3481- Description: Setting for sending debug-related data, such as crash reports.
3482- Setting: `diagnostics`
3483- Default: `true`
3484
3485**Options**
3486
3487`boolean` values
3488
3489### Metrics
3490
3491- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3492- Setting: `metrics`
3493- Default: `true`
3494
3495**Options**
3496
3497`boolean` values
3498
3499## Terminal
3500
3501- Description: Configuration for the terminal.
3502- Setting: `terminal`
3503- Default:
3504
3505```json
3506{
3507 "terminal": {
3508 "alternate_scroll": "off",
3509 "blinking": "terminal_controlled",
3510 "copy_on_select": false,
3511 "keep_selection_on_copy": false,
3512 "dock": "bottom",
3513 "default_width": 640,
3514 "default_height": 320,
3515 "detect_venv": {
3516 "on": {
3517 "directories": [".env", "env", ".venv", "venv"],
3518 "activate_script": "default"
3519 }
3520 },
3521 "env": {},
3522 "font_family": null,
3523 "font_features": null,
3524 "font_size": null,
3525 "line_height": "comfortable",
3526 "minimum_contrast": 45,
3527 "option_as_meta": false,
3528 "button": true,
3529 "shell": "system",
3530 "toolbar": {
3531 "breadcrumbs": false
3532 },
3533 "working_directory": "current_project_directory",
3534 "scrollbar": {
3535 "show": null
3536 }
3537 }
3538}
3539```
3540
3541### Terminal: Dock
3542
3543- Description: Control the position of the dock
3544- Setting: `dock`
3545- Default: `bottom`
3546
3547**Options**
3548
3549`"bottom"`, `"left"` or `"right"`
3550
3551### Terminal: Alternate Scroll
3552
3553- 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.
3554- Setting: `alternate_scroll`
3555- Default: `off`
3556
3557**Options**
3558
35591. Default alternate scroll mode to off
3560
3561```json
3562{
3563 "terminal": {
3564 "alternate_scroll": "off"
3565 }
3566}
3567```
3568
35692. Default alternate scroll mode to on
3570
3571```json
3572{
3573 "terminal": {
3574 "alternate_scroll": "on"
3575 }
3576}
3577```
3578
3579### Terminal: Blinking
3580
3581- Description: Set the cursor blinking behavior in the terminal
3582- Setting: `blinking`
3583- Default: `terminal_controlled`
3584
3585**Options**
3586
35871. Never blink the cursor, ignore the terminal mode
3588
3589```json
3590{
3591 "terminal": {
3592 "blinking": "off"
3593 }
3594}
3595```
3596
35972. Default the cursor blink to off, but allow the terminal to turn blinking on
3598
3599```json
3600{
3601 "terminal": {
3602 "blinking": "terminal_controlled"
3603 }
3604}
3605```
3606
36073. Always blink the cursor, ignore the terminal mode
3608
3609```json
3610{
3611 "terminal": {
3612 "blinking": "on"
3613 }
3614}
3615```
3616
3617### Terminal: Copy On Select
3618
3619- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3620- Setting: `copy_on_select`
3621- Default: `false`
3622
3623**Options**
3624
3625`boolean` values
3626
3627**Example**
3628
3629```json
3630{
3631 "terminal": {
3632 "copy_on_select": true
3633 }
3634}
3635```
3636
3637### Terminal: Cursor Shape
3638
3639- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3640- Setting: `cursor_shape`
3641- Default: `null` (defaults to block)
3642
3643**Options**
3644
36451. A block that surrounds the following character
3646
3647```json
3648{
3649 "terminal": {
3650 "cursor_shape": "block"
3651 }
3652}
3653```
3654
36552. A vertical bar
3656
3657```json
3658{
3659 "terminal": {
3660 "cursor_shape": "bar"
3661 }
3662}
3663```
3664
36653. An underline / underscore that runs along the following character
3666
3667```json
3668{
3669 "terminal": {
3670 "cursor_shape": "underline"
3671 }
3672}
3673```
3674
36754. A box drawn around the following character
3676
3677```json
3678{
3679 "terminal": {
3680 "cursor_shape": "hollow"
3681 }
3682}
3683```
3684
3685### Terminal: Keep Selection On Copy
3686
3687- Description: Whether or not to keep the selection in the terminal after copying text.
3688- Setting: `keep_selection_on_copy`
3689- Default: `false`
3690
3691**Options**
3692
3693`boolean` values
3694
3695**Example**
3696
3697```json
3698{
3699 "terminal": {
3700 "keep_selection_on_copy": true
3701 }
3702}
3703```
3704
3705### Terminal: Env
3706
3707- 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
3708- Setting: `env`
3709- Default: `{}`
3710
3711**Example**
3712
3713```json
3714{
3715 "terminal": {
3716 "env": {
3717 "ZED": "1",
3718 "KEY": "value1:value2"
3719 }
3720 }
3721}
3722```
3723
3724### Terminal: Font Size
3725
3726- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3727- Setting: `font_size`
3728- Default: `null`
3729
3730**Options**
3731
3732`integer` values
3733
3734```json
3735{
3736 "terminal": {
3737 "font_size": 15
3738 }
3739}
3740```
3741
3742### Terminal: Font Family
3743
3744- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3745- Setting: `font_family`
3746- Default: `null`
3747
3748**Options**
3749
3750The name of any font family installed on the user's system
3751
3752```json
3753{
3754 "terminal": {
3755 "font_family": "Berkeley Mono"
3756 }
3757}
3758```
3759
3760### Terminal: Font Features
3761
3762- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3763- Setting: `font_features`
3764- Default: `null`
3765- Platform: macOS and Windows.
3766
3767**Options**
3768
3769See Buffer Font Features
3770
3771```json
3772{
3773 "terminal": {
3774 "font_features": {
3775 "calt": false
3776 // See Buffer Font Features for more features
3777 }
3778 }
3779}
3780```
3781
3782### Terminal: Line Height
3783
3784- Description: Set the terminal's line height.
3785- Setting: `line_height`
3786- Default: `standard`
3787
3788**Options**
3789
37901. Use a line height that's `comfortable` for reading, 1.618.
3791
3792```json
3793{
3794 "terminal": {
3795 "line_height": "comfortable"
3796 }
3797}
3798```
3799
38002. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3801
3802```json
3803{
3804 "terminal": {
3805 "line_height": "standard"
3806 }
3807}
3808```
3809
38103. Use a custom line height.
3811
3812```json
3813{
3814 "terminal": {
3815 "line_height": {
3816 "custom": 2
3817 }
3818 }
3819}
3820```
3821
3822### Terminal: Minimum Contrast
3823
3824- 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.
3825- Setting: `minimum_contrast`
3826- Default: `45`
3827
3828**Options**
3829
3830`integer` values from 0 to 106. Common recommended values:
3831
3832- `0`: No contrast adjustment
3833- `45`: Minimum for large fluent text (default)
3834- `60`: Minimum for other content text
3835- `75`: Minimum for body text
3836- `90`: Preferred for body text
3837
3838```json
3839{
3840 "terminal": {
3841 "minimum_contrast": 45
3842 }
3843}
3844```
3845
3846### Terminal: Option As Meta
3847
3848- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
3849- Setting: `option_as_meta`
3850- Default: `false`
3851
3852**Options**
3853
3854`boolean` values
3855
3856```json
3857{
3858 "terminal": {
3859 "option_as_meta": true
3860 }
3861}
3862```
3863
3864### Terminal: Shell
3865
3866- Description: What shell to use when launching the terminal.
3867- Setting: `shell`
3868- Default: `system`
3869
3870**Options**
3871
38721. Use the system's default terminal configuration (usually the `/etc/passwd` file).
3873
3874```json
3875{
3876 "terminal": {
3877 "shell": "system"
3878 }
3879}
3880```
3881
38822. A program to launch:
3883
3884```json
3885{
3886 "terminal": {
3887 "shell": {
3888 "program": "sh"
3889 }
3890 }
3891}
3892```
3893
38943. A program with arguments:
3895
3896```json
3897{
3898 "terminal": {
3899 "shell": {
3900 "with_arguments": {
3901 "program": "/bin/bash",
3902 "args": ["--login"]
3903 }
3904 }
3905 }
3906}
3907```
3908
3909## Terminal: Detect Virtual Environments {#terminal-detect_venv}
3910
3911- 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.
3912- Setting: `detect_venv`
3913- Default:
3914
3915```json
3916{
3917 "terminal": {
3918 "detect_venv": {
3919 "on": {
3920 // Default directories to search for virtual environments, relative
3921 // to the current working directory. We recommend overriding this
3922 // in your project's settings, rather than globally.
3923 "directories": [".env", "env", ".venv", "venv"],
3924 // Can also be `csh`, `fish`, and `nushell`
3925 "activate_script": "default"
3926 }
3927 }
3928 }
3929}
3930```
3931
3932Disable with:
3933
3934```json
3935{
3936 "terminal": {
3937 "detect_venv": "off"
3938 }
3939}
3940```
3941
3942## Terminal: Toolbar
3943
3944- Description: Whether or not to show various elements in the terminal toolbar.
3945- Setting: `toolbar`
3946- Default:
3947
3948```json
3949{
3950 "terminal": {
3951 "toolbar": {
3952 "breadcrumbs": false
3953 }
3954 }
3955}
3956```
3957
3958**Options**
3959
3960At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
3961
3962If the terminal title is empty, the breadcrumbs won't be shown.
3963
3964The shell running in the terminal needs to be configured to emit the title.
3965
3966Example command to set the title: `echo -e "\e]2;New Title\007";`
3967
3968### Terminal: Button
3969
3970- Description: Control to show or hide the terminal button in the status bar
3971- Setting: `button`
3972- Default: `true`
3973
3974**Options**
3975
3976`boolean` values
3977
3978```json
3979{
3980 "terminal": {
3981 "button": false
3982 }
3983}
3984```
3985
3986### Terminal: Working Directory
3987
3988- Description: What working directory to use when launching the terminal.
3989- Setting: `working_directory`
3990- Default: `"current_project_directory"`
3991
3992**Options**
3993
39941. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
3995
3996```json
3997{
3998 "terminal": {
3999 "working_directory": "current_project_directory"
4000 }
4001}
4002```
4003
40042. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
4005
4006```json
4007{
4008 "terminal": {
4009 "working_directory": "first_project_directory"
4010 }
4011}
4012```
4013
40143. Always use this platform's home directory (if we can find it)
4015
4016```json
4017{
4018 "terminal": {
4019 "working_directory": "always_home"
4020 }
4021}
4022```
4023
40244. 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.
4025
4026```json
4027{
4028 "terminal": {
4029 "working_directory": {
4030 "always": {
4031 "directory": "~/zed/projects/"
4032 }
4033 }
4034 }
4035}
4036```
4037
4038## REPL
4039
4040- Description: Repl settings.
4041- Setting: `repl`
4042- Default:
4043
4044```json
4045"repl": {
4046 // Maximum number of columns to keep in REPL's scrollback buffer.
4047 // Clamped with [20, 512] range.
4048 "max_columns": 128,
4049 // Maximum number of lines to keep in REPL's scrollback buffer.
4050 // Clamped with [4, 256] range.
4051 "max_lines": 32
4052},
4053```
4054
4055## Theme
4056
4057- 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.
4058- Setting: `theme`
4059- Default: `One Dark`
4060
4061### Theme Object
4062
4063- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4064- Setting: `theme`
4065- Default:
4066
4067```json
4068"theme": {
4069 "mode": "system",
4070 "dark": "One Dark",
4071 "light": "One Light"
4072},
4073```
4074
4075### Mode
4076
4077- Description: Specify theme mode.
4078- Setting: `mode`
4079- Default: `system`
4080
4081**Options**
4082
40831. Set the theme to dark mode
4084
4085```json
4086{
4087 "mode": "dark"
4088}
4089```
4090
40912. Set the theme to light mode
4092
4093```json
4094{
4095 "mode": "light"
4096}
4097```
4098
40993. Set the theme to system mode
4100
4101```json
4102{
4103 "mode": "system"
4104}
4105```
4106
4107### Dark
4108
4109- Description: The name of the dark Zed theme to use for the UI.
4110- Setting: `dark`
4111- Default: `One Dark`
4112
4113**Options**
4114
4115Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4116
4117### Light
4118
4119- Description: The name of the light Zed theme to use for the UI.
4120- Setting: `light`
4121- Default: `One Light`
4122
4123**Options**
4124
4125Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4126
4127## Title Bar
4128
4129- Description: Whether or not to show various elements in the title bar
4130- Setting: `title_bar`
4131- Default:
4132
4133```json
4134"title_bar": {
4135 "show_branch_icon": false,
4136 "show_branch_name": true,
4137 "show_project_items": true,
4138 "show_onboarding_banner": true,
4139 "show_user_picture": true,
4140 "show_sign_in": true,
4141 "show_menus": false
4142}
4143```
4144
4145**Options**
4146
4147- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4148- `show_branch_name`: Whether to show the branch name button in the titlebar
4149- `show_project_items`: Whether to show the project host and name in the titlebar
4150- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4151- `show_user_picture`: Whether to show user picture in the titlebar
4152- `show_sign_in`: Whether to show the sign in button in the titlebar
4153- `show_menus`: Whether to show the menus in the titlebar
4154
4155## Vim
4156
4157- Description: Whether or not to enable vim mode.
4158- Setting: `vim_mode`
4159- Default: `false`
4160
4161## When Closing With No Tabs
4162
4163- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4164- Setting: `when_closing_with_no_tabs`
4165- Default: `"platform_default"`
4166
4167**Options**
4168
41691. Use platform default behavior:
4170
4171```json
4172{
4173 "when_closing_with_no_tabs": "platform_default"
4174}
4175```
4176
41772. Always close the window:
4178
4179```json
4180{
4181 "when_closing_with_no_tabs": "close_window"
4182}
4183```
4184
41853. Never close the window:
4186
4187```json
4188{
4189 "when_closing_with_no_tabs": "keep_window_open"
4190}
4191```
4192
4193## Project Panel
4194
4195- Description: Customize project panel
4196- Setting: `project_panel`
4197- Default:
4198
4199```json
4200{
4201 "project_panel": {
4202 "button": true,
4203 "default_width": 240,
4204 "dock": "left",
4205 "entry_spacing": "comfortable",
4206 "file_icons": true,
4207 "folder_icons": true,
4208 "git_status": true,
4209 "indent_size": 20,
4210 "auto_reveal_entries": true,
4211 "auto_fold_dirs": true,
4212 "drag_and_drop": true,
4213 "scrollbar": {
4214 "show": null
4215 },
4216 "sticky_scroll": true,
4217 "show_diagnostics": "all",
4218 "indent_guides": {
4219 "show": "always"
4220 },
4221 "hide_root": false,
4222 "starts_open": true
4223 }
4224}
4225```
4226
4227### Dock
4228
4229- Description: Control the position of the dock
4230- Setting: `dock`
4231- Default: `left`
4232
4233**Options**
4234
42351. Default dock position to left
4236
4237```json
4238{
4239 "dock": "left"
4240}
4241```
4242
42432. Default dock position to right
4244
4245```json
4246{
4247 "dock": "right"
4248}
4249```
4250
4251### Entry Spacing
4252
4253- Description: Spacing between worktree entries
4254- Setting: `entry_spacing`
4255- Default: `comfortable`
4256
4257**Options**
4258
42591. Comfortable entry spacing
4260
4261```json
4262{
4263 "entry_spacing": "comfortable"
4264}
4265```
4266
42672. Standard entry spacing
4268
4269```json
4270{
4271 "entry_spacing": "standard"
4272}
4273```
4274
4275### Git Status
4276
4277- Description: Indicates newly created and updated files
4278- Setting: `git_status`
4279- Default: `true`
4280
4281**Options**
4282
42831. Default enable git status
4284
4285```json
4286{
4287 "git_status": true
4288}
4289```
4290
42912. Default disable git status
4292
4293```json
4294{
4295 "git_status": false
4296}
4297```
4298
4299### Default Width
4300
4301- Description: Customize default width taken by project panel
4302- Setting: `default_width`
4303- Default: `240`
4304
4305**Options**
4306
4307`float` values
4308
4309### Auto Reveal Entries
4310
4311- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4312- Setting: `auto_reveal_entries`
4313- Default: `true`
4314
4315**Options**
4316
43171. Enable auto reveal entries
4318
4319```json
4320{
4321 "auto_reveal_entries": true
4322}
4323```
4324
43252. Disable auto reveal entries
4326
4327```json
4328{
4329 "auto_reveal_entries": false
4330}
4331```
4332
4333### Auto Fold Dirs
4334
4335- Description: Whether to fold directories automatically when directory has only one directory inside.
4336- Setting: `auto_fold_dirs`
4337- Default: `true`
4338
4339**Options**
4340
43411. Enable auto fold dirs
4342
4343```json
4344{
4345 "auto_fold_dirs": true
4346}
4347```
4348
43492. Disable auto fold dirs
4350
4351```json
4352{
4353 "auto_fold_dirs": false
4354}
4355```
4356
4357### Indent Size
4358
4359- Description: Amount of indentation (in pixels) for nested items.
4360- Setting: `indent_size`
4361- Default: `20`
4362
4363### Indent Guides: Show
4364
4365- Description: Whether to show indent guides in the project panel.
4366- Setting: `indent_guides`
4367- Default:
4368
4369```json
4370"indent_guides": {
4371 "show": "always"
4372}
4373```
4374
4375**Options**
4376
43771. Show indent guides in the project panel
4378
4379```json
4380{
4381 "indent_guides": {
4382 "show": "always"
4383 }
4384}
4385```
4386
43872. Hide indent guides in the project panel
4388
4389```json
4390{
4391 "indent_guides": {
4392 "show": "never"
4393 }
4394}
4395```
4396
4397### Scrollbar: Show
4398
4399- 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.
4400- Setting: `scrollbar`
4401- Default:
4402
4403```json
4404"scrollbar": {
4405 "show": null
4406}
4407```
4408
4409**Options**
4410
44111. Show scrollbar in the project panel
4412
4413```json
4414{
4415 "scrollbar": {
4416 "show": "always"
4417 }
4418}
4419```
4420
44212. Hide scrollbar in the project panel
4422
4423```json
4424{
4425 "scrollbar": {
4426 "show": "never"
4427 }
4428}
4429```
4430
4431## Agent
4432
4433Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4434
4435## Collaboration Panel
4436
4437- Description: Customizations for the collaboration panel.
4438- Setting: `collaboration_panel`
4439- Default:
4440
4441```json
4442{
4443 "collaboration_panel": {
4444 "button": true,
4445 "dock": "left",
4446 "default_width": 240
4447 }
4448}
4449```
4450
4451**Options**
4452
4453- `button`: Whether to show the collaboration panel button in the status bar
4454- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4455- `default_width`: Default width of the collaboration panel
4456
4457## Debugger
4458
4459- Description: Configuration for debugger panel and settings
4460- Setting: `debugger`
4461- Default:
4462
4463```json
4464{
4465 "debugger": {
4466 "stepping_granularity": "line",
4467 "save_breakpoints": true,
4468 "dock": "bottom",
4469 "button": true
4470 }
4471}
4472```
4473
4474See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4475
4476## Git Panel
4477
4478- Description: Setting to customize the behavior of the git panel.
4479- Setting: `git_panel`
4480- Default:
4481
4482```json
4483{
4484 "git_panel": {
4485 "button": true,
4486 "dock": "left",
4487 "default_width": 360,
4488 "status_style": "icon",
4489 "fallback_branch_name": "main",
4490 "sort_by_path": false,
4491 "collapse_untracked_diff": false,
4492 "scrollbar": {
4493 "show": null
4494 }
4495 }
4496}
4497```
4498
4499**Options**
4500
4501- `button`: Whether to show the git panel button in the status bar
4502- `dock`: Where to dock the git panel. Can be `left` or `right`
4503- `default_width`: Default width of the git panel
4504- `status_style`: How to display git status. Can be `label_color` or `icon`
4505- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4506- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4507- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4508- `scrollbar`: When to show the scrollbar in the git panel
4509
4510## Outline Panel
4511
4512- Description: Customize outline Panel
4513- Setting: `outline_panel`
4514- Default:
4515
4516```json
4517"outline_panel": {
4518 "button": true,
4519 "default_width": 300,
4520 "dock": "left",
4521 "file_icons": true,
4522 "folder_icons": true,
4523 "git_status": true,
4524 "indent_size": 20,
4525 "auto_reveal_entries": true,
4526 "auto_fold_dirs": true,
4527 "indent_guides": {
4528 "show": "always"
4529 },
4530 "scrollbar": {
4531 "show": null
4532 }
4533}
4534```
4535
4536## Calls
4537
4538- Description: Customize behavior when participating in a call
4539- Setting: `calls`
4540- Default:
4541
4542```json
4543"calls": {
4544 // Join calls with the microphone live by default
4545 "mute_on_join": false,
4546 // Share your project when you are the first to join a channel
4547 "share_on_join": false
4548},
4549```
4550
4551## Unnecessary Code Fade
4552
4553- Description: How much to fade out unused code.
4554- Setting: `unnecessary_code_fade`
4555- Default: `0.3`
4556
4557**Options**
4558
4559Float values between `0.0` and `0.9`, where:
4560
4561- `0.0` means no fading (unused code looks the same as used code)
4562- `0.9` means maximum fading (unused code is very faint but still visible)
4563
4564**Example**
4565
4566```json
4567{
4568 "unnecessary_code_fade": 0.5
4569}
4570```
4571
4572## UI Font Family
4573
4574- Description: The name of the font to use for text in the UI.
4575- Setting: `ui_font_family`
4576- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4577
4578**Options**
4579
4580The 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).
4581
4582## UI Font Features
4583
4584- Description: The OpenType features to enable for text in the UI.
4585- Setting: `ui_font_features`
4586- Default:
4587
4588```json
4589"ui_font_features": {
4590 "calt": false
4591}
4592```
4593
4594- Platform: macOS and Windows.
4595
4596**Options**
4597
4598Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4599
4600For example, to disable font ligatures, add the following to your settings:
4601
4602```json
4603{
4604 "ui_font_features": {
4605 "calt": false
4606 }
4607}
4608```
4609
4610You can also set other OpenType features, like setting `cv01` to `7`:
4611
4612```json
4613{
4614 "ui_font_features": {
4615 "cv01": 7
4616 }
4617}
4618```
4619
4620## UI Font Fallbacks
4621
4622- Description: The font fallbacks to use for text in the UI.
4623- Setting: `ui_font_fallbacks`
4624- Default: `null`
4625- Platform: macOS and Windows.
4626
4627**Options**
4628
4629For example, to use `Nerd Font` as a fallback, add the following to your settings:
4630
4631```json
4632{
4633 "ui_font_fallbacks": ["Nerd Font"]
4634}
4635```
4636
4637## UI Font Size
4638
4639- Description: The default font size for text in the UI.
4640- Setting: `ui_font_size`
4641- Default: `16`
4642
4643**Options**
4644
4645`integer` values from `6` to `100` pixels (inclusive)
4646
4647## UI Font Weight
4648
4649- Description: The default font weight for text in the UI.
4650- Setting: `ui_font_weight`
4651- Default: `400`
4652
4653**Options**
4654
4655`integer` values between `100` and `900`
4656
4657## An example configuration:
4658
4659```json
4660// ~/.config/zed/settings.json
4661{
4662 "theme": "cave-light",
4663 "tab_size": 2,
4664 "preferred_line_length": 80,
4665 "soft_wrap": "none",
4666
4667 "buffer_font_size": 18,
4668 "buffer_font_family": ".ZedMono",
4669
4670 "autosave": "on_focus_change",
4671 "format_on_save": "off",
4672 "vim_mode": false,
4673 "projects_online_by_default": true,
4674 "terminal": {
4675 "font_family": "FiraCode Nerd Font Mono",
4676 "blinking": "off"
4677 },
4678 "languages": {
4679 "C": {
4680 "format_on_save": "language_server",
4681 "preferred_line_length": 64,
4682 "soft_wrap": "preferred_line_length"
4683 }
4684 }
4685}
4686```