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
34Styling settings applied to the active pane.
35
36### Magnification
37
38- Description: Scale by which to zoom the active pane. When set to `1.0`, the active pane has the same size as others, but when set to a larger value, the active pane takes up more space.
39- Setting: `magnification`
40- Default: `1.0`
41
42### Border size
43
44- 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.
45- Setting: `border_size`
46- Default: `0.0`
47
48### Inactive Opacity
49
50- 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.
51- Setting: `inactive_opacity`
52- Default: `1.0`
53
54**Options**
55
56`float` values
57
58## Auto Install extensions
59
60- Description: Define extensions to be autoinstalled or never be installed.
61- Setting: `auto_install_extension`
62- Default: `{"html": true}`
63
64**Options**
65
66You can find the names of your currently installed extensions by listing the subfolders under the [extension installation location](./extensions/installing-extensions#installation-location):
67
68On MacOS:
69
70```sh
71ls ~/Library/Application\ Support/Zed/extensions/installed/
72```
73
74On Linux:
75
76```sh
77ls ~/.local/share/zed/extensions/installed
78```
79
80Define extensions which should be installed (`true`) or never installed (`false`).
81
82```json
83{
84 "auto_install_extensions": {
85 "html": true,
86 "dockerfile": true,
87 "docker-compose": false
88 }
89}
90```
91
92## Autosave
93
94- Description: When to automatically save edited buffers.
95- Setting: `autosave`
96- Default: `off`
97
98**Options**
99
1001. To disable autosave, set it to `off`:
101
102```json
103{
104 "autosave": "off"
105}
106```
107
1082. To autosave when focus changes, use `on_focus_change`:
109
110```json
111{
112 "autosave": "on_focus_change"
113}
114```
115
1163. To autosave when the active window changes, use `on_window_change`:
117
118```json
119{
120 "autosave": "on_window_change"
121}
122```
123
1244. To autosave after an inactivity period, use `after_delay`:
125
126```json
127{
128 "autosave": {
129 "after_delay": {
130 "milliseconds": 1000
131 }
132 }
133}
134```
135
136## Restore on Startup
137
138- Description: Controls session restoration on startup.
139- Setting: `restore_on_startup`
140- Default: `last_session`
141
142**Options**
143
1441. Restore all workspaces that were open when quitting Zed:
145
146```json
147{
148 "restore_on_startup": "last_session"
149}
150```
151
1522. Restore the workspace that was closed last:
153
154```json
155{
156 "restore_on_startup": "last_workspace"
157}
158```
159
1603. Always start with an empty editor:
161
162```json
163{
164 "restore_on_startup": "none"
165}
166```
167
168## Autoscroll on Clicks
169
170- Description: Whether to scroll when clicking near the edge of the visible text area.
171- Setting: `autoscroll_on_clicks`
172- Default: `false`
173
174**Options**
175
176`boolean` values
177
178## Auto Update
179
180- Description: Whether or not to automatically check for updates.
181- Setting: `auto_update`
182- Default: `true`
183
184**Options**
185
186`boolean` values
187
188## Base Keymap
189
190- Description: Base key bindings scheme. Base keymaps can be overridden with user keymaps.
191- Setting: `base_keymap`
192- Default: `VSCode`
193
194**Options**
195
1961. VSCode
197
198```json
199{
200 "base_keymap": "VSCode"
201}
202```
203
2042. Atom
205
206```json
207{
208 "base_keymap": "Atom"
209}
210```
211
2123. JetBrains
213
214```json
215{
216 "base_keymap": "JetBrains"
217}
218```
219
2204. None
221
222```json
223{
224 "base_keymap": "None"
225}
226```
227
2285. SublimeText
229
230```json
231{
232 "base_keymap": "SublimeText"
233}
234```
235
2366. TextMate
237
238```json
239{
240 "base_keymap": "TextMate"
241}
242```
243
244## Buffer Font Family
245
246- Description: The name of a font to use for rendering text in the editor.
247- Setting: `buffer_font_family`
248- Default: `Zed Plex Mono`
249
250**Options**
251
252The name of any font family installed on the user's system
253
254## Buffer Font Features
255
256- Description: The OpenType features to enable for text in the editor.
257- Setting: `buffer_font_features`
258- Default: `null`
259- Platform: macOS and Windows.
260
261**Options**
262
263Zed 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.
264
265For example, to disable font ligatures, add the following to your settings:
266
267```json
268{
269 "buffer_font_features": {
270 "calt": false
271 }
272}
273```
274
275You can also set other OpenType features, like setting `cv01` to `7`:
276
277```json
278{
279 "buffer_font_features": {
280 "cv01": 7
281 }
282}
283```
284
285## Buffer Font Fallbacks
286
287- Description: Set the buffer text's font fallbacks, this will be merged with the platform's default fallbacks.
288- Setting: `buffer_font_fallbacks`
289- Default: `null`
290- Platform: macOS and Windows.
291
292**Options**
293
294For example, to use `Nerd Font` as a fallback, add the following to your settings:
295
296```json
297{
298 "buffer_font_fallbacks": ["Nerd Font"]
299}
300```
301
302## Buffer Font Size
303
304- Description: The default font size for text in the editor.
305- Setting: `buffer_font_size`
306- Default: `15`
307
308**Options**
309
310`integer` values from `6` to `100` pixels (inclusive)
311
312## Buffer Font Weight
313
314- Description: The default font weight for text in the editor.
315- Setting: `buffer_font_weight`
316- Default: `400`
317
318**Options**
319
320`integer` values between `100` and `900`
321
322## Buffer Line Height
323
324- Description: The default line height for text in the editor.
325- Setting: `buffer_line_height`
326- Default: `"comfortable"`
327
328**Options**
329
330`"standard"`, `"comfortable"` or `{"custom": float}` (`1` is very compact, `2` very loose)
331
332## Confirm Quit
333
334- Description: Whether or not to prompt the user to confirm before closing the application.
335- Setting: `confirm_quit`
336- Default: `false`
337
338**Options**
339
340`boolean` values
341
342## Centered Layout
343
344- Description: Configuration for the centered layout mode.
345- Setting: `centered_layout`
346- Default:
347
348```json
349"centered_layout": {
350 "left_padding": 0.2,
351 "right_padding": 0.2,
352}
353```
354
355**Options**
356
357The `left_padding` and `right_padding` options define the relative width of the
358left 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`.
359
360## Direnv Integration
361
362- Description: Settings for [direnv](https://direnv.net/) integration. Requires `direnv` to be installed.
363 `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.
364 It also allows for those environment variables to be used in tasks.
365- Setting: `load_direnv`
366- Default:
367
368```json
369"load_direnv": "direct"
370```
371
372**Options**
373There are two options to choose from:
374
3751. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
3762. `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.
377
378## Edit Predictions
379
380- Description: Settings for edit predictions.
381- Setting: `edit_predictions`
382- Default:
383
384```json
385 "edit_predictions": {
386 "disabled_globs": [
387 "**/.env*",
388 "**/*.pem",
389 "**/*.key",
390 "**/*.cert",
391 "**/*.crt",
392 "**/secrets.yml"
393 ]
394 }
395```
396
397**Options**
398
399### Disabled Globs
400
401- 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.
402- Setting: `disabled_globs`
403- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
404
405**Options**
406
407List of `string` values.
408
409## Edit Predictions Disabled in
410
411- Description: A list of language scopes in which edit predictions should be disabled.
412- Setting: `edit_predictions_disabled_in`
413- Default: `[]`
414
415**Options**
416
417List of `string` values
418
4191. Don't show edit predictions in comments:
420
421```json
422"disabled_in": ["comment"]
423```
424
4252. Don't show edit predictions in strings and comments:
426
427```json
428"disabled_in": ["comment", "string"]
429```
430
4313. Only in Go, don't show edit predictions in strings and comments:
432
433```json
434{
435 "languages": {
436 "Go": {
437 "edit_predictions_disabled_in": ["comment", "string"]
438 }
439 }
440}
441```
442
443## Current Line Highlight
444
445- Description: How to highlight the current line in the editor.
446- Setting: `current_line_highlight`
447- Default: `all`
448
449**Options**
450
4511. Don't highlight the current line:
452
453```json
454"current_line_highlight": "none"
455```
456
4572. Highlight the gutter area:
458
459```json
460"current_line_highlight": "gutter"
461```
462
4633. Highlight the editor area:
464
465```json
466"current_line_highlight": "line"
467```
468
4694. Highlight the full line:
470
471```json
472"current_line_highlight": "all"
473```
474
475## Selection Highlight
476
477- Description: Whether to highlight all occurrences of the selected text in an editor.
478- Setting: `selection_highlight`
479- Default: `true`
480
481## Selection Highlight Debounce
482
483- Description: The debounce delay before querying highlights based on the selected text.
484
485- Setting: `selection_highlight_debounce`
486- Default: `50`
487
488## LSP Highlight Debounce
489
490- Description: The debounce delay before querying highlights from the language server based on the current cursor location.
491- Setting: `lsp_highlight_debounce`
492- Default: `75`
493
494## Cursor Blink
495
496- Description: Whether or not the cursor blinks.
497- Setting: `cursor_blink`
498- Default: `true`
499
500**Options**
501
502`boolean` values
503
504## Cursor Shape
505
506- Description: Cursor shape for the default editor.
507- Setting: `cursor_shape`
508- Default: `bar`
509
510**Options**
511
5121. A vertical bar:
513
514```json
515"cursor_shape": "bar"
516```
517
5182. A block that surrounds the following character:
519
520```json
521"cursor_shape": "block"
522```
523
5243. An underline / underscore that runs along the following character:
525
526```json
527"cursor_shape": "underline"
528```
529
5304. An box drawn around the following character:
531
532```json
533"cursor_shape": "hollow"
534```
535
536## Editor Scrollbar
537
538- Description: Whether or not to show the editor scrollbar and various elements in it.
539- Setting: `scrollbar`
540- Default:
541
542```json
543"scrollbar": {
544 "show": "auto",
545 "cursors": true,
546 "git_diff": true,
547 "search_results": true,
548 "selected_text": true,
549 "selected_symbol": true,
550 "diagnostics": "all",
551 "axes": {
552 "horizontal": true,
553 "vertical": true,
554 },
555},
556```
557
558### Show Mode
559
560- Description: When to show the editor scrollbar.
561- Setting: `show`
562- Default: `auto`
563
564**Options**
565
5661. Show the scrollbar if there's important information or follow the system's configured behavior:
567
568```json
569"scrollbar": {
570 "show": "auto"
571}
572```
573
5742. Match the system's configured behavior:
575
576```json
577"scrollbar": {
578 "show": "system"
579}
580```
581
5823. Always show the scrollbar:
583
584```json
585"scrollbar": {
586 "show": "always"
587}
588```
589
5904. Never show the scrollbar:
591
592```json
593"scrollbar": {
594 "show": "never"
595}
596```
597
598### Cursor Indicators
599
600- Description: Whether to show cursor positions in the scrollbar.
601- Setting: `cursors`
602- Default: `true`
603
604**Options**
605
606`boolean` values
607
608### Git Diff Indicators
609
610- Description: Whether to show git diff indicators in the scrollbar.
611- Setting: `git_diff`
612- Default: `true`
613
614**Options**
615
616`boolean` values
617
618### Search Results Indicators
619
620- Description: Whether to show buffer search results in the scrollbar.
621- Setting: `search_results`
622- Default: `true`
623
624**Options**
625
626`boolean` values
627
628### Selected Text Indicators
629
630- Description: Whether to show selected text occurrences in the scrollbar.
631- Setting: `selected_text`
632- Default: `true`
633
634**Options**
635
636`boolean` values
637
638### Selected Symbols Indicators
639
640- Description: Whether to show selected symbol occurrences in the scrollbar.
641- Setting: `selected_symbol`
642- Default: `true`
643
644**Options**
645
646`boolean` values
647
648### Diagnostics
649
650- Description: Which diagnostic indicators to show in the scrollbar.
651- Setting: `diagnostics`
652- Default: `all`
653
654**Options**
655
6561. Show all diagnostics:
657
658```json
659{
660 "diagnostics": "all"
661}
662```
663
6642. Do not show any diagnostics:
665
666```json
667{
668 "diagnostics": "none"
669}
670```
671
6723. Show only errors:
673
674```json
675{
676 "diagnostics": "error"
677}
678```
679
6804. Show only errors and warnings:
681
682```json
683{
684 "diagnostics": "warning"
685}
686```
687
6885. Show only errors, warnings, and information:
689
690```json
691{
692 "diagnostics": "information"
693}
694```
695
696### Axes
697
698- Description: Forcefully enable or disable the scrollbar for each axis
699- Setting: `axes`
700- Default:
701
702```json
703"scrollbar": {
704 "axes": {
705 "horizontal": true,
706 "vertical": true,
707 },
708}
709```
710
711#### Horizontal
712
713- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
714- Setting: `horizontal`
715- Default: `true`
716
717**Options**
718
719`boolean` values
720
721#### Vertical
722
723- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
724- Setting: `vertical`
725- Default: `true`
726
727**Options**
728
729`boolean` values
730
731## Editor Tab Bar
732
733- Description: Settings related to the editor's tab bar.
734- Settings: `tab_bar`
735- Default:
736
737```json
738"tab_bar": {
739 "show": true,
740 "show_nav_history_buttons": true,
741 "show_tab_bar_buttons": true
742}
743```
744
745### Show
746
747- Description: Whether or not to show the tab bar in the editor.
748- Setting: `show`
749- Default: `true`
750
751**Options**
752
753`boolean` values
754
755### Navigation History Buttons
756
757- Description: Whether or not to show the navigation history buttons.
758- Setting: `show_nav_history_buttons`
759- Default: `true`
760
761**Options**
762
763`boolean` values
764
765### Tab Bar Buttons
766
767- Description: Whether or not to show the tab bar buttons.
768- Setting: `show_tab_bar_buttons`
769- Default: `true`
770
771**Options**
772
773`boolean` values
774
775## Editor Tabs
776
777- Description: Configuration for the editor tabs.
778- Setting: `tabs`
779- Default:
780
781```json
782"tabs": {
783 "close_position": "right",
784 "file_icons": false,
785 "git_status": false,
786 "activate_on_close": "history",
787 "show_close_button": "hover"
788},
789```
790
791### Close Position
792
793- Description: Where to display close button within a tab.
794- Setting: `close_position`
795- Default: `right`
796
797**Options**
798
7991. Display the close button on the right:
800
801```json
802{
803 "close_position": "right"
804}
805```
806
8072. Display the close button on the left:
808
809```json
810{
811 "close_position": "left"
812}
813```
814
815### File Icons
816
817- Description: Whether to show the file icon for a tab.
818- Setting: `file_icons`
819- Default: `false`
820
821### Git Status
822
823- Description: Whether or not to show Git file status in tab.
824- Setting: `git_status`
825- Default: `false`
826
827### Activate on close
828
829- Description: What to do after closing the current tab.
830- Setting: `activate_on_close`
831- Default: `history`
832
833**Options**
834
8351. Activate the tab that was open previously:
836
837```json
838{
839 "activate_on_close": "history"
840}
841```
842
8432. Activate the right neighbour tab if present:
844
845```json
846{
847 "activate_on_close": "neighbour"
848}
849```
850
8513. Activate the left neighbour tab if present:
852
853```json
854{
855 "activate_on_close": "left_neighbour"
856}
857```
858
859### Show close button
860
861- Description: Controls the appearance behavior of the tab's close button.
862- Setting: `show_close_button`
863- Default: `hover`
864
865**Options**
866
8671. Show it just upon hovering the tab:
868
869```json
870{
871 "show_close_button": "hover"
872}
873```
874
8752. Show it persistently:
876
877```json
878{
879 "show_close_button": "always"
880}
881```
882
8833. Never show it, even if hovering it:
884
885```json
886{
887 "show_close_button": "hidden"
888}
889```
890
891## Editor Toolbar
892
893- Description: Whether or not to show various elements in the editor toolbar.
894- Setting: `toolbar`
895- Default:
896
897```json
898"toolbar": {
899 "breadcrumbs": true,
900 "quick_actions": true
901},
902```
903
904**Options**
905
906Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
907
908## Enable Language Server
909
910- Description: Whether or not to use language servers to provide code intelligence.
911- Setting: `enable_language_server`
912- Default: `true`
913
914**Options**
915
916`boolean` values
917
918## Ensure Final Newline On Save
919
920- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
921- Setting: `ensure_final_newline_on_save`
922- Default: `true`
923
924**Options**
925
926`boolean` values
927
928## LSP
929
930- Description: Configuration for language servers.
931- Setting: `lsp`
932- Default: `null`
933
934**Options**
935
936The following settings can be overridden for specific language servers:
937
938- `initialization_options`
939- `settings`
940
941To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
942
943Some 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.
944
945For example to pass the `check` option to `rust-analyzer`, use the following configuration:
946
947```json
948"lsp": {
949 "rust-analyzer": {
950 "initialization_options": {
951 "check": {
952 "command": "clippy" // rust-analyzer.check.command (default: "check")
953 }
954 }
955 }
956}
957```
958
959While other options may be changed at a runtime and should be placed under `settings`:
960
961```json
962"lsp": {
963 "yaml-language-server": {
964 "settings": {
965 "yaml": {
966 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
967 }
968 }
969 }
970}
971```
972
973## LSP Highlight Debounce
974
975- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
976- Setting: `lsp_highlight_debounce`
977- Default: `75`
978
979**Options**
980
981`integer` values representing milliseconds
982
983## Format On Save
984
985- Description: Whether or not to perform a buffer format before saving.
986- Setting: `format_on_save`
987- Default: `on`
988
989**Options**
990
9911. `on`, enables format on save obeying `formatter` setting:
992
993```json
994{
995 "format_on_save": "on"
996}
997```
998
9992. `off`, disables format on save:
1000
1001```json
1002{
1003 "format_on_save": "off"
1004}
1005```
1006
1007## Formatter
1008
1009- Description: How to perform a buffer format.
1010- Setting: `formatter`
1011- Default: `auto`
1012
1013**Options**
1014
10151. To use the current language server, use `"language_server"`:
1016
1017```json
1018{
1019 "formatter": "language_server"
1020}
1021```
1022
10232. 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):
1024
1025```json
1026{
1027 "formatter": {
1028 "external": {
1029 "command": "sed",
1030 "arguments": ["-e", "s/ *$//"]
1031 }
1032 }
1033}
1034```
1035
10363. 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.
1037
1038WARNING: `{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.
1039
1040```json
1041 "formatter": {
1042 "external": {
1043 "command": "prettier",
1044 "arguments": ["--stdin-filepath", "{buffer_path}"]
1045 }
1046 }
1047```
1048
10494. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1050
1051```json
1052{
1053 "formatter": {
1054 "code_actions": {
1055 // Use ESLint's --fix:
1056 "source.fixAll.eslint": true,
1057 // Organize imports on save:
1058 "source.organizeImports": true
1059 }
1060 }
1061}
1062```
1063
10645. Or to use multiple formatters consecutively, use an array of formatters:
1065
1066```json
1067{
1068 "formatter": [
1069 { "language_server": { "name": "rust-analyzer" } },
1070 {
1071 "external": {
1072 "command": "sed",
1073 "arguments": ["-e", "s/ *$//"]
1074 }
1075 }
1076 ]
1077}
1078```
1079
1080Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1081If any of the formatters fails, the subsequent ones will still be executed.
1082
1083## Code Actions On Format
1084
1085- Description: The code actions to perform with the primary language server when formatting the buffer.
1086- Setting: `code_actions_on_format`
1087- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
1088
1089**Examples**
1090
1091<!--
1092TBD: Add Python Ruff source.organizeImports example
1093-->
1094
10951. Organize imports on format in TypeScript and TSX buffers:
1096
1097```json
1098{
1099 "languages": {
1100 "TypeScript": {
1101 "code_actions_on_format": {
1102 "source.organizeImports": true
1103 }
1104 },
1105 "TSX": {
1106 "code_actions_on_format": {
1107 "source.organizeImports": true
1108 }
1109 }
1110 }
1111}
1112```
1113
11142. Run ESLint `fixAll` code action when formatting:
1115
1116```json
1117{
1118 "languages": {
1119 "JavaScript": {
1120 "code_actions_on_format": {
1121 "source.fixAll.eslint": true
1122 }
1123 }
1124 }
1125}
1126```
1127
11283. Run only a single ESLint rule when using `fixAll`:
1129
1130```json
1131{
1132 "languages": {
1133 "JavaScript": {
1134 "code_actions_on_format": {
1135 "source.fixAll.eslint": true
1136 }
1137 }
1138 },
1139 "lsp": {
1140 "eslint": {
1141 "settings": {
1142 "codeActionOnSave": {
1143 "rules": ["import/order"]
1144 }
1145 }
1146 }
1147 }
1148}
1149```
1150
1151## Auto close
1152
1153- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1154- Setting: `use_autoclose`
1155- Default: `true`
1156
1157**Options**
1158
1159`boolean` values
1160
1161## Always Treat Brackets As Autoclosed
1162
1163- Description: Controls how the editor handles the autoclosed characters.
1164- Setting: `always_treat_brackets_as_autoclosed`
1165- Default: `false`
1166
1167**Options**
1168
1169`boolean` values
1170
1171**Example**
1172
1173If the setting is set to `true`:
1174
11751. Enter in the editor: `)))`
11762. Move the cursor to the start: `^)))`
11773. Enter again: `)))`
1178
1179The result is still `)))` and not `))))))`, which is what it would be by default.
1180
1181## File Scan Exclusions
1182
1183- Setting: `file_scan_exclusions`
1184- 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`.
1185- Default:
1186
1187```json
1188"file_scan_exclusions": [
1189 "**/.git",
1190 "**/.svn",
1191 "**/.hg",
1192 "**/.jj",
1193 "**/CVS",
1194 "**/.DS_Store",
1195 "**/Thumbs.db",
1196 "**/.classpath",
1197 "**/.settings"
1198],
1199```
1200
1201Note, 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.
1202
1203## File Scan Inclusions
1204
1205- Setting: `file_scan_inclusions`
1206- 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.
1207- Default:
1208
1209```json
1210"file_scan_inclusions": [".env*"],
1211```
1212
1213## File Types
1214
1215- Setting: `file_types`
1216- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1217- Default: `{}`
1218
1219**Examples**
1220
1221To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1222
1223```json
1224{
1225 "file_types": {
1226 "C++": ["c"],
1227 "TOML": ["MyLockFile"],
1228 "Dockerfile": ["Dockerfile*"]
1229 }
1230}
1231```
1232
1233## Diagnostics
1234
1235- Description: Configuration for diagnostics-related features.
1236- Setting: `diagnostics`
1237- Default:
1238
1239```json
1240{
1241 "diagnostics": {
1242 "include_warnings": true,
1243 "inline": {
1244 "enabled": false
1245 }
1246 "update_with_cursor": false,
1247 "primary_only": false,
1248 "use_rendered": false,
1249 }
1250}
1251```
1252
1253### Inline Diagnostics
1254
1255- Description: Whether or not to show diagnostics information inline.
1256- Setting: `inline`
1257- Default:
1258
1259```json
1260{
1261 "diagnostics": {
1262 "inline": {
1263 "enabled": false,
1264 "update_debounce_ms": 150,
1265 "padding": 4,
1266 "min_column": 0,
1267 "max_severity": null
1268 }
1269 }
1270}
1271```
1272
1273**Options**
1274
12751. Enable inline diagnostics.
1276
1277```json
1278{
1279 "diagnostics": {
1280 "inline": {
1281 "enabled": true
1282 }
1283 }
1284}
1285```
1286
12872. Delay diagnostic updates until some time after the last diagnostic update.
1288
1289```json
1290{
1291 "diagnostics": {
1292 "inline": {
1293 "enabled": true,
1294 "update_debounce_ms": 150
1295 }
1296 }
1297}
1298```
1299
13003. Set padding between the end of the source line and the start of the diagnostic.
1301
1302```json
1303{
1304 "diagnostics": {
1305 "inline": {
1306 "enabled": true,
1307 "padding": 4
1308 }
1309 }
1310}
1311```
1312
13134. Horizontally align inline diagnostics at the given column.
1314
1315```json
1316{
1317 "diagnostics": {
1318 "inline": {
1319 "enabled": true,
1320 "min_column": 80
1321 }
1322 }
1323}
1324```
1325
13265. Show only warning and error diagnostics.
1327
1328```json
1329{
1330 "diagnostics": {
1331 "inline": {
1332 "enabled": true,
1333 "max_severity": "warning"
1334 }
1335 }
1336}
1337```
1338
1339## Git
1340
1341- Description: Configuration for git-related features.
1342- Setting: `git`
1343- Default:
1344
1345```json
1346{
1347 "git": {
1348 "git_gutter": "tracked_files",
1349 "inline_blame": {
1350 "enabled": true
1351 },
1352 "hunk_style": "staged_hollow"
1353 }
1354}
1355```
1356
1357### Git Gutter
1358
1359- Description: Whether or not to show the git gutter.
1360- Setting: `git_gutter`
1361- Default: `tracked_files`
1362
1363**Options**
1364
13651. Show git gutter in tracked files
1366
1367```json
1368{
1369 "git": {
1370 "git_gutter": "tracked_files"
1371 }
1372}
1373```
1374
13752. Hide git gutter
1376
1377```json
1378{
1379 "git": {
1380 "git_gutter": "hide"
1381 }
1382}
1383```
1384
1385### Inline Git Blame
1386
1387- Description: Whether or not to show git blame information inline, on the currently focused line.
1388- Setting: `inline_blame`
1389- Default:
1390
1391```json
1392{
1393 "git": {
1394 "inline_blame": {
1395 "enabled": true
1396 }
1397 }
1398}
1399```
1400
1401### Hunk Style
1402
1403- Description: What styling we should use for the diff hunks.
1404- Setting: `hunk_style`
1405- Default:
1406
1407```json
1408{
1409 "git": {
1410 "hunk_style": "staged_hollow"
1411 }
1412}
1413```
1414
1415**Options**
1416
14171. Show the staged hunks faded out and with a border:
1418
1419```json
1420{
1421 "git": {
1422 "hunk_style": "staged_hollow"
1423 }
1424}
1425```
1426
14272. Show unstaged hunks faded out and with a border:
1428
1429```json
1430{
1431 "git": {
1432 "hunk_style": "unstaged_hollow"
1433 }
1434}
1435```
1436
1437**Options**
1438
14391. Disable inline git blame:
1440
1441```json
1442{
1443 "git": {
1444 "inline_blame": {
1445 "enabled": false
1446 }
1447 }
1448}
1449```
1450
14512. Only show inline git blame after a delay (that starts after cursor stops moving):
1452
1453```json
1454{
1455 "git": {
1456 "inline_blame": {
1457 "enabled": true,
1458 "delay_ms": 500
1459 }
1460 }
1461}
1462```
1463
14643. Show a commit summary next to the commit date and author:
1465
1466```json
1467{
1468 "git": {
1469 "inline_blame": {
1470 "enabled": true,
1471 "show_commit_summary": true
1472 }
1473 }
1474}
1475```
1476
14774. Use this as the minimum column at which to display inline blame information:
1478
1479```json
1480{
1481 "git": {
1482 "inline_blame": {
1483 "enabled": true,
1484 "min_column": 80
1485 }
1486 }
1487}
1488```
1489
1490## Indent Guides
1491
1492- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
1493- Setting: `indent_guides`
1494- Default:
1495
1496```json
1497{
1498 "indent_guides": {
1499 "enabled": true,
1500 "line_width": 1,
1501 "active_line_width": 1,
1502 "coloring": "fixed",
1503 "background_coloring": "disabled"
1504 }
1505}
1506```
1507
1508**Options**
1509
15101. Disable indent guides
1511
1512```json
1513{
1514 "indent_guides": {
1515 "enabled": false
1516 }
1517}
1518```
1519
15202. Enable indent guides for a specific language.
1521
1522```json
1523{
1524 "languages": {
1525 "Python": {
1526 "indent_guides": {
1527 "enabled": true
1528 }
1529 }
1530 }
1531}
1532```
1533
15343. Enable indent aware coloring ("rainbow indentation").
1535 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.
1536
1537```json
1538{
1539 "indent_guides": {
1540 "enabled": true,
1541 "coloring": "indent_aware"
1542 }
1543}
1544```
1545
15464. Enable indent aware background coloring ("rainbow indentation").
1547 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.
1548
1549```json
1550{
1551 "indent_guides": {
1552 "enabled": true,
1553 "coloring": "indent_aware",
1554 "background_coloring": "indent_aware"
1555 }
1556}
1557```
1558
1559## Hard Tabs
1560
1561- Description: Whether to indent lines using tab characters or multiple spaces.
1562- Setting: `hard_tabs`
1563- Default: `false`
1564
1565**Options**
1566
1567`boolean` values
1568
1569## Hover Popover Enabled
1570
1571- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
1572- Setting: `hover_popover_enabled`
1573- Default: `true`
1574
1575**Options**
1576
1577`boolean` values
1578
1579## Icon Theme
1580
1581- 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.
1582- Setting: `icon_theme`
1583- Default: `Zed (Default)`
1584
1585### Icon Theme Object
1586
1587- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
1588- Setting: `icon_theme`
1589- Default:
1590
1591```json
1592"icon_theme": {
1593 "mode": "system",
1594 "dark": "Zed (Default)",
1595 "light": "Zed (Default)"
1596},
1597```
1598
1599### Mode
1600
1601- Description: Specify the icon theme mode.
1602- Setting: `mode`
1603- Default: `system`
1604
1605**Options**
1606
16071. Set the icon theme to dark mode
1608
1609```json
1610{
1611 "mode": "dark"
1612}
1613```
1614
16152. Set the icon theme to light mode
1616
1617```json
1618{
1619 "mode": "light"
1620}
1621```
1622
16233. Set the icon theme to system mode
1624
1625```json
1626{
1627 "mode": "system"
1628}
1629```
1630
1631### Dark
1632
1633- Description: The name of the dark icon theme.
1634- Setting: `dark`
1635- Default: `Zed (Default)`
1636
1637**Options**
1638
1639Run the `icon theme selector: toggle` action in the command palette to see a current list of valid icon themes names.
1640
1641### Light
1642
1643- Description: The name of the light icon theme.
1644- Setting: `light`
1645- Default: `Zed (Default)`
1646
1647**Options**
1648
1649Run the `icon theme selector: toggle` action in the command palette to see a current list of valid icon themes names.
1650
1651## Inlay hints
1652
1653- Description: Configuration for displaying extra text with hints in the editor.
1654- Setting: `inlay_hints`
1655- Default:
1656
1657```json
1658"inlay_hints": {
1659 "enabled": false,
1660 "show_type_hints": true,
1661 "show_parameter_hints": true,
1662 "show_other_hints": true,
1663 "show_background": false,
1664 "edit_debounce_ms": 700,
1665 "scroll_debounce_ms": 50,
1666 "toggle_on_modifiers_press": null
1667}
1668```
1669
1670**Options**
1671
1672Inlay hints querying consists of two parts: editor (client) and LSP server.
1673With 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.
1674At 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.
1675
1676The following languages have inlay hints preconfigured by Zed:
1677
1678- [Go](https://docs.zed.dev/languages/go)
1679- [Rust](https://docs.zed.dev/languages/rust)
1680- [Svelte](https://docs.zed.dev/languages/svelte)
1681- [Typescript](https://docs.zed.dev/languages/typescript)
1682
1683Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
1684
1685Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
1686Settings-related hint updates are not debounced.
1687
1688All possible config values for `toggle_on_modifiers_press` are:
1689
1690```json
1691"inlay_hints": {
1692 "toggle_on_modifiers_press": {
1693 "control": true,
1694 "shift": true,
1695 "alt": true,
1696 "platform": true,
1697 "function": true
1698 }
1699}
1700```
1701
1702Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
1703
1704## Journal
1705
1706- Description: Configuration for the journal.
1707- Setting: `journal`
1708- Default:
1709
1710```json
1711"journal": {
1712 "path": "~",
1713 "hour_format": "hour12"
1714}
1715```
1716
1717### Path
1718
1719- Description: The path of the directory where journal entries are stored.
1720- Setting: `path`
1721- Default: `~`
1722
1723**Options**
1724
1725`string` values
1726
1727### Hour Format
1728
1729- Description: The format to use for displaying hours in the journal.
1730- Setting: `hour_format`
1731- Default: `hour12`
1732
1733**Options**
1734
17351. 12-hour format:
1736
1737```json
1738{
1739 "hour_format": "hour12"
1740}
1741```
1742
17432. 24-hour format:
1744
1745```json
1746{
1747 "hour_format": "hour24"
1748}
1749```
1750
1751## Languages
1752
1753- Description: Configuration for specific languages.
1754- Setting: `languages`
1755- Default: `null`
1756
1757**Options**
1758
1759To override settings for a language, add an entry for that languages name to the `languages` value. Example:
1760
1761```json
1762"languages": {
1763 "C": {
1764 "format_on_save": "off",
1765 "preferred_line_length": 64,
1766 "soft_wrap": "preferred_line_length"
1767 },
1768 "JSON": {
1769 "tab_size": 4
1770 }
1771}
1772```
1773
1774The following settings can be overridden for each specific language:
1775
1776- [`enable_language_server`](#enable-language-server)
1777- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
1778- [`format_on_save`](#format-on-save)
1779- [`formatter`](#formatter)
1780- [`hard_tabs`](#hard-tabs)
1781- [`preferred_line_length`](#preferred-line-length)
1782- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
1783- [`show_edit_predictions`](#show-edit-predictions)
1784- [`show_whitespaces`](#show-whitespaces)
1785- [`soft_wrap`](#soft-wrap)
1786- [`tab_size`](#tab-size)
1787- [`use_autoclose`](#use-autoclose)
1788- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
1789
1790These values take in the same options as the root-level settings with the same name.
1791
1792## Network Proxy
1793
1794- Description: Configure a network proxy for Zed.
1795- Setting: `proxy`
1796- Default: `null`
1797
1798**Options**
1799
1800The proxy setting must contain a URL to the proxy.
1801
1802The following URI schemes are supported:
1803
1804- `http`
1805- `https`
1806- `socks4` - SOCKS4 proxy with local DNS
1807- `socks4a` - SOCKS4 proxy with remote DNS
1808- `socks5` - SOCKS5 proxy with local DNS
1809- `socks5h` - SOCKS5 proxy with remote DNS
1810
1811`http` will be used when no scheme is specified.
1812
1813By 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`.
1814
1815For example, to set an `http` proxy, add the following to your settings:
1816
1817```json
1818{
1819 "proxy": "http://127.0.0.1:10809"
1820}
1821```
1822
1823Or to set a `socks5` proxy:
1824
1825```json
1826{
1827 "proxy": "socks5h://localhost:10808"
1828}
1829```
1830
1831## Preview tabs
1832
1833- Description:
1834 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. \
1835 There are several ways to convert a preview tab into a regular tab:
1836
1837 - Double-clicking on the file
1838 - Double-clicking on the tab header
1839 - Using the `project_panel::OpenPermanent` action
1840 - Editing the file
1841 - Dragging the file to a different pane
1842
1843- Setting: `preview_tabs`
1844- Default:
1845
1846```json
1847"preview_tabs": {
1848 "enabled": true,
1849 "enable_preview_from_file_finder": false,
1850 "enable_preview_from_code_navigation": false,
1851}
1852```
1853
1854### Enable preview from file finder
1855
1856- Description: Determines whether to open files in preview mode when selected from the file finder.
1857- Setting: `enable_preview_from_file_finder`
1858- Default: `false`
1859
1860**Options**
1861
1862`boolean` values
1863
1864### Enable preview from code navigation
1865
1866- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
1867- Setting: `enable_preview_from_code_navigation`
1868- Default: `false`
1869
1870**Options**
1871
1872`boolean` values
1873
1874## File Finder
1875
1876### Modal Max Width
1877
1878- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
1879- Setting: `modal_max_width`
1880- Default: `small`
1881
1882## Preferred Line Length
1883
1884- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
1885- Setting: `preferred_line_length`
1886- Default: `80`
1887
1888**Options**
1889
1890`integer` values
1891
1892## Projects Online By Default
1893
1894- Description: Whether or not to show the online projects view by default.
1895- Setting: `projects_online_by_default`
1896- Default: `true`
1897
1898**Options**
1899
1900`boolean` values
1901
1902## Remove Trailing Whitespace On Save
1903
1904- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
1905- Setting: `remove_trailing_whitespace_on_save`
1906- Default: `true`
1907
1908**Options**
1909
1910`boolean` values
1911
1912## Search
1913
1914- Description: Search options to enable by default when opening new project and buffer searches.
1915- Setting: `search`
1916- Default:
1917
1918```json
1919"search": {
1920 "whole_word": false,
1921 "case_sensitive": false,
1922 "include_ignored": false,
1923 "regex": false
1924},
1925```
1926
1927## Seed Search Query From Cursor
1928
1929- Description: When to populate a new search's query based on the text under the cursor.
1930- Setting: `seed_search_query_from_cursor`
1931- Default: `always`
1932
1933**Options**
1934
19351. `always` always populate the search query with the word under the cursor
19362. `selection` only populate the search query when there is text selected
19373. `never` never populate the search query
1938
1939## Use Smartcase Search
1940
1941- 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. \
1942 This applies to both in-file searches and project-wide searches.
1943
1944 Examples:
1945
1946 - Searching for "function" would match "function", "Function", "FUNCTION", etc.
1947 - Searching for "Function" would only match "Function", not "function" or "FUNCTION"
1948
1949- Setting: `use_smartcase_search`
1950- Default: `false`
1951
1952**Options**
1953
1954`boolean` values
1955
1956## Show Call Status Icon
1957
1958- Description: Whether or not to show the call status icon in the status bar.
1959- Setting: `show_call_status_icon`
1960- Default: `true`
1961
1962**Options**
1963
1964`boolean` values
1965
1966## Show Completions On Input
1967
1968- Description: Whether or not to show completions as you type.
1969- Setting: `show_completions_on_input`
1970- Default: `true`
1971
1972**Options**
1973
1974`boolean` values
1975
1976## Show Completion Documentation
1977
1978- Description: Whether to display inline and alongside documentation for items in the completions menu.
1979- Setting: `show_completion_documentation`
1980- Default: `true`
1981
1982**Options**
1983
1984`boolean` values
1985
1986## Show Edit Predictions
1987
1988- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
1989- Setting: `show_edit_predictions`
1990- Default: `true`
1991
1992**Options**
1993
1994`boolean` values
1995
1996## Show Whitespaces
1997
1998- Description: Whether or not to show render whitespace characters in the editor.
1999- Setting: `show_whitespaces`
2000- Default: `selection`
2001
2002**Options**
2003
20041. `all`
20052. `selection`
20063. `none`
20074. `boundary`
2008
2009## Soft Wrap
2010
2011- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
2012- Setting: `soft_wrap`
2013- Default: `none`
2014
2015**Options**
2016
20171. `none` to avoid wrapping generally, unless the line is too long
20182. `prefer_line` (deprecated, same as `none`)
20193. `editor_width` to wrap lines that overflow the editor width
20204. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
20215. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
2022
2023## Wrap Guides (Vertical Rulers)
2024
2025- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
2026- Setting: `wrap_guides`
2027- Default: []
2028
2029**Options**
2030
2031List of `integer` column numbers
2032
2033## Tab Size
2034
2035- Description: The number of spaces to use for each tab character.
2036- Setting: `tab_size`
2037- Default: `4`
2038
2039**Options**
2040
2041`integer` values
2042
2043## Telemetry
2044
2045- Description: Control what info is collected by Zed.
2046- Setting: `telemetry`
2047- Default:
2048
2049```json
2050"telemetry": {
2051 "diagnostics": true,
2052 "metrics": true
2053},
2054```
2055
2056**Options**
2057
2058### Diagnostics
2059
2060- Description: Setting for sending debug-related data, such as crash reports.
2061- Setting: `diagnostics`
2062- Default: `true`
2063
2064**Options**
2065
2066`boolean` values
2067
2068### Metrics
2069
2070- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
2071- Setting: `metrics`
2072- Default: `true`
2073
2074**Options**
2075
2076`boolean` values
2077
2078## Terminal
2079
2080- Description: Configuration for the terminal.
2081- Setting: `terminal`
2082- Default:
2083
2084```json
2085{
2086 "terminal": {
2087 "alternate_scroll": "off",
2088 "blinking": "terminal_controlled",
2089 "copy_on_select": false,
2090 "dock": "bottom",
2091 "detect_venv": {
2092 "on": {
2093 "directories": [".env", "env", ".venv", "venv"],
2094 "activate_script": "default"
2095 }
2096 },
2097 "env": {},
2098 "font_family": null,
2099 "font_features": null,
2100 "font_size": null,
2101 "line_height": "comfortable",
2102 "option_as_meta": false,
2103 "button": false,
2104 "shell": {},
2105 "toolbar": {
2106 "breadcrumbs": true
2107 },
2108 "working_directory": "current_project_directory",
2109 "scrollbar": {
2110 "show": null
2111 }
2112 }
2113}
2114```
2115
2116### Terminal: Dock
2117
2118- Description: Control the position of the dock
2119- Setting: `dock`
2120- Default: `bottom`
2121
2122**Options**
2123
2124`"bottom"`, `"left"` or `"right"`
2125
2126### Terminal: Alternate Scroll
2127
2128- 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.
2129- Setting: `alternate_scroll`
2130- Default: `off`
2131
2132**Options**
2133
21341. Default alternate scroll mode to on
2135
2136```json
2137{
2138 "terminal": {
2139 "alternate_scroll": "on"
2140 }
2141}
2142```
2143
21442. Default alternate scroll mode to off
2145
2146```json
2147{
2148 "terminal": {
2149 "alternate_scroll": "off"
2150 }
2151}
2152```
2153
2154### Terminal: Blinking
2155
2156- Description: Set the cursor blinking behavior in the terminal
2157- Setting: `blinking`
2158- Default: `terminal_controlled`
2159
2160**Options**
2161
21621. Never blink the cursor, ignore the terminal mode
2163
2164```json
2165{
2166 "terminal": {
2167 "blinking": "off"
2168 }
2169}
2170```
2171
21722. Default the cursor blink to off, but allow the terminal to turn blinking on
2173
2174```json
2175{
2176 "terminal": {
2177 "blinking": "terminal_controlled"
2178 }
2179}
2180```
2181
21823. Always blink the cursor, ignore the terminal mode
2183
2184```json
2185{
2186 "terminal": {
2187 "blinking": "on"
2188 }
2189}
2190```
2191
2192### Terminal: Copy On Select
2193
2194- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
2195- Setting: `copy_on_select`
2196- Default: `false`
2197
2198**Options**
2199
2200`boolean` values
2201
2202**Example**
2203
2204```json
2205{
2206 "terminal": {
2207 "copy_on_select": true
2208 }
2209}
2210```
2211
2212### Terminal: Env
2213
2214- 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
2215- Setting: `env`
2216- Default: `{}`
2217
2218**Example**
2219
2220```json
2221{
2222 "terminal": {
2223 "env": {
2224 "ZED": "1",
2225 "KEY": "value1:value2"
2226 }
2227 }
2228}
2229```
2230
2231### Terminal: Font Size
2232
2233- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
2234- Setting: `font_size`
2235- Default: `null`
2236
2237**Options**
2238
2239`integer` values
2240
2241```json
2242{
2243 "terminal": {
2244 "font_size": 15
2245 }
2246}
2247```
2248
2249### Terminal: Font Family
2250
2251- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
2252- Setting: `font_family`
2253- Default: `null`
2254
2255**Options**
2256
2257The name of any font family installed on the user's system
2258
2259```json
2260{
2261 "terminal": {
2262 "font_family": "Berkeley Mono"
2263 }
2264}
2265```
2266
2267### Terminal: Font Features
2268
2269- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
2270- Setting: `font_features`
2271- Default: `null`
2272- Platform: macOS and Windows.
2273
2274**Options**
2275
2276See Buffer Font Features
2277
2278```json
2279{
2280 "terminal": {
2281 "font_features": {
2282 "calt": false
2283 // See Buffer Font Features for more features
2284 }
2285 }
2286}
2287```
2288
2289### Terminal: Line Height
2290
2291- Description: Set the terminal's line height.
2292- Setting: `line_height`
2293- Default: `comfortable`
2294
2295**Options**
2296
22971. Use a line height that's `comfortable` for reading, 1.618. (default)
2298
2299```json
2300{
2301 "terminal": {
2302 "line_height": "comfortable"
2303 }
2304}
2305```
2306
23072. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
2308
2309```json
2310{
2311 "terminal": {
2312 "line_height": "standard"
2313 }
2314}
2315```
2316
23173. Use a custom line height.
2318
2319```json
2320{
2321 "terminal": {
2322 "line_height": {
2323 "custom": 2
2324 }
2325 }
2326}
2327```
2328
2329### Terminal: Option As Meta
2330
2331- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
2332- Setting: `option_as_meta`
2333- Default: `false`
2334
2335**Options**
2336
2337`boolean` values
2338
2339```json
2340{
2341 "terminal": {
2342 "option_as_meta": true
2343 }
2344}
2345```
2346
2347### Terminal: Shell
2348
2349- Description: What shell to use when launching the terminal.
2350- Setting: `shell`
2351- Default: `system`
2352
2353**Options**
2354
23551. Use the system's default terminal configuration (usually the `/etc/passwd` file).
2356
2357```json
2358{
2359 "terminal": {
2360 "shell": "system"
2361 }
2362}
2363```
2364
23652. A program to launch:
2366
2367```json
2368{
2369 "terminal": {
2370 "shell": {
2371 "program": "sh"
2372 }
2373 }
2374}
2375```
2376
23773. A program with arguments:
2378
2379```json
2380{
2381 "terminal": {
2382 "shell": {
2383 "with_arguments": {
2384 "program": "/bin/bash",
2385 "args": ["--login"]
2386 }
2387 }
2388 }
2389}
2390```
2391
2392## Terminal: Detect Virtual Environments {#terminal-detect_venv}
2393
2394- 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.
2395- Setting: `detect_venv`
2396- Default:
2397
2398```json
2399{
2400 "terminal": {
2401 "detect_venv": {
2402 "on": {
2403 // Default directories to search for virtual environments, relative
2404 // to the current working directory. We recommend overriding this
2405 // in your project's settings, rather than globally.
2406 "directories": [".venv", "venv"],
2407 // Can also be `csh`, `fish`, and `nushell`
2408 "activate_script": "default"
2409 }
2410 }
2411 }
2412}
2413```
2414
2415Disable with:
2416
2417```json
2418{
2419 "terminal": {
2420 "detect_venv": "off"
2421 }
2422}
2423```
2424
2425## Terminal: Toolbar
2426
2427- Description: Whether or not to show various elements in the terminal toolbar.
2428- Setting: `toolbar`
2429- Default:
2430
2431```json
2432{
2433 "terminal": {
2434 "toolbar": {
2435 "breadcrumbs": true
2436 }
2437 }
2438}
2439```
2440
2441**Options**
2442
2443At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
2444
2445If the terminal title is empty, the breadcrumbs won't be shown.
2446
2447The shell running in the terminal needs to be configured to emit the title.
2448
2449Example command to set the title: `echo -e "\e]2;New Title\007";`
2450
2451### Terminal: Button
2452
2453- Description: Control to show or hide the terminal button in the status bar
2454- Setting: `button`
2455- Default: `true`
2456
2457**Options**
2458
2459`boolean` values
2460
2461```json
2462{
2463 "terminal": {
2464 "button": false
2465 }
2466}
2467```
2468
2469### Terminal: Working Directory
2470
2471- Description: What working directory to use when launching the terminal.
2472- Setting: `working_directory`
2473- Default: `"current_project_directory"`
2474
2475**Options**
2476
24771. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
2478
2479```json
2480{
2481 "terminal": {
2482 "working_directory": "current_project_directory"
2483 }
2484}
2485```
2486
24872. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
2488
2489```json
2490{
2491 "terminal": {
2492 "working_directory": "first_project_directory"
2493 }
2494}
2495```
2496
24973. Always use this platform's home directory (if we can find it)
2498
2499```json
2500{
2501 "terminal": {
2502 "working_directory": "always_home"
2503 }
2504}
2505```
2506
25074. 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.
2508
2509```json
2510{
2511 "terminal": {
2512 "working_directory": {
2513 "always": {
2514 "directory": "~/zed/projects/"
2515 }
2516 }
2517 }
2518}
2519```
2520
2521## Theme
2522
2523- 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.
2524- Setting: `theme`
2525- Default: `One Dark`
2526
2527### Theme Object
2528
2529- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
2530- Setting: `theme`
2531- Default:
2532
2533```json
2534"theme": {
2535 "mode": "system",
2536 "dark": "One Dark",
2537 "light": "One Light"
2538},
2539```
2540
2541### Mode
2542
2543- Description: Specify theme mode.
2544- Setting: `mode`
2545- Default: `system`
2546
2547**Options**
2548
25491. Set the theme to dark mode
2550
2551```json
2552{
2553 "mode": "dark"
2554}
2555```
2556
25572. Set the theme to light mode
2558
2559```json
2560{
2561 "mode": "light"
2562}
2563```
2564
25653. Set the theme to system mode
2566
2567```json
2568{
2569 "mode": "system"
2570}
2571```
2572
2573### Dark
2574
2575- Description: The name of the dark Zed theme to use for the UI.
2576- Setting: `dark`
2577- Default: `One Dark`
2578
2579**Options**
2580
2581Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2582
2583### Light
2584
2585- Description: The name of the light Zed theme to use for the UI.
2586- Setting: `light`
2587- Default: `One Light`
2588
2589**Options**
2590
2591Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2592
2593## Vim
2594
2595- Description: Whether or not to enable vim mode (work in progress).
2596- Setting: `vim_mode`
2597- Default: `false`
2598
2599## Project Panel
2600
2601- Description: Customize project panel
2602- Setting: `project_panel`
2603- Default:
2604
2605```json
2606{
2607 "project_panel": {
2608 "button": true,
2609 "default_width": 240,
2610 "dock": "left",
2611 "entry_spacing": "comfortable",
2612 "file_icons": true,
2613 "folder_icons": true,
2614 "git_status": true,
2615 "indent_size": 20,
2616 "auto_reveal_entries": true,
2617 "auto_fold_dirs": true,
2618 "scrollbar": {
2619 "show": null
2620 },
2621 "indent_guides": {
2622 "show": "always"
2623 }
2624 }
2625}
2626```
2627
2628### Dock
2629
2630- Description: Control the position of the dock
2631- Setting: `dock`
2632- Default: `left`
2633
2634**Options**
2635
26361. Default dock position to left
2637
2638```json
2639{
2640 "dock": "left"
2641}
2642```
2643
26442. Default dock position to right
2645
2646```json
2647{
2648 "dock": "right"
2649}
2650```
2651
2652### Entry Spacing
2653
2654- Description: Spacing between worktree entries
2655- Setting: `entry_spacing`
2656- Default: `comfortable`
2657
2658**Options**
2659
26601. Comfortable entry spacing
2661
2662```json
2663{
2664 "entry_spacing": "comfortable"
2665}
2666```
2667
26682. Standard entry spacing
2669
2670```json
2671{
2672 "entry_spacing": "standard"
2673}
2674```
2675
2676### Git Status
2677
2678- Description: Indicates newly created and updated files
2679- Setting: `git_status`
2680- Default: `true`
2681
2682**Options**
2683
26841. Default enable git status
2685
2686```json
2687{
2688 "git_status": true
2689}
2690```
2691
26922. Default disable git status
2693
2694```json
2695{
2696 "git_status": false
2697}
2698```
2699
2700### Default Width
2701
2702- Description: Customize default width taken by project panel
2703- Setting: `default_width`
2704- Default: N/A width in pixels (eg: 420)
2705
2706**Options**
2707
2708`boolean` values
2709
2710### Auto Reveal Entries
2711
2712- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
2713- Setting: `auto_reveal_entries`
2714- Default: `true`
2715
2716**Options**
2717
27181. Enable auto reveal entries
2719
2720```json
2721{
2722 "auto_reveal_entries": true
2723}
2724```
2725
27262. Disable auto reveal entries
2727
2728```json
2729{
2730 "auto_reveal_entries": false
2731}
2732```
2733
2734### Auto Fold Dirs
2735
2736- Description: Whether to fold directories automatically when directory has only one directory inside.
2737- Setting: `auto_fold_dirs`
2738- Default: `true`
2739
2740**Options**
2741
27421. Enable auto fold dirs
2743
2744```json
2745{
2746 "auto_fold_dirs": true
2747}
2748```
2749
27502. Disable auto fold dirs
2751
2752```json
2753{
2754 "auto_fold_dirs": false
2755}
2756```
2757
2758### Indent Size
2759
2760- Description: Amount of indentation (in pixels) for nested items.
2761- Setting: `indent_size`
2762- Default: `20`
2763
2764### Indent Guides: Show
2765
2766- Description: Whether to show indent guides in the project panel. Possible values: "always", "never".
2767- Setting: `indent_guides`
2768
2769```json
2770"indent_guides": {
2771 "show": "always"
2772}
2773```
2774
2775**Options**
2776
27771. Show indent guides in the project panel
2778
2779```json
2780{
2781 "indent_guides": {
2782 "show": "always"
2783 }
2784}
2785```
2786
27872. Hide indent guides in the project panel
2788
2789```json
2790{
2791 "indent_guides": {
2792 "show": "never"
2793 }
2794}
2795```
2796
2797### Scrollbar: Show
2798
2799- 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.
2800- Setting: `scrollbar`
2801- Default:
2802
2803```json
2804"scrollbar": {
2805 "show": null
2806}
2807```
2808
2809**Options**
2810
28111. Show scrollbar in the project panel
2812
2813```json
2814{
2815 "scrollbar": {
2816 "show": "always"
2817 }
2818}
2819```
2820
28212. Hide scrollbar in the project panel
2822
2823```json
2824{
2825 "scrollbar": {
2826 "show": "never"
2827 }
2828}
2829```
2830
2831## Assistant Panel
2832
2833- Description: Customize assistant panel
2834- Setting: `assistant`
2835- Default:
2836
2837```json
2838"assistant": {
2839 "enabled": true,
2840 "button": true,
2841 "dock": "right",
2842 "default_width": 640,
2843 "default_height": 320,
2844 "provider": "openai",
2845 "version": "1",
2846},
2847```
2848
2849## Outline Panel
2850
2851- Description: Customize outline Panel
2852- Setting: `outline_panel`
2853- Default:
2854
2855```json
2856"outline_panel": {
2857 "button": true,
2858 "default_width": 240,
2859 "dock": "left",
2860 "file_icons": true,
2861 "folder_icons": true,
2862 "git_status": true,
2863 "indent_size": 20,
2864 "auto_reveal_entries": true,
2865 "auto_fold_dirs": true,
2866 "indent_guides": {
2867 "show": "always"
2868 },
2869 "scrollbar": {
2870 "show": null
2871 }
2872}
2873```
2874
2875## Calls
2876
2877- Description: Customize behavior when participating in a call
2878- Setting: `calls`
2879- Default:
2880
2881```json
2882"calls": {
2883 // Join calls with the microphone live by default
2884 "mute_on_join": false,
2885 // Share your project when you are the first to join a channel
2886 "share_on_join": false
2887},
2888```
2889
2890## Unnecessary Code Fade
2891
2892- Description: How much to fade out unused code.
2893- Setting: `unnecessary_code_fade`
2894- Default: `0.3`
2895
2896**Options**
2897
2898Float values between `0.0` and `0.9`, where:
2899
2900- `0.0` means no fading (unused code looks the same as used code)
2901- `0.9` means maximum fading (unused code is very faint but still visible)
2902
2903**Example**
2904
2905```json
2906{
2907 "unnecessary_code_fade": 0.5
2908}
2909```
2910
2911## UI Font Family
2912
2913- Description: The name of the font to use for text in the UI.
2914- Setting: `ui_font_family`
2915- Default: `Zed Plex Sans`
2916
2917**Options**
2918
2919The name of any font family installed on the system.
2920
2921## UI Font Features
2922
2923- Description: The OpenType features to enable for text in the UI.
2924- Setting: `ui_font_features`
2925- Default: `null`
2926- Platform: macOS and Windows.
2927
2928**Options**
2929
2930Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
2931
2932For example, to disable font ligatures, add the following to your settings:
2933
2934```json
2935{
2936 "ui_font_features": {
2937 "calt": false
2938 }
2939}
2940```
2941
2942You can also set other OpenType features, like setting `cv01` to `7`:
2943
2944```json
2945{
2946 "ui_font_features": {
2947 "cv01": 7
2948 }
2949}
2950```
2951
2952## UI Font Fallbacks
2953
2954- Description: The font fallbacks to use for text in the UI.
2955- Setting: `ui_font_fallbacks`
2956- Default: `null`
2957- Platform: macOS and Windows.
2958
2959**Options**
2960
2961For example, to use `Nerd Font` as a fallback, add the following to your settings:
2962
2963```json
2964{
2965 "ui_font_fallbacks": ["Nerd Font"]
2966}
2967```
2968
2969## UI Font Size
2970
2971- Description: The default font size for text in the UI.
2972- Setting: `ui_font_size`
2973- Default: `16`
2974
2975**Options**
2976
2977`integer` values from `6` to `100` pixels (inclusive)
2978
2979## UI Font Weight
2980
2981- Description: The default font weight for text in the UI.
2982- Setting: `ui_font_weight`
2983- Default: `400`
2984
2985**Options**
2986
2987`integer` values between `100` and `900`
2988
2989## An example configuration:
2990
2991```json
2992// ~/.config/zed/settings.json
2993{
2994 "theme": "cave-light",
2995 "tab_size": 2,
2996 "preferred_line_length": 80,
2997 "soft_wrap": "none",
2998
2999 "buffer_font_size": 18,
3000 "buffer_font_family": "Zed Plex Mono",
3001
3002 "autosave": "on_focus_change",
3003 "format_on_save": "off",
3004 "vim_mode": false,
3005 "projects_online_by_default": true,
3006 "terminal": {
3007 "font_family": "FiraCode Nerd Font Mono",
3008 "blinking": "off"
3009 },
3010 "languages": {
3011 "C": {
3012 "format_on_save": "language_server",
3013 "preferred_line_length": 64,
3014 "soft_wrap": "preferred_line_length"
3015 }
3016 }
3017}
3018```