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 [settings]
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 [settings]
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 [settings]
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 [settings]
94{
95 "bottom_dock_layout": "left_aligned"
96}
97```
98
994. Right align the bottom dock, giving the left dock the full height of the window and truncating the right dock.
100
101```json [settings]
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 [settings]
128{
129 "allow_rewrap": "in_comments"
130}
131```
132
1332. Allow rewrap in selections only:
134
135```json [settings]
136{
137 "allow_rewrap": "in_selections"
138}
139```
140
1413. Allow rewrap anywhere:
142
143```json [settings]
144{
145 "allow_rewrap": "anywhere"
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 [settings]
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 [settings]
216{
217 "autosave": "off"
218}
219```
220
2212. To autosave when focus changes, use `on_focus_change`:
222
223```json [settings]
224{
225 "autosave": "on_focus_change"
226}
227```
228
2293. To autosave when the active window changes, use `on_window_change`:
230
231```json [settings]
232{
233 "autosave": "on_window_change"
234}
235```
236
2374. To autosave after an inactivity period, use `after_delay`:
238
239```json [settings]
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 [settings]
302{
303 "base_keymap": "VSCode"
304}
305```
306
3072. Atom
308
309```json [settings]
310{
311 "base_keymap": "Atom"
312}
313```
314
3153. JetBrains
316
317```json [settings]
318{
319 "base_keymap": "JetBrains"
320}
321```
322
3234. None
324
325```json [settings]
326{
327 "base_keymap": "None"
328}
329```
330
3315. Sublime Text
332
333```json [settings]
334{
335 "base_keymap": "SublimeText"
336}
337```
338
3396. TextMate
340
341```json [settings]
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 [settings]
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 [settings]
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 [settings]
400{
401 "buffer_font_fallbacks": ["Nerd Font"]
402}
403```
404
405## Buffer Font Size
406
407- Description: The default font size for text in the editor.
408- Setting: `buffer_font_size`
409- Default: `15`
410
411**Options**
412
413A font size from `6` to `100` pixels (inclusive)
414
415## Buffer Font Weight
416
417- Description: The default font weight for text in the editor.
418- Setting: `buffer_font_weight`
419- Default: `400`
420
421**Options**
422
423`integer` values between `100` and `900`
424
425## Buffer Line Height
426
427- Description: The default line height for text in the editor.
428- Setting: `buffer_line_height`
429- Default: `"comfortable"`
430
431**Options**
432
433`"standard"`, `"comfortable"` or `{ "custom": float }` (`1` is compact, `2` is loose)
434
435## Centered Layout
436
437- Description: Configuration for the centered layout mode.
438- Setting: `centered_layout`
439- Default:
440
441```json [settings]
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 [settings]
488{
489 "diagnostics_max_severity": "all"
490}
491```
492
4932. Show only errors:
494
495```json [settings]
496{
497 "diagnostics_max_severity": "error"
498}
499```
500
5013. Show errors and warnings:
502
503```json [settings]
504{
505 "diagnostics_max_severity": "warning"
506}
507```
508
5094. Show errors, warnings, and information:
510
511```json [settings]
512{
513 "diagnostics_max_severity": "info"
514}
515```
516
5175. Show all including hints:
518
519```json [settings]
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 [settings]
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 [settings]
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 [settings]
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 [settings]
631"disabled_in": ["comment"]
632```
633
6342. Don't show edit predictions in strings and comments:
635
636```json [settings]
637"disabled_in": ["comment", "string"]
638```
639
6403. Only in Go, don't show edit predictions in strings and comments:
641
642```json [settings]
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 [settings]
663"current_line_highlight": "none"
664```
665
6662. Highlight the gutter area:
667
668```json [settings]
669"current_line_highlight": "gutter"
670```
671
6723. Highlight the editor area:
673
674```json [settings]
675"current_line_highlight": "line"
676```
677
6784. Highlight the full line:
679
680```json [settings]
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 [settings]
717"cursor_shape": "bar"
718```
719
7202. A block that surrounds the following character:
721
722```json [settings]
723"cursor_shape": "block"
724```
725
7263. An underline / underscore that runs along the following character:
727
728```json [settings]
729"cursor_shape": "underline"
730```
731
7324. An box drawn around the following character:
733
734```json [settings]
735"cursor_shape": "hollow"
736```
737
738## Gutter
739
740- Description: Settings for the editor gutter
741- Setting: `gutter`
742- Default:
743
744```json [settings]
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 [settings]
775"hide_mouse": "never"
776```
777
7782. Hide only when typing:
779
780```json [settings]
781"hide_mouse": "on_typing"
782```
783
7843. Hide on both typing and cursor movement:
785
786```json [settings]
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 [settings]
801"snippet_sort_order": "top"
802```
803
8042. Place snippets normally without any preference:
805
806```json [settings]
807"snippet_sort_order": "inline"
808```
809
8103. Place snippets at the bottom of the completion list:
811
812```json [settings]
813"snippet_sort_order": "bottom"
814```
815
8164. Do not show snippets in the completion list at all:
817
818```json [settings]
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 [settings]
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 [settings]
855"scrollbar": {
856 "show": "auto"
857}
858```
859
8602. Match the system's configured behavior:
861
862```json [settings]
863"scrollbar": {
864 "show": "system"
865}
866```
867
8683. Always show the scrollbar:
869
870```json [settings]
871"scrollbar": {
872 "show": "always"
873}
874```
875
8764. Never show the scrollbar:
877
878```json [settings]
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 [settings]
945{
946 "show_diagnostics": "all"
947}
948```
949
9502. Do not show any diagnostics:
951
952```json [settings]
953{
954 "show_diagnostics": "off"
955}
956```
957
9583. Show only errors:
959
960```json [settings]
961{
962 "show_diagnostics": "error"
963}
964```
965
9664. Show only errors and warnings:
967
968```json [settings]
969{
970 "show_diagnostics": "warning"
971}
972```
973
9745. Show only errors, warnings, and information:
975
976```json [settings]
977{
978 "show_diagnostics": "info"
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 [settings]
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 [settings]
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 [settings]
1045{
1046 "show": "always"
1047}
1048```
1049
10502. Show the minimap if the editor's scrollbars are visible:
1051
1052```json [settings]
1053{
1054 "show": "auto"
1055}
1056```
1057
10583. Never show the minimap:
1059
1060```json [settings]
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 [settings]
1077{
1078 "thumb": "hover"
1079}
1080```
1081
10822. Always show the minimap thumb:
1083
1084```json [settings]
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 [settings]
1101{
1102 "thumb_border": "full"
1103}
1104```
1105
11062. Display a border on all sides except the left side:
1107
1108```json [settings]
1109{
1110 "thumb_border": "left_open"
1111}
1112```
1113
11143. Display a border on all sides except the right side:
1115
1116```json [settings]
1117{
1118 "thumb_border": "right_open"
1119}
1120```
1121
11224. Display a border only on the left side:
1123
1124```json [settings]
1125{
1126 "thumb_border": "left_only"
1127}
1128```
1129
11305. Display the thumb without any border:
1131
1132```json [settings]
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 [settings]
1149{
1150 "minimap": {
1151 "current_line_highlight": null
1152 }
1153}
1154```
1155
11562. Highlight the current line in the minimap:
1157
1158```json [settings]
1159{
1160 "minimap": {
1161 "current_line_highlight": "line"
1162 }
1163}
1164```
1165
1166or
1167
1168```json [settings]
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 [settings]
1179{
1180 "minimap": {
1181 "current_line_highlight": "gutter"
1182 }
1183}
1184```
1185
1186or
1187
1188```json [settings]
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 [settings]
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 [settings]
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 [settings]
1268{
1269 "close_position": "right"
1270}
1271```
1272
12732. Display the close button on the left:
1274
1275```json [settings]
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 [settings]
1304{
1305 "activate_on_close": "history"
1306}
1307```
1308
13092. Activate the right neighbour tab if present:
1310
1311```json [settings]
1312{
1313 "activate_on_close": "neighbour"
1314}
1315```
1316
13173. Activate the left neighbour tab if present:
1318
1319```json [settings]
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 [settings]
1336{
1337 "show_close_button": "hover"
1338}
1339```
1340
13412. Show it persistently:
1342
1343```json [settings]
1344{
1345 "show_close_button": "always"
1346}
1347```
1348
13493. Never show it, even if hovering it:
1350
1351```json [settings]
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 [settings]
1368{
1369 "show_diagnostics": "off"
1370}
1371```
1372
13732. Only mark files with errors:
1374
1375```json [settings]
1376{
1377 "show_diagnostics": "errors"
1378}
1379```
1380
13813. Mark files with errors and warnings:
1382
1383```json [settings]
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 [settings]
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 [settings]
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 [settings]
1499"status_bar": {
1500 "active_language_button": true,
1501 "cursor_position_button": true
1502},
1503```
1504
1505There is an experimental setting that completely hides the status bar. This causes major usability problems (you will be unable to use many of Zed's features), but is provided for those who value screen real-estate above all else.
1506
1507```json
1508"status_bar": {
1509 "experimental.show": false
1510}
1511```
1512
1513## LSP
1514
1515- Description: Configuration for language servers.
1516- Setting: `lsp`
1517- Default: `null`
1518
1519**Options**
1520
1521The following settings can be overridden for specific language servers:
1522
1523- `initialization_options`
1524- `settings`
1525
1526To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1527
1528Some options are passed via `initialization_options` to the language server. These are for options which must be specified at language server startup and when changed will require restarting the language server.
1529
1530For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1531
1532```json [settings]
1533"lsp": {
1534 "rust-analyzer": {
1535 "initialization_options": {
1536 "check": {
1537 "command": "clippy" // rust-analyzer.check.command (default: "check")
1538 }
1539 }
1540 }
1541}
1542```
1543
1544While other options may be changed at a runtime and should be placed under `settings`:
1545
1546```json [settings]
1547"lsp": {
1548 "yaml-language-server": {
1549 "settings": {
1550 "yaml": {
1551 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1552 }
1553 }
1554 }
1555}
1556```
1557
1558## Global LSP Settings
1559
1560- Description: Configuration for global LSP settings that apply to all language servers
1561- Setting: `global_lsp_settings`
1562- Default:
1563
1564```json [settings]
1565{
1566 "global_lsp_settings": {
1567 "button": true
1568 }
1569}
1570```
1571
1572**Options**
1573
1574- `button`: Whether to show the LSP status button in the status bar
1575
1576## LSP Highlight Debounce
1577
1578- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1579- Setting: `lsp_highlight_debounce`
1580- Default: `75`
1581
1582**Options**
1583
1584`integer` values representing milliseconds
1585
1586## Features
1587
1588- Description: Features that can be globally enabled or disabled
1589- Setting: `features`
1590- Default:
1591
1592```json [settings]
1593{
1594 "features": {
1595 "edit_prediction_provider": "zed"
1596 }
1597}
1598```
1599
1600### Edit Prediction Provider
1601
1602- Description: Which edit prediction provider to use
1603- Setting: `edit_prediction_provider`
1604- Default: `"zed"`
1605
1606**Options**
1607
16081. Use Zeta as the edit prediction provider:
1609
1610```json [settings]
1611{
1612 "features": {
1613 "edit_prediction_provider": "zed"
1614 }
1615}
1616```
1617
16182. Use Copilot as the edit prediction provider:
1619
1620```json [settings]
1621{
1622 "features": {
1623 "edit_prediction_provider": "copilot"
1624 }
1625}
1626```
1627
16283. Use Supermaven as the edit prediction provider:
1629
1630```json [settings]
1631{
1632 "features": {
1633 "edit_prediction_provider": "supermaven"
1634 }
1635}
1636```
1637
16384. Turn off edit predictions across all providers
1639
1640```json [settings]
1641{
1642 "features": {
1643 "edit_prediction_provider": "none"
1644 }
1645}
1646```
1647
1648## Format On Save
1649
1650- Description: Whether or not to perform a buffer format before saving.
1651- Setting: `format_on_save`
1652- Default: `on`
1653
1654**Options**
1655
16561. `on`, enables format on save obeying `formatter` setting:
1657
1658```json [settings]
1659{
1660 "format_on_save": "on"
1661}
1662```
1663
16642. `off`, disables format on save:
1665
1666```json [settings]
1667{
1668 "format_on_save": "off"
1669}
1670```
1671
1672## Formatter
1673
1674- Description: How to perform a buffer format.
1675- Setting: `formatter`
1676- Default: `auto`
1677
1678**Options**
1679
16801. To use the current language server, use `"language_server"`:
1681
1682```json [settings]
1683{
1684 "formatter": "language_server"
1685}
1686```
1687
16882. Or to use an external command, use `"external"`. Specify the name of the formatting program to run, and an array of arguments to pass to the program. The buffer's text will be passed to the program on stdin, and the formatted output should be written to stdout. For example, the following command would strip trailing spaces using [`sed(1)`](https://linux.die.net/man/1/sed):
1689
1690```json [settings]
1691{
1692 "formatter": {
1693 "external": {
1694 "command": "sed",
1695 "arguments": ["-e", "s/ *$//"]
1696 }
1697 }
1698}
1699```
1700
17013. External formatters may optionally include a `{buffer_path}` placeholder which at runtime will include the path of the buffer being formatted. Formatters operate by receiving file content via standard input, reformatting it and then outputting it to standard output and so normally don't know the filename of what they are formatting. Tools like Prettier support receiving the file path via a command line argument which can then used to impact formatting decisions.
1702
1703WARNING: `{buffer_path}` should not be used to direct your formatter to read from a filename. Your formatter should only read from standard input and should not read or write files directly.
1704
1705```json [settings]
1706 "formatter": {
1707 "external": {
1708 "command": "prettier",
1709 "arguments": ["--stdin-filepath", "{buffer_path}"]
1710 }
1711 }
1712```
1713
17144. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1715
1716```json [settings]
1717{
1718 "formatter": [
1719 // Use ESLint's --fix:
1720 { "code_action": "source.fixAll.eslint" },
1721 // Organize imports on save:
1722 { "code_action": "source.organizeImports" }
1723 ]
1724}
1725```
1726
17275. Or to use multiple formatters consecutively, use an array of formatters:
1728
1729```json [settings]
1730{
1731 "formatter": [
1732 { "language_server": { "name": "rust-analyzer" } },
1733 {
1734 "external": {
1735 "command": "sed",
1736 "arguments": ["-e", "s/ *$//"]
1737 }
1738 }
1739 ]
1740}
1741```
1742
1743Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1744If any of the formatters fails, the subsequent ones will still be executed.
1745
1746## Auto close
1747
1748- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1749- Setting: `use_autoclose`
1750- Default: `true`
1751
1752**Options**
1753
1754`boolean` values
1755
1756## Always Treat Brackets As Autoclosed
1757
1758- Description: Controls how the editor handles the autoclosed characters.
1759- Setting: `always_treat_brackets_as_autoclosed`
1760- Default: `false`
1761
1762**Options**
1763
1764`boolean` values
1765
1766**Example**
1767
1768If the setting is set to `true`:
1769
17701. Enter in the editor: `)))`
17712. Move the cursor to the start: `^)))`
17723. Enter again: `)))`
1773
1774The result is still `)))` and not `))))))`, which is what it would be by default.
1775
1776## File Scan Exclusions
1777
1778- Setting: `file_scan_exclusions`
1779- 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`.
1780- Default:
1781
1782```json [settings]
1783"file_scan_exclusions": [
1784 "**/.git",
1785 "**/.svn",
1786 "**/.hg",
1787 "**/.jj",
1788 "**/CVS",
1789 "**/.DS_Store",
1790 "**/Thumbs.db",
1791 "**/.classpath",
1792 "**/.settings"
1793],
1794```
1795
1796Note, 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.
1797
1798## File Scan Inclusions
1799
1800- Setting: `file_scan_inclusions`
1801- 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.
1802- Default:
1803
1804```json [settings]
1805"file_scan_inclusions": [".env*"],
1806```
1807
1808## File Types
1809
1810- Setting: `file_types`
1811- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1812- Default:
1813
1814```json [settings]
1815"file_types": {
1816 "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1817 "Shell Script": [".env.*"]
1818}
1819```
1820
1821**Examples**
1822
1823To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1824
1825```json [settings]
1826{
1827 "file_types": {
1828 "C++": ["c"],
1829 "TOML": ["MyLockFile"],
1830 "Dockerfile": ["Dockerfile*"]
1831 }
1832}
1833```
1834
1835## Diagnostics
1836
1837- Description: Configuration for diagnostics-related features.
1838- Setting: `diagnostics`
1839- Default:
1840
1841```json [settings]
1842{
1843 "diagnostics": {
1844 "include_warnings": true,
1845 "inline": {
1846 "enabled": false
1847 },
1848 "update_with_cursor": false,
1849 "primary_only": false,
1850 "use_rendered": false
1851 }
1852}
1853```
1854
1855### Inline Diagnostics
1856
1857- Description: Whether or not to show diagnostics information inline.
1858- Setting: `inline`
1859- Default:
1860
1861```json [settings]
1862{
1863 "diagnostics": {
1864 "inline": {
1865 "enabled": false,
1866 "update_debounce_ms": 150,
1867 "padding": 4,
1868 "min_column": 0,
1869 "max_severity": null
1870 }
1871 }
1872}
1873```
1874
1875**Options**
1876
18771. Enable inline diagnostics.
1878
1879```json [settings]
1880{
1881 "diagnostics": {
1882 "inline": {
1883 "enabled": true
1884 }
1885 }
1886}
1887```
1888
18892. Delay diagnostic updates until some time after the last diagnostic update.
1890
1891```json [settings]
1892{
1893 "diagnostics": {
1894 "inline": {
1895 "enabled": true,
1896 "update_debounce_ms": 150
1897 }
1898 }
1899}
1900```
1901
19023. Set padding between the end of the source line and the start of the diagnostic.
1903
1904```json [settings]
1905{
1906 "diagnostics": {
1907 "inline": {
1908 "enabled": true,
1909 "padding": 4
1910 }
1911 }
1912}
1913```
1914
19154. Horizontally align inline diagnostics at the given column.
1916
1917```json [settings]
1918{
1919 "diagnostics": {
1920 "inline": {
1921 "enabled": true,
1922 "min_column": 80
1923 }
1924 }
1925}
1926```
1927
19285. Show only warning and error diagnostics.
1929
1930```json [settings]
1931{
1932 "diagnostics": {
1933 "inline": {
1934 "enabled": true,
1935 "max_severity": "warning"
1936 }
1937 }
1938}
1939```
1940
1941## Git
1942
1943- Description: Configuration for git-related features.
1944- Setting: `git`
1945- Default:
1946
1947```json [settings]
1948{
1949 "git": {
1950 "git_gutter": "tracked_files",
1951 "inline_blame": {
1952 "enabled": true
1953 },
1954 "branch_picker": {
1955 "show_author_name": true
1956 },
1957 "hunk_style": "staged_hollow"
1958 }
1959}
1960```
1961
1962### Git Gutter
1963
1964- Description: Whether or not to show the git gutter.
1965- Setting: `git_gutter`
1966- Default: `tracked_files`
1967
1968**Options**
1969
19701. Show git gutter in tracked files
1971
1972```json [settings]
1973{
1974 "git": {
1975 "git_gutter": "tracked_files"
1976 }
1977}
1978```
1979
19802. Hide git gutter
1981
1982```json [settings]
1983{
1984 "git": {
1985 "git_gutter": "hide"
1986 }
1987}
1988```
1989
1990### Gutter Debounce
1991
1992- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
1993- Setting: `gutter_debounce`
1994- Default: `null`
1995
1996**Options**
1997
1998`integer` values representing milliseconds
1999
2000Example:
2001
2002```json [settings]
2003{
2004 "git": {
2005 "gutter_debounce": 100
2006 }
2007}
2008```
2009
2010### Inline Git Blame
2011
2012- Description: Whether or not to show git blame information inline, on the currently focused line.
2013- Setting: `inline_blame`
2014- Default:
2015
2016```json [settings]
2017{
2018 "git": {
2019 "inline_blame": {
2020 "enabled": true
2021 }
2022 }
2023}
2024```
2025
2026**Options**
2027
20281. Disable inline git blame:
2029
2030```json [settings]
2031{
2032 "git": {
2033 "inline_blame": {
2034 "enabled": false
2035 }
2036 }
2037}
2038```
2039
20402. Only show inline git blame after a delay (that starts after cursor stops moving):
2041
2042```json [settings]
2043{
2044 "git": {
2045 "inline_blame": {
2046 "delay_ms": 500
2047 }
2048 }
2049}
2050```
2051
20523. Show a commit summary next to the commit date and author:
2053
2054```json [settings]
2055{
2056 "git": {
2057 "inline_blame": {
2058 "show_commit_summary": true
2059 }
2060 }
2061}
2062```
2063
20644. Use this as the minimum column at which to display inline blame information:
2065
2066```json [settings]
2067{
2068 "git": {
2069 "inline_blame": {
2070 "min_column": 80
2071 }
2072 }
2073}
2074```
2075
20765. Set the padding between the end of the line and the inline blame hint, in ems:
2077
2078```json [settings]
2079{
2080 "git": {
2081 "inline_blame": {
2082 "padding": 10
2083 }
2084 }
2085}
2086```
2087
2088### Branch Picker
2089
2090- Description: Configuration related to the branch picker.
2091- Setting: `branch_picker`
2092- Default:
2093
2094```json [settings]
2095{
2096 "git": {
2097 "branch_picker": {
2098 "show_author_name": false
2099 }
2100 }
2101}
2102```
2103
2104**Options**
2105
21061. Show the author name in the branch picker:
2107
2108```json [settings]
2109{
2110 "git": {
2111 "branch_picker": {
2112 "show_author_name": true
2113 }
2114 }
2115}
2116```
2117
2118### Hunk Style
2119
2120- Description: What styling we should use for the diff hunks.
2121- Setting: `hunk_style`
2122- Default:
2123
2124```json [settings]
2125{
2126 "git": {
2127 "hunk_style": "staged_hollow"
2128 }
2129}
2130```
2131
2132**Options**
2133
21341. Show the staged hunks faded out and with a border:
2135
2136```json [settings]
2137{
2138 "git": {
2139 "hunk_style": "staged_hollow"
2140 }
2141}
2142```
2143
21442. Show unstaged hunks faded out and with a border:
2145
2146```json [settings]
2147{
2148 "git": {
2149 "hunk_style": "unstaged_hollow"
2150 }
2151}
2152```
2153
2154## Go to Definition Fallback
2155
2156- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2157- Setting: `go_to_definition_fallback`
2158- Default: `"find_all_references"`
2159
2160**Options**
2161
21621. Do nothing:
2163
2164```json [settings]
2165{
2166 "go_to_definition_fallback": "none"
2167}
2168```
2169
21702. Find references for the same symbol (default):
2171
2172```json [settings]
2173{
2174 "go_to_definition_fallback": "find_all_references"
2175}
2176```
2177
2178## Hard Tabs
2179
2180- Description: Whether to indent lines using tab characters or multiple spaces.
2181- Setting: `hard_tabs`
2182- Default: `false`
2183
2184**Options**
2185
2186`boolean` values
2187
2188## Helix Mode
2189
2190- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2191- Setting: `helix_mode`
2192- Default: `false`
2193
2194**Options**
2195
2196`boolean` values
2197
2198## Indent Guides
2199
2200- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2201- Setting: `indent_guides`
2202- Default:
2203
2204```json [settings]
2205{
2206 "indent_guides": {
2207 "enabled": true,
2208 "line_width": 1,
2209 "active_line_width": 1,
2210 "coloring": "fixed",
2211 "background_coloring": "disabled"
2212 }
2213}
2214```
2215
2216**Options**
2217
22181. Disable indent guides
2219
2220```json [settings]
2221{
2222 "indent_guides": {
2223 "enabled": false
2224 }
2225}
2226```
2227
22282. Enable indent guides for a specific language.
2229
2230```json [settings]
2231{
2232 "languages": {
2233 "Python": {
2234 "indent_guides": {
2235 "enabled": true
2236 }
2237 }
2238 }
2239}
2240```
2241
22423. Enable indent aware coloring ("rainbow indentation").
2243 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.
2244
2245```json [settings]
2246{
2247 "indent_guides": {
2248 "enabled": true,
2249 "coloring": "indent_aware"
2250 }
2251}
2252```
2253
22544. Enable indent aware background coloring ("rainbow indentation").
2255 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.
2256
2257```json [settings]
2258{
2259 "indent_guides": {
2260 "enabled": true,
2261 "coloring": "indent_aware",
2262 "background_coloring": "indent_aware"
2263 }
2264}
2265```
2266
2267## Hover Popover Enabled
2268
2269- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2270- Setting: `hover_popover_enabled`
2271- Default: `true`
2272
2273**Options**
2274
2275`boolean` values
2276
2277## Hover Popover Delay
2278
2279- Description: Time to wait in milliseconds before showing the informational hover box.
2280- Setting: `hover_popover_delay`
2281- Default: `300`
2282
2283**Options**
2284
2285`integer` values representing milliseconds
2286
2287## Icon Theme
2288
2289- 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.
2290- Setting: `icon_theme`
2291- Default: `Zed (Default)`
2292
2293### Icon Theme Object
2294
2295- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2296- Setting: `icon_theme`
2297- Default:
2298
2299```json [settings]
2300"icon_theme": {
2301 "mode": "system",
2302 "dark": "Zed (Default)",
2303 "light": "Zed (Default)"
2304},
2305```
2306
2307### Mode
2308
2309- Description: Specify the icon theme mode.
2310- Setting: `mode`
2311- Default: `system`
2312
2313**Options**
2314
23151. Set the icon theme to dark mode
2316
2317```json [settings]
2318{
2319 "mode": "dark"
2320}
2321```
2322
23232. Set the icon theme to light mode
2324
2325```json [settings]
2326{
2327 "mode": "light"
2328}
2329```
2330
23313. Set the icon theme to system mode
2332
2333```json [settings]
2334{
2335 "mode": "system"
2336}
2337```
2338
2339### Dark
2340
2341- Description: The name of the dark icon theme.
2342- Setting: `dark`
2343- Default: `Zed (Default)`
2344
2345**Options**
2346
2347Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2348
2349### Light
2350
2351- Description: The name of the light icon theme.
2352- Setting: `light`
2353- Default: `Zed (Default)`
2354
2355**Options**
2356
2357Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2358
2359## Image Viewer
2360
2361- Description: Settings for image viewer functionality
2362- Setting: `image_viewer`
2363- Default:
2364
2365```json [settings]
2366{
2367 "image_viewer": {
2368 "unit": "binary"
2369 }
2370}
2371```
2372
2373**Options**
2374
2375### Unit
2376
2377- Description: The unit for image file sizes
2378- Setting: `unit`
2379- Default: `"binary"`
2380
2381**Options**
2382
23831. Use binary units (KiB, MiB):
2384
2385```json [settings]
2386{
2387 "image_viewer": {
2388 "unit": "binary"
2389 }
2390}
2391```
2392
23932. Use decimal units (KB, MB):
2394
2395```json [settings]
2396{
2397 "image_viewer": {
2398 "unit": "decimal"
2399 }
2400}
2401```
2402
2403## Inlay hints
2404
2405- Description: Configuration for displaying extra text with hints in the editor.
2406- Setting: `inlay_hints`
2407- Default:
2408
2409```json [settings]
2410"inlay_hints": {
2411 "enabled": false,
2412 "show_type_hints": true,
2413 "show_parameter_hints": true,
2414 "show_other_hints": true,
2415 "show_background": false,
2416 "edit_debounce_ms": 700,
2417 "scroll_debounce_ms": 50,
2418 "toggle_on_modifiers_press": null
2419}
2420```
2421
2422**Options**
2423
2424Inlay hints querying consists of two parts: editor (client) and LSP server.
2425With 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.
2426At 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.
2427
2428The following languages have inlay hints preconfigured by Zed:
2429
2430- [Go](https://docs.zed.dev/languages/go)
2431- [Rust](https://docs.zed.dev/languages/rust)
2432- [Svelte](https://docs.zed.dev/languages/svelte)
2433- [TypeScript](https://docs.zed.dev/languages/typescript)
2434
2435Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2436
2437Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2438Settings-related hint updates are not debounced.
2439
2440All possible config values for `toggle_on_modifiers_press` are:
2441
2442```json [settings]
2443"inlay_hints": {
2444 "toggle_on_modifiers_press": {
2445 "control": true,
2446 "shift": true,
2447 "alt": true,
2448 "platform": true,
2449 "function": true
2450 }
2451}
2452```
2453
2454Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2455
2456## Journal
2457
2458- Description: Configuration for the journal.
2459- Setting: `journal`
2460- Default:
2461
2462```json [settings]
2463"journal": {
2464 "path": "~",
2465 "hour_format": "hour12"
2466}
2467```
2468
2469### Path
2470
2471- Description: The path of the directory where journal entries are stored.
2472- Setting: `path`
2473- Default: `~`
2474
2475**Options**
2476
2477`string` values
2478
2479### Hour Format
2480
2481- Description: The format to use for displaying hours in the journal.
2482- Setting: `hour_format`
2483- Default: `hour12`
2484
2485**Options**
2486
24871. 12-hour format:
2488
2489```json [settings]
2490{
2491 "hour_format": "hour12"
2492}
2493```
2494
24952. 24-hour format:
2496
2497```json [settings]
2498{
2499 "hour_format": "hour24"
2500}
2501```
2502
2503## JSX Tag Auto Close
2504
2505- Description: Whether to automatically close JSX tags
2506- Setting: `jsx_tag_auto_close`
2507- Default:
2508
2509```json [settings]
2510{
2511 "jsx_tag_auto_close": {
2512 "enabled": true
2513 }
2514}
2515```
2516
2517**Options**
2518
2519- `enabled`: Whether to enable automatic JSX tag closing
2520
2521## Languages
2522
2523- Description: Configuration for specific languages.
2524- Setting: `languages`
2525- Default: `null`
2526
2527**Options**
2528
2529To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2530
2531```json [settings]
2532"languages": {
2533 "C": {
2534 "format_on_save": "off",
2535 "preferred_line_length": 64,
2536 "soft_wrap": "preferred_line_length"
2537 },
2538 "JSON": {
2539 "tab_size": 4
2540 }
2541}
2542```
2543
2544The following settings can be overridden for each specific language:
2545
2546- [`enable_language_server`](#enable-language-server)
2547- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2548- [`format_on_save`](#format-on-save)
2549- [`formatter`](#formatter)
2550- [`hard_tabs`](#hard-tabs)
2551- [`preferred_line_length`](#preferred-line-length)
2552- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2553- [`show_edit_predictions`](#show-edit-predictions)
2554- [`show_whitespaces`](#show-whitespaces)
2555- [`whitespace_map`](#whitespace-map)
2556- [`soft_wrap`](#soft-wrap)
2557- [`tab_size`](#tab-size)
2558- [`use_autoclose`](#use-autoclose)
2559- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2560
2561These values take in the same options as the root-level settings with the same name.
2562
2563## Language Models
2564
2565- Description: Configuration for language model providers
2566- Setting: `language_models`
2567- Default:
2568
2569```json [settings]
2570{
2571 "language_models": {
2572 "anthropic": {
2573 "api_url": "https://api.anthropic.com"
2574 },
2575 "google": {
2576 "api_url": "https://generativelanguage.googleapis.com"
2577 },
2578 "ollama": {
2579 "api_url": "http://localhost:11434"
2580 },
2581 "openai": {
2582 "api_url": "https://api.openai.com/v1"
2583 }
2584 }
2585}
2586```
2587
2588**Options**
2589
2590Configuration for various AI model providers including API URLs and authentication settings.
2591
2592## Line Indicator Format
2593
2594- Description: Format for line indicator in the status bar
2595- Setting: `line_indicator_format`
2596- Default: `"short"`
2597
2598**Options**
2599
26001. Short format:
2601
2602```json [settings]
2603{
2604 "line_indicator_format": "short"
2605}
2606```
2607
26082. Long format:
2609
2610```json [settings]
2611{
2612 "line_indicator_format": "long"
2613}
2614```
2615
2616## Linked Edits
2617
2618- 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.
2619- Setting: `linked_edits`
2620- Default: `true`
2621
2622**Options**
2623
2624`boolean` values
2625
2626## LSP Document Colors
2627
2628- Description: Whether to show document color information from the language server
2629- Setting: `lsp_document_colors`
2630- Default: `true`
2631
2632**Options**
2633
2634`boolean` values
2635
2636## Max Tabs
2637
2638- Description: Maximum number of tabs to show in the tab bar
2639- Setting: `max_tabs`
2640- Default: `null`
2641
2642**Options**
2643
2644Positive `integer` values or `null` for unlimited tabs
2645
2646## Middle Click Paste (Linux only)
2647
2648- Description: Enable middle-click paste on Linux
2649- Setting: `middle_click_paste`
2650- Default: `true`
2651
2652**Options**
2653
2654`boolean` values
2655
2656## Multi Cursor Modifier
2657
2658- 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.
2659- Setting: `multi_cursor_modifier`
2660- Default: `alt`
2661
2662**Options**
2663
26641. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2665
2666```json [settings]
2667{
2668 "multi_cursor_modifier": "alt"
2669}
2670```
2671
26722. Maps `Control` on Linux and Windows and to `Command` on macOS:
2673
2674```json [settings]
2675{
2676 "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2677}
2678```
2679
2680## Node
2681
2682- Description: Configuration for Node.js integration
2683- Setting: `node`
2684- Default:
2685
2686```json [settings]
2687{
2688 "node": {
2689 "ignore_system_version": false,
2690 "path": null,
2691 "npm_path": null
2692 }
2693}
2694```
2695
2696**Options**
2697
2698- `ignore_system_version`: Whether to ignore the system Node.js version
2699- `path`: Custom path to Node.js binary
2700- `npm_path`: Custom path to npm binary
2701
2702## Network Proxy
2703
2704- Description: Configure a network proxy for Zed.
2705- Setting: `proxy`
2706- Default: `null`
2707
2708**Options**
2709
2710The proxy setting must contain a URL to the proxy.
2711
2712The following URI schemes are supported:
2713
2714- `http`
2715- `https`
2716- `socks4` - SOCKS4 proxy with local DNS
2717- `socks4a` - SOCKS4 proxy with remote DNS
2718- `socks5` - SOCKS5 proxy with local DNS
2719- `socks5h` - SOCKS5 proxy with remote DNS
2720
2721`http` will be used when no scheme is specified.
2722
2723By 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`.
2724
2725For example, to set an `http` proxy, add the following to your settings:
2726
2727```json [settings]
2728{
2729 "proxy": "http://127.0.0.1:10809"
2730}
2731```
2732
2733Or to set a `socks5` proxy:
2734
2735```json [settings]
2736{
2737 "proxy": "socks5h://localhost:10808"
2738}
2739```
2740
2741If 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.
2742
2743## On Last Window Closed
2744
2745- Description: What to do when the last window is closed
2746- Setting: `on_last_window_closed`
2747- Default: `"platform_default"`
2748
2749**Options**
2750
27511. Use platform default behavior:
2752
2753```json [settings]
2754{
2755 "on_last_window_closed": "platform_default"
2756}
2757```
2758
27592. Always quit the application:
2760
2761```json [settings]
2762{
2763 "on_last_window_closed": "quit_app"
2764}
2765```
2766
2767## Profiles
2768
2769- Description: Configuration profiles that can be applied on top of existing settings
2770- Setting: `profiles`
2771- Default: `{}`
2772
2773**Options**
2774
2775Configuration object for defining settings profiles. Example:
2776
2777```json [settings]
2778{
2779 "profiles": {
2780 "presentation": {
2781 "buffer_font_size": 20,
2782 "ui_font_size": 18,
2783 "theme": "One Light"
2784 }
2785 }
2786}
2787```
2788
2789## Preview tabs
2790
2791- Description:
2792 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. \
2793 There are several ways to convert a preview tab into a regular tab:
2794
2795 - Double-clicking on the file
2796 - Double-clicking on the tab header
2797 - Using the {#action project_panel::OpenPermanent} action
2798 - Editing the file
2799 - Dragging the file to a different pane
2800
2801- Setting: `preview_tabs`
2802- Default:
2803
2804```json [settings]
2805"preview_tabs": {
2806 "enabled": true,
2807 "enable_preview_from_file_finder": false,
2808 "enable_preview_from_code_navigation": false,
2809}
2810```
2811
2812### Enable preview from file finder
2813
2814- Description: Determines whether to open files in preview mode when selected from the file finder.
2815- Setting: `enable_preview_from_file_finder`
2816- Default: `false`
2817
2818**Options**
2819
2820`boolean` values
2821
2822### Enable preview from code navigation
2823
2824- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
2825- Setting: `enable_preview_from_code_navigation`
2826- Default: `false`
2827
2828**Options**
2829
2830`boolean` values
2831
2832## File Finder
2833
2834### File Icons
2835
2836- Description: Whether to show file icons in the file finder.
2837- Setting: `file_icons`
2838- Default: `true`
2839
2840### Modal Max Width
2841
2842- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2843- Setting: `modal_max_width`
2844- Default: `small`
2845
2846### Skip Focus For Active In Search
2847
2848- Description: Determines whether the file finder should skip focus for the active file in search results.
2849- Setting: `skip_focus_for_active_in_search`
2850- Default: `true`
2851
2852## Pane Split Direction Horizontal
2853
2854- Description: The direction that you want to split panes horizontally
2855- Setting: `pane_split_direction_horizontal`
2856- Default: `"up"`
2857
2858**Options**
2859
28601. Split upward:
2861
2862```json [settings]
2863{
2864 "pane_split_direction_horizontal": "up"
2865}
2866```
2867
28682. Split downward:
2869
2870```json [settings]
2871{
2872 "pane_split_direction_horizontal": "down"
2873}
2874```
2875
2876## Pane Split Direction Vertical
2877
2878- Description: The direction that you want to split panes vertically
2879- Setting: `pane_split_direction_vertical`
2880- Default: `"left"`
2881
2882**Options**
2883
28841. Split to the left:
2885
2886```json [settings]
2887{
2888 "pane_split_direction_vertical": "left"
2889}
2890```
2891
28922. Split to the right:
2893
2894```json [settings]
2895{
2896 "pane_split_direction_vertical": "right"
2897}
2898```
2899
2900## Preferred Line Length
2901
2902- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
2903- Setting: `preferred_line_length`
2904- Default: `80`
2905
2906**Options**
2907
2908`integer` values
2909
2910## Private Files
2911
2912- Description: Globs to match against file paths to determine if a file is private
2913- Setting: `private_files`
2914- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
2915
2916**Options**
2917
2918List of `string` glob patterns
2919
2920## Projects Online By Default
2921
2922- Description: Whether or not to show the online projects view by default.
2923- Setting: `projects_online_by_default`
2924- Default: `true`
2925
2926**Options**
2927
2928`boolean` values
2929
2930## Read SSH Config
2931
2932- Description: Whether to read SSH configuration files
2933- Setting: `read_ssh_config`
2934- Default: `true`
2935
2936**Options**
2937
2938`boolean` values
2939
2940## Redact Private Values
2941
2942- Description: Hide the values of variables from visual display in private files
2943- Setting: `redact_private_values`
2944- Default: `false`
2945
2946**Options**
2947
2948`boolean` values
2949
2950## Relative Line Numbers
2951
2952- Description: Whether to show relative line numbers in the gutter
2953- Setting: `relative_line_numbers`
2954- Default: `false`
2955
2956**Options**
2957
2958`boolean` values
2959
2960## Remove Trailing Whitespace On Save
2961
2962- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
2963- Setting: `remove_trailing_whitespace_on_save`
2964- Default: `true`
2965
2966**Options**
2967
2968`boolean` values
2969
2970## Resize All Panels In Dock
2971
2972- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
2973- Setting: `resize_all_panels_in_dock`
2974- Default: `["left"]`
2975
2976**Options**
2977
2978List of strings containing any combination of:
2979
2980- `"left"`: Resize left dock panels together
2981- `"right"`: Resize right dock panels together
2982- `"bottom"`: Resize bottom dock panels together
2983
2984## Restore on File Reopen
2985
2986- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
2987- Setting: `restore_on_file_reopen`
2988- Default: `true`
2989
2990**Options**
2991
2992`boolean` values
2993
2994## Restore on Startup
2995
2996- Description: Controls session restoration on startup.
2997- Setting: `restore_on_startup`
2998- Default: `last_session`
2999
3000**Options**
3001
30021. Restore all workspaces that were open when quitting Zed:
3003
3004```json [settings]
3005{
3006 "restore_on_startup": "last_session"
3007}
3008```
3009
30102. Restore the workspace that was closed last:
3011
3012```json [settings]
3013{
3014 "restore_on_startup": "last_workspace"
3015}
3016```
3017
30183. Always start with an empty editor:
3019
3020```json [settings]
3021{
3022 "restore_on_startup": "none"
3023}
3024```
3025
3026## Scroll Beyond Last Line
3027
3028- Description: Whether the editor will scroll beyond the last line
3029- Setting: `scroll_beyond_last_line`
3030- Default: `"one_page"`
3031
3032**Options**
3033
30341. Scroll one page beyond the last line by one page:
3035
3036```json [settings]
3037{
3038 "scroll_beyond_last_line": "one_page"
3039}
3040```
3041
30422. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3043
3044```json [settings]
3045{
3046 "scroll_beyond_last_line": "vertical_scroll_margin"
3047}
3048```
3049
30503. The editor will not scroll beyond the last line:
3051
3052```json [settings]
3053{
3054 "scroll_beyond_last_line": "off"
3055}
3056```
3057
3058**Options**
3059
3060`boolean` values
3061
3062## Scroll Sensitivity
3063
3064- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3065- Setting: `scroll_sensitivity`
3066- Default: `1.0`
3067
3068**Options**
3069
3070Positive `float` values
3071
3072### Fast Scroll Sensitivity
3073
3074- 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.
3075- Setting: `fast_scroll_sensitivity`
3076- Default: `4.0`
3077
3078**Options**
3079
3080Positive `float` values
3081
3082### Horizontal Scroll Margin
3083
3084- Description: The number of characters to keep on either side when scrolling with the mouse
3085- Setting: `horizontal_scroll_margin`
3086- Default: `5`
3087
3088**Options**
3089
3090Non-negative `integer` values
3091
3092### Vertical Scroll Margin
3093
3094- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3095- Setting: `vertical_scroll_margin`
3096- Default: `3`
3097
3098**Options**
3099
3100Non-negative `integer` values
3101
3102## Search
3103
3104- Description: Search options to enable by default when opening new project and buffer searches.
3105- Setting: `search`
3106- Default:
3107
3108```json [settings]
3109"search": {
3110 "whole_word": false,
3111 "case_sensitive": false,
3112 "include_ignored": false,
3113 "regex": false
3114},
3115```
3116
3117## Search Wrap
3118
3119- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3120- Setting: `search_wrap`
3121- Default: `true`
3122
3123## Seed Search Query From Cursor
3124
3125- Description: When to populate a new search's query based on the text under the cursor.
3126- Setting: `seed_search_query_from_cursor`
3127- Default: `always`
3128
3129**Options**
3130
31311. `always` always populate the search query with the word under the cursor
31322. `selection` only populate the search query when there is text selected
31333. `never` never populate the search query
3134
3135## Use Smartcase Search
3136
3137- 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. \
3138 This applies to both in-file searches and project-wide searches.
3139- Setting: `use_smartcase_search`
3140- Default: `false`
3141
3142**Options**
3143
3144`boolean` values
3145
3146Examples:
3147
3148- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3149- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3150
3151## Show Call Status Icon
3152
3153- Description: Whether or not to show the call status icon in the status bar.
3154- Setting: `show_call_status_icon`
3155- Default: `true`
3156
3157**Options**
3158
3159`boolean` values
3160
3161## Completions
3162
3163- Description: Controls how completions are processed for this language.
3164- Setting: `completions`
3165- Default:
3166
3167```json [settings]
3168{
3169 "completions": {
3170 "words": "fallback",
3171 "words_min_length": 3,
3172 "lsp": true,
3173 "lsp_fetch_timeout_ms": 0,
3174 "lsp_insert_mode": "replace_suffix"
3175 }
3176}
3177```
3178
3179### Words
3180
3181- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3182- Setting: `words`
3183- Default: `fallback`
3184
3185**Options**
3186
31871. `enabled` - Always fetch document's words for completions along with LSP completions
31882. `fallback` - Only if LSP response errors or times out, use document's words to show completions
31893. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3190
3191### Min Words Query Length
3192
3193- Description: Minimum number of characters required to automatically trigger word-based completions.
3194 Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3195- Setting: `words_min_length`
3196- Default: `3`
3197
3198**Options**
3199
3200Positive integer values
3201
3202### LSP
3203
3204- Description: Whether to fetch LSP completions or not.
3205- Setting: `lsp`
3206- Default: `true`
3207
3208**Options**
3209
3210`boolean` values
3211
3212### LSP Fetch Timeout (ms)
3213
3214- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3215- Setting: `lsp_fetch_timeout_ms`
3216- Default: `0`
3217
3218**Options**
3219
3220`integer` values representing milliseconds
3221
3222### LSP Insert Mode
3223
3224- Description: Controls what range to replace when accepting LSP completions.
3225- Setting: `lsp_insert_mode`
3226- Default: `replace_suffix`
3227
3228**Options**
3229
32301. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
32312. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
32323. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
32334. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3234
3235## Show Completions On Input
3236
3237- Description: Whether or not to show completions as you type.
3238- Setting: `show_completions_on_input`
3239- Default: `true`
3240
3241**Options**
3242
3243`boolean` values
3244
3245## Show Completion Documentation
3246
3247- Description: Whether to display inline and alongside documentation for items in the completions menu.
3248- Setting: `show_completion_documentation`
3249- Default: `true`
3250
3251**Options**
3252
3253`boolean` values
3254
3255## Show Edit Predictions
3256
3257- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3258- Setting: `show_edit_predictions`
3259- Default: `true`
3260
3261**Options**
3262
3263`boolean` values
3264
3265## Show Whitespaces
3266
3267- Description: Whether or not to render whitespace characters in the editor.
3268- Setting: `show_whitespaces`
3269- Default: `selection`
3270
3271**Options**
3272
32731. `all`
32742. `selection`
32753. `none`
32764. `boundary`
3277
3278## Whitespace Map
3279
3280- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3281- Setting: `whitespace_map`
3282- Default:
3283
3284```json [settings]
3285{
3286 "whitespace_map": {
3287 "space": "•",
3288 "tab": "→"
3289 }
3290}
3291```
3292
3293## Soft Wrap
3294
3295- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3296- Setting: `soft_wrap`
3297- Default: `none`
3298
3299**Options**
3300
33011. `none` to avoid wrapping generally, unless the line is too long
33022. `prefer_line` (deprecated, same as `none`)
33033. `editor_width` to wrap lines that overflow the editor width
33044. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
33055. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3306
3307## Show Wrap Guides
3308
3309- 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.
3310- Setting: `show_wrap_guides`
3311- Default: `true`
3312
3313**Options**
3314
3315`boolean` values
3316
3317## Use On Type Format
3318
3319- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3320- Setting: `use_on_type_format`
3321- Default: `true`
3322
3323**Options**
3324
3325`boolean` values
3326
3327## Use Auto Surround
3328
3329- 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 ().
3330- Setting: `use_auto_surround`
3331- Default: `true`
3332
3333**Options**
3334
3335`boolean` values
3336
3337## Use System Path Prompts
3338
3339- 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.
3340- Setting: `use_system_path_prompts`
3341- Default: `true`
3342
3343**Options**
3344
3345`boolean` values
3346
3347## Use System Prompts
3348
3349- 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.
3350- Setting: `use_system_prompts`
3351- Default: `true`
3352
3353**Options**
3354
3355`boolean` values
3356
3357## Wrap Guides (Vertical Rulers)
3358
3359- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3360- Setting: `wrap_guides`
3361- Default: []
3362
3363**Options**
3364
3365List of `integer` column numbers
3366
3367## Tab Size
3368
3369- Description: The number of spaces to use for each tab character.
3370- Setting: `tab_size`
3371- Default: `4`
3372
3373**Options**
3374
3375`integer` values
3376
3377## Tasks
3378
3379- Description: Configuration for tasks that can be run within Zed
3380- Setting: `tasks`
3381- Default:
3382
3383```json [settings]
3384{
3385 "tasks": {
3386 "variables": {},
3387 "enabled": true,
3388 "prefer_lsp": false
3389 }
3390}
3391```
3392
3393**Options**
3394
3395- `variables`: Custom variables for task configuration
3396- `enabled`: Whether tasks are enabled
3397- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3398
3399## Telemetry
3400
3401- Description: Control what info is collected by Zed.
3402- Setting: `telemetry`
3403- Default:
3404
3405```json [settings]
3406"telemetry": {
3407 "diagnostics": true,
3408 "metrics": true
3409},
3410```
3411
3412**Options**
3413
3414### Diagnostics
3415
3416- Description: Setting for sending debug-related data, such as crash reports.
3417- Setting: `diagnostics`
3418- Default: `true`
3419
3420**Options**
3421
3422`boolean` values
3423
3424### Metrics
3425
3426- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3427- Setting: `metrics`
3428- Default: `true`
3429
3430**Options**
3431
3432`boolean` values
3433
3434## Terminal
3435
3436- Description: Configuration for the terminal.
3437- Setting: `terminal`
3438- Default:
3439
3440```json [settings]
3441{
3442 "terminal": {
3443 "alternate_scroll": "off",
3444 "blinking": "terminal_controlled",
3445 "copy_on_select": false,
3446 "keep_selection_on_copy": true,
3447 "dock": "bottom",
3448 "default_width": 640,
3449 "default_height": 320,
3450 "detect_venv": {
3451 "on": {
3452 "directories": [".env", "env", ".venv", "venv"],
3453 "activate_script": "default"
3454 }
3455 },
3456 "env": {},
3457 "font_family": null,
3458 "font_features": null,
3459 "font_size": null,
3460 "line_height": "comfortable",
3461 "minimum_contrast": 45,
3462 "option_as_meta": false,
3463 "button": true,
3464 "shell": "system",
3465 "toolbar": {
3466 "breadcrumbs": false
3467 },
3468 "working_directory": "current_project_directory",
3469 "scrollbar": {
3470 "show": null
3471 }
3472 }
3473}
3474```
3475
3476### Terminal: Dock
3477
3478- Description: Control the position of the dock
3479- Setting: `dock`
3480- Default: `bottom`
3481
3482**Options**
3483
3484`"bottom"`, `"left"` or `"right"`
3485
3486### Terminal: Alternate Scroll
3487
3488- 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.
3489- Setting: `alternate_scroll`
3490- Default: `off`
3491
3492**Options**
3493
34941. Default alternate scroll mode to off
3495
3496```json [settings]
3497{
3498 "terminal": {
3499 "alternate_scroll": "off"
3500 }
3501}
3502```
3503
35042. Default alternate scroll mode to on
3505
3506```json [settings]
3507{
3508 "terminal": {
3509 "alternate_scroll": "on"
3510 }
3511}
3512```
3513
3514### Terminal: Blinking
3515
3516- Description: Set the cursor blinking behavior in the terminal
3517- Setting: `blinking`
3518- Default: `terminal_controlled`
3519
3520**Options**
3521
35221. Never blink the cursor, ignore the terminal mode
3523
3524```json [settings]
3525{
3526 "terminal": {
3527 "blinking": "off"
3528 }
3529}
3530```
3531
35322. Default the cursor blink to off, but allow the terminal to turn blinking on
3533
3534```json [settings]
3535{
3536 "terminal": {
3537 "blinking": "terminal_controlled"
3538 }
3539}
3540```
3541
35423. Always blink the cursor, ignore the terminal mode
3543
3544```json [settings]
3545{
3546 "terminal": {
3547 "blinking": "on"
3548 }
3549}
3550```
3551
3552### Terminal: Copy On Select
3553
3554- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3555- Setting: `copy_on_select`
3556- Default: `false`
3557
3558**Options**
3559
3560`boolean` values
3561
3562**Example**
3563
3564```json [settings]
3565{
3566 "terminal": {
3567 "copy_on_select": true
3568 }
3569}
3570```
3571
3572### Terminal: Cursor Shape
3573
3574- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3575- Setting: `cursor_shape`
3576- Default: `null` (defaults to block)
3577
3578**Options**
3579
35801. A block that surrounds the following character
3581
3582```json [settings]
3583{
3584 "terminal": {
3585 "cursor_shape": "block"
3586 }
3587}
3588```
3589
35902. A vertical bar
3591
3592```json [settings]
3593{
3594 "terminal": {
3595 "cursor_shape": "bar"
3596 }
3597}
3598```
3599
36003. An underline / underscore that runs along the following character
3601
3602```json [settings]
3603{
3604 "terminal": {
3605 "cursor_shape": "underline"
3606 }
3607}
3608```
3609
36104. A box drawn around the following character
3611
3612```json [settings]
3613{
3614 "terminal": {
3615 "cursor_shape": "hollow"
3616 }
3617}
3618```
3619
3620### Terminal: Keep Selection On Copy
3621
3622- Description: Whether or not to keep the selection in the terminal after copying text.
3623- Setting: `keep_selection_on_copy`
3624- Default: `true`
3625
3626**Options**
3627
3628`boolean` values
3629
3630**Example**
3631
3632```json [settings]
3633{
3634 "terminal": {
3635 "keep_selection_on_copy": false
3636 }
3637}
3638```
3639
3640### Terminal: Env
3641
3642- 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
3643- Setting: `env`
3644- Default: `{}`
3645
3646**Example**
3647
3648```json [settings]
3649{
3650 "terminal": {
3651 "env": {
3652 "ZED": "1",
3653 "KEY": "value1:value2"
3654 }
3655 }
3656}
3657```
3658
3659### Terminal: Font Size
3660
3661- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3662- Setting: `font_size`
3663- Default: `null`
3664
3665**Options**
3666
3667`integer` values
3668
3669```json [settings]
3670{
3671 "terminal": {
3672 "font_size": 15
3673 }
3674}
3675```
3676
3677### Terminal: Font Family
3678
3679- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3680- Setting: `font_family`
3681- Default: `null`
3682
3683**Options**
3684
3685The name of any font family installed on the user's system
3686
3687```json [settings]
3688{
3689 "terminal": {
3690 "font_family": "Berkeley Mono"
3691 }
3692}
3693```
3694
3695### Terminal: Font Features
3696
3697- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3698- Setting: `font_features`
3699- Default: `null`
3700- Platform: macOS and Windows.
3701
3702**Options**
3703
3704See Buffer Font Features
3705
3706```json [settings]
3707{
3708 "terminal": {
3709 "font_features": {
3710 "calt": false
3711 // See Buffer Font Features for more features
3712 }
3713 }
3714}
3715```
3716
3717### Terminal: Line Height
3718
3719- Description: Set the terminal's line height.
3720- Setting: `line_height`
3721- Default: `standard`
3722
3723**Options**
3724
37251. Use a line height that's `comfortable` for reading, 1.618.
3726
3727```json [settings]
3728{
3729 "terminal": {
3730 "line_height": "comfortable"
3731 }
3732}
3733```
3734
37352. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3736
3737```json [settings]
3738{
3739 "terminal": {
3740 "line_height": "standard"
3741 }
3742}
3743```
3744
37453. Use a custom line height.
3746
3747```json [settings]
3748{
3749 "terminal": {
3750 "line_height": {
3751 "custom": 2
3752 }
3753 }
3754}
3755```
3756
3757### Terminal: Minimum Contrast
3758
3759- 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.
3760- Setting: `minimum_contrast`
3761- Default: `45`
3762
3763**Options**
3764
3765`integer` values from 0 to 106. Common recommended values:
3766
3767- `0`: No contrast adjustment
3768- `45`: Minimum for large fluent text (default)
3769- `60`: Minimum for other content text
3770- `75`: Minimum for body text
3771- `90`: Preferred for body text
3772
3773```json [settings]
3774{
3775 "terminal": {
3776 "minimum_contrast": 45
3777 }
3778}
3779```
3780
3781### Terminal: Option As Meta
3782
3783- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
3784- Setting: `option_as_meta`
3785- Default: `false`
3786
3787**Options**
3788
3789`boolean` values
3790
3791```json [settings]
3792{
3793 "terminal": {
3794 "option_as_meta": true
3795 }
3796}
3797```
3798
3799### Terminal: Shell
3800
3801- Description: What shell to use when launching the terminal.
3802- Setting: `shell`
3803- Default: `system`
3804
3805**Options**
3806
38071. Use the system's default terminal configuration (usually the `/etc/passwd` file).
3808
3809```json [settings]
3810{
3811 "terminal": {
3812 "shell": "system"
3813 }
3814}
3815```
3816
38172. A program to launch:
3818
3819```json [settings]
3820{
3821 "terminal": {
3822 "shell": {
3823 "program": "sh"
3824 }
3825 }
3826}
3827```
3828
38293. A program with arguments:
3830
3831```json [settings]
3832{
3833 "terminal": {
3834 "shell": {
3835 "with_arguments": {
3836 "program": "/bin/bash",
3837 "args": ["--login"]
3838 }
3839 }
3840 }
3841}
3842```
3843
3844## Terminal: Detect Virtual Environments {#terminal-detect_venv}
3845
3846- 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.
3847- Setting: `detect_venv`
3848- Default:
3849
3850```json [settings]
3851{
3852 "terminal": {
3853 "detect_venv": {
3854 "on": {
3855 // Default directories to search for virtual environments, relative
3856 // to the current working directory. We recommend overriding this
3857 // in your project's settings, rather than globally.
3858 "directories": [".env", "env", ".venv", "venv"],
3859 // Can also be `csh`, `fish`, and `nushell`
3860 "activate_script": "default"
3861 }
3862 }
3863 }
3864}
3865```
3866
3867Disable with:
3868
3869```json [settings]
3870{
3871 "terminal": {
3872 "detect_venv": "off"
3873 }
3874}
3875```
3876
3877## Terminal: Toolbar
3878
3879- Description: Whether or not to show various elements in the terminal toolbar.
3880- Setting: `toolbar`
3881- Default:
3882
3883```json [settings]
3884{
3885 "terminal": {
3886 "toolbar": {
3887 "breadcrumbs": false
3888 }
3889 }
3890}
3891```
3892
3893**Options**
3894
3895At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
3896
3897If the terminal title is empty, the breadcrumbs won't be shown.
3898
3899The shell running in the terminal needs to be configured to emit the title.
3900
3901Example command to set the title: `echo -e "\e]2;New Title\007";`
3902
3903### Terminal: Button
3904
3905- Description: Control to show or hide the terminal button in the status bar
3906- Setting: `button`
3907- Default: `true`
3908
3909**Options**
3910
3911`boolean` values
3912
3913```json [settings]
3914{
3915 "terminal": {
3916 "button": false
3917 }
3918}
3919```
3920
3921### Terminal: Working Directory
3922
3923- Description: What working directory to use when launching the terminal.
3924- Setting: `working_directory`
3925- Default: `"current_project_directory"`
3926
3927**Options**
3928
39291. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
3930
3931```json [settings]
3932{
3933 "terminal": {
3934 "working_directory": "current_project_directory"
3935 }
3936}
3937```
3938
39392. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
3940
3941```json [settings]
3942{
3943 "terminal": {
3944 "working_directory": "first_project_directory"
3945 }
3946}
3947```
3948
39493. Always use this platform's home directory (if we can find it)
3950
3951```json [settings]
3952{
3953 "terminal": {
3954 "working_directory": "always_home"
3955 }
3956}
3957```
3958
39594. 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.
3960
3961```json [settings]
3962{
3963 "terminal": {
3964 "working_directory": {
3965 "always": {
3966 "directory": "~/zed/projects/"
3967 }
3968 }
3969 }
3970}
3971```
3972
3973## REPL
3974
3975- Description: Repl settings.
3976- Setting: `repl`
3977- Default:
3978
3979```json [settings]
3980"repl": {
3981 // Maximum number of columns to keep in REPL's scrollback buffer.
3982 // Clamped with [20, 512] range.
3983 "max_columns": 128,
3984 // Maximum number of lines to keep in REPL's scrollback buffer.
3985 // Clamped with [4, 256] range.
3986 "max_lines": 32
3987},
3988```
3989
3990## Theme
3991
3992- 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.
3993- Setting: `theme`
3994- Default: `One Dark`
3995
3996### Theme Object
3997
3998- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
3999- Setting: `theme`
4000- Default:
4001
4002```json [settings]
4003"theme": {
4004 "mode": "system",
4005 "dark": "One Dark",
4006 "light": "One Light"
4007},
4008```
4009
4010### Mode
4011
4012- Description: Specify theme mode.
4013- Setting: `mode`
4014- Default: `system`
4015
4016**Options**
4017
40181. Set the theme to dark mode
4019
4020```json [settings]
4021{
4022 "mode": "dark"
4023}
4024```
4025
40262. Set the theme to light mode
4027
4028```json [settings]
4029{
4030 "mode": "light"
4031}
4032```
4033
40343. Set the theme to system mode
4035
4036```json [settings]
4037{
4038 "mode": "system"
4039}
4040```
4041
4042### Dark
4043
4044- Description: The name of the dark Zed theme to use for the UI.
4045- Setting: `dark`
4046- Default: `One Dark`
4047
4048**Options**
4049
4050Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4051
4052### Light
4053
4054- Description: The name of the light Zed theme to use for the UI.
4055- Setting: `light`
4056- Default: `One Light`
4057
4058**Options**
4059
4060Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4061
4062## Title Bar
4063
4064- Description: Whether or not to show various elements in the title bar
4065- Setting: `title_bar`
4066- Default:
4067
4068```json [settings]
4069"title_bar": {
4070 "show_branch_icon": false,
4071 "show_branch_name": true,
4072 "show_project_items": true,
4073 "show_onboarding_banner": true,
4074 "show_user_picture": true,
4075 "show_sign_in": true,
4076 "show_menus": false
4077}
4078```
4079
4080**Options**
4081
4082- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4083- `show_branch_name`: Whether to show the branch name button in the titlebar
4084- `show_project_items`: Whether to show the project host and name in the titlebar
4085- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4086- `show_user_picture`: Whether to show user picture in the titlebar
4087- `show_sign_in`: Whether to show the sign in button in the titlebar
4088- `show_menus`: Whether to show the menus in the titlebar
4089
4090## Vim
4091
4092- Description: Whether or not to enable vim mode.
4093- Setting: `vim_mode`
4094- Default: `false`
4095
4096## When Closing With No Tabs
4097
4098- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4099- Setting: `when_closing_with_no_tabs`
4100- Default: `"platform_default"`
4101
4102**Options**
4103
41041. Use platform default behavior:
4105
4106```json [settings]
4107{
4108 "when_closing_with_no_tabs": "platform_default"
4109}
4110```
4111
41122. Always close the window:
4113
4114```json [settings]
4115{
4116 "when_closing_with_no_tabs": "close_window"
4117}
4118```
4119
41203. Never close the window:
4121
4122```json [settings]
4123{
4124 "when_closing_with_no_tabs": "keep_window_open"
4125}
4126```
4127
4128## Project Panel
4129
4130- Description: Customize project panel
4131- Setting: `project_panel`
4132- Default:
4133
4134```json [settings]
4135{
4136 "project_panel": {
4137 "button": true,
4138 "default_width": 240,
4139 "dock": "left",
4140 "entry_spacing": "comfortable",
4141 "file_icons": true,
4142 "folder_icons": true,
4143 "git_status": true,
4144 "indent_size": 20,
4145 "auto_reveal_entries": true,
4146 "auto_fold_dirs": true,
4147 "drag_and_drop": true,
4148 "scrollbar": {
4149 "show": null
4150 },
4151 "sticky_scroll": true,
4152 "show_diagnostics": "all",
4153 "indent_guides": {
4154 "show": "always"
4155 },
4156 "hide_root": false,
4157 "hide_hidden": false,
4158 "starts_open": true
4159 }
4160}
4161```
4162
4163### Dock
4164
4165- Description: Control the position of the dock
4166- Setting: `dock`
4167- Default: `left`
4168
4169**Options**
4170
41711. Default dock position to left
4172
4173```json [settings]
4174{
4175 "dock": "left"
4176}
4177```
4178
41792. Default dock position to right
4180
4181```json [settings]
4182{
4183 "dock": "right"
4184}
4185```
4186
4187### Entry Spacing
4188
4189- Description: Spacing between worktree entries
4190- Setting: `entry_spacing`
4191- Default: `comfortable`
4192
4193**Options**
4194
41951. Comfortable entry spacing
4196
4197```json [settings]
4198{
4199 "entry_spacing": "comfortable"
4200}
4201```
4202
42032. Standard entry spacing
4204
4205```json [settings]
4206{
4207 "entry_spacing": "standard"
4208}
4209```
4210
4211### Git Status
4212
4213- Description: Indicates newly created and updated files
4214- Setting: `git_status`
4215- Default: `true`
4216
4217**Options**
4218
42191. Default enable git status
4220
4221```json [settings]
4222{
4223 "git_status": true
4224}
4225```
4226
42272. Default disable git status
4228
4229```json [settings]
4230{
4231 "git_status": false
4232}
4233```
4234
4235### Default Width
4236
4237- Description: Customize default width taken by project panel
4238- Setting: `default_width`
4239- Default: `240`
4240
4241**Options**
4242
4243`float` values
4244
4245### Auto Reveal Entries
4246
4247- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4248- Setting: `auto_reveal_entries`
4249- Default: `true`
4250
4251**Options**
4252
42531. Enable auto reveal entries
4254
4255```json [settings]
4256{
4257 "auto_reveal_entries": true
4258}
4259```
4260
42612. Disable auto reveal entries
4262
4263```json [settings]
4264{
4265 "auto_reveal_entries": false
4266}
4267```
4268
4269### Auto Fold Dirs
4270
4271- Description: Whether to fold directories automatically when directory has only one directory inside.
4272- Setting: `auto_fold_dirs`
4273- Default: `true`
4274
4275**Options**
4276
42771. Enable auto fold dirs
4278
4279```json [settings]
4280{
4281 "auto_fold_dirs": true
4282}
4283```
4284
42852. Disable auto fold dirs
4286
4287```json [settings]
4288{
4289 "auto_fold_dirs": false
4290}
4291```
4292
4293### Indent Size
4294
4295- Description: Amount of indentation (in pixels) for nested items.
4296- Setting: `indent_size`
4297- Default: `20`
4298
4299### Indent Guides: Show
4300
4301- Description: Whether to show indent guides in the project panel.
4302- Setting: `indent_guides`
4303- Default:
4304
4305```json [settings]
4306"indent_guides": {
4307 "show": "always"
4308}
4309```
4310
4311**Options**
4312
43131. Show indent guides in the project panel
4314
4315```json [settings]
4316{
4317 "indent_guides": {
4318 "show": "always"
4319 }
4320}
4321```
4322
43232. Hide indent guides in the project panel
4324
4325```json [settings]
4326{
4327 "indent_guides": {
4328 "show": "never"
4329 }
4330}
4331```
4332
4333### Scrollbar: Show
4334
4335- 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.
4336- Setting: `scrollbar`
4337- Default:
4338
4339```json [settings]
4340"scrollbar": {
4341 "show": null
4342}
4343```
4344
4345**Options**
4346
43471. Show scrollbar in the project panel
4348
4349```json [settings]
4350{
4351 "scrollbar": {
4352 "show": "always"
4353 }
4354}
4355```
4356
43572. Hide scrollbar in the project panel
4358
4359```json [settings]
4360{
4361 "scrollbar": {
4362 "show": "never"
4363 }
4364}
4365```
4366
4367## Agent
4368
4369Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4370
4371## Collaboration Panel
4372
4373- Description: Customizations for the collaboration panel.
4374- Setting: `collaboration_panel`
4375- Default:
4376
4377```json [settings]
4378{
4379 "collaboration_panel": {
4380 "button": true,
4381 "dock": "left",
4382 "default_width": 240
4383 }
4384}
4385```
4386
4387**Options**
4388
4389- `button`: Whether to show the collaboration panel button in the status bar
4390- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4391- `default_width`: Default width of the collaboration panel
4392
4393## Debugger
4394
4395- Description: Configuration for debugger panel and settings
4396- Setting: `debugger`
4397- Default:
4398
4399```json [settings]
4400{
4401 "debugger": {
4402 "stepping_granularity": "line",
4403 "save_breakpoints": true,
4404 "dock": "bottom",
4405 "button": true
4406 }
4407}
4408```
4409
4410See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4411
4412## Git Panel
4413
4414- Description: Setting to customize the behavior of the git panel.
4415- Setting: `git_panel`
4416- Default:
4417
4418```json [settings]
4419{
4420 "git_panel": {
4421 "button": true,
4422 "dock": "left",
4423 "default_width": 360,
4424 "status_style": "icon",
4425 "fallback_branch_name": "main",
4426 "sort_by_path": false,
4427 "collapse_untracked_diff": false,
4428 "scrollbar": {
4429 "show": null
4430 }
4431 }
4432}
4433```
4434
4435**Options**
4436
4437- `button`: Whether to show the git panel button in the status bar
4438- `dock`: Where to dock the git panel. Can be `left` or `right`
4439- `default_width`: Default width of the git panel
4440- `status_style`: How to display git status. Can be `label_color` or `icon`
4441- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4442- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4443- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4444- `scrollbar`: When to show the scrollbar in the git panel
4445
4446## Outline Panel
4447
4448- Description: Customize outline Panel
4449- Setting: `outline_panel`
4450- Default:
4451
4452```json [settings]
4453"outline_panel": {
4454 "button": true,
4455 "default_width": 300,
4456 "dock": "left",
4457 "file_icons": true,
4458 "folder_icons": true,
4459 "git_status": true,
4460 "indent_size": 20,
4461 "auto_reveal_entries": true,
4462 "auto_fold_dirs": true,
4463 "indent_guides": {
4464 "show": "always"
4465 },
4466 "scrollbar": {
4467 "show": null
4468 }
4469}
4470```
4471
4472## Calls
4473
4474- Description: Customize behavior when participating in a call
4475- Setting: `calls`
4476- Default:
4477
4478```json [settings]
4479"calls": {
4480 // Join calls with the microphone live by default
4481 "mute_on_join": false,
4482 // Share your project when you are the first to join a channel
4483 "share_on_join": false
4484},
4485```
4486
4487## Unnecessary Code Fade
4488
4489- Description: How much to fade out unused code.
4490- Setting: `unnecessary_code_fade`
4491- Default: `0.3`
4492
4493**Options**
4494
4495Float values between `0.0` and `0.9`, where:
4496
4497- `0.0` means no fading (unused code looks the same as used code)
4498- `0.9` means maximum fading (unused code is very faint but still visible)
4499
4500**Example**
4501
4502```json [settings]
4503{
4504 "unnecessary_code_fade": 0.5
4505}
4506```
4507
4508## UI Font Family
4509
4510- Description: The name of the font to use for text in the UI.
4511- Setting: `ui_font_family`
4512- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4513
4514**Options**
4515
4516The 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).
4517
4518## UI Font Features
4519
4520- Description: The OpenType features to enable for text in the UI.
4521- Setting: `ui_font_features`
4522- Default:
4523
4524```json [settings]
4525"ui_font_features": {
4526 "calt": false
4527}
4528```
4529
4530- Platform: macOS and Windows.
4531
4532**Options**
4533
4534Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4535
4536For example, to disable font ligatures, add the following to your settings:
4537
4538```json [settings]
4539{
4540 "ui_font_features": {
4541 "calt": false
4542 }
4543}
4544```
4545
4546You can also set other OpenType features, like setting `cv01` to `7`:
4547
4548```json [settings]
4549{
4550 "ui_font_features": {
4551 "cv01": 7
4552 }
4553}
4554```
4555
4556## UI Font Fallbacks
4557
4558- Description: The font fallbacks to use for text in the UI.
4559- Setting: `ui_font_fallbacks`
4560- Default: `null`
4561- Platform: macOS and Windows.
4562
4563**Options**
4564
4565For example, to use `Nerd Font` as a fallback, add the following to your settings:
4566
4567```json [settings]
4568{
4569 "ui_font_fallbacks": ["Nerd Font"]
4570}
4571```
4572
4573## UI Font Size
4574
4575- Description: The default font size for text in the UI.
4576- Setting: `ui_font_size`
4577- Default: `16`
4578
4579**Options**
4580
4581`integer` values from `6` to `100` pixels (inclusive)
4582
4583## UI Font Weight
4584
4585- Description: The default font weight for text in the UI.
4586- Setting: `ui_font_weight`
4587- Default: `400`
4588
4589**Options**
4590
4591`integer` values between `100` and `900`
4592
4593## An example configuration:
4594
4595```json [settings]
4596// ~/.config/zed/settings.json
4597{
4598 "theme": "cave-light",
4599 "tab_size": 2,
4600 "preferred_line_length": 80,
4601 "soft_wrap": "none",
4602
4603 "buffer_font_size": 18,
4604 "buffer_font_family": ".ZedMono",
4605
4606 "autosave": "on_focus_change",
4607 "format_on_save": "off",
4608 "vim_mode": false,
4609 "projects_online_by_default": true,
4610 "terminal": {
4611 "font_family": "FiraCode Nerd Font Mono",
4612 "blinking": "off"
4613 },
4614 "languages": {
4615 "C": {
4616 "format_on_save": "on",
4617 "formatter": "language_server",
4618 "preferred_line_length": 64,
4619 "soft_wrap": "preferred_line_length"
4620 }
4621 }
4622}
4623```