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