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: Whether or not to ensure there's a single newline at the end of a buffer when saving it.
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## Format On Save
974
975- Description: Whether or not to perform a buffer format before saving.
976- Setting: `format_on_save`
977- Default: `on`
978
979**Options**
980
9811. `on`, enables format on save obeying `formatter` setting:
982
983```json
984{
985 "format_on_save": "on"
986}
987```
988
9892. `off`, disables format on save:
990
991```json
992{
993 "format_on_save": "off"
994}
995```
996
997## Formatter
998
999- Description: How to perform a buffer format.
1000- Setting: `formatter`
1001- Default: `auto`
1002
1003**Options**
1004
10051. To use the current language server, use `"language_server"`:
1006
1007```json
1008{
1009 "formatter": "language_server"
1010}
1011```
1012
10132. 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):
1014
1015```json
1016{
1017 "formatter": {
1018 "external": {
1019 "command": "sed",
1020 "arguments": ["-e", "s/ *$//"]
1021 }
1022 }
1023}
1024```
1025
10263. 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.
1027
1028WARNING: `{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.
1029
1030```json
1031 "formatter": {
1032 "external": {
1033 "command": "prettier",
1034 "arguments": ["--stdin-filepath", "{buffer_path}"]
1035 }
1036 }
1037```
1038
10394. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1040
1041```json
1042{
1043 "formatter": {
1044 "code_actions": {
1045 // Use ESLint's --fix:
1046 "source.fixAll.eslint": true,
1047 // Organize imports on save:
1048 "source.organizeImports": true
1049 }
1050 }
1051}
1052```
1053
10545. Or to use multiple formatters consecutively, use an array of formatters:
1055
1056```json
1057{
1058 "formatter": [
1059 { "language_server": { "name": "rust-analyzer" } },
1060 {
1061 "external": {
1062 "command": "sed",
1063 "arguments": ["-e", "s/ *$//"]
1064 }
1065 }
1066 ]
1067}
1068```
1069
1070Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1071If any of the formatters fails, the subsequent ones will still be executed.
1072
1073## Code Actions On Format
1074
1075- Description: The code actions to perform with the primary language server when formatting the buffer.
1076- Setting: `code_actions_on_format`
1077- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
1078
1079**Examples**
1080
1081<!--
1082TBD: Add Python Ruff source.organizeImports example
1083-->
1084
10851. Organize imports on format in TypeScript and TSX buffers:
1086
1087```json
1088{
1089 "languages": {
1090 "TypeScript": {
1091 "code_actions_on_format": {
1092 "source.organizeImports": true
1093 }
1094 },
1095 "TSX": {
1096 "code_actions_on_format": {
1097 "source.organizeImports": true
1098 }
1099 }
1100 }
1101}
1102```
1103
11042. Run ESLint `fixAll` code action when formatting:
1105
1106```json
1107{
1108 "languages": {
1109 "JavaScript": {
1110 "code_actions_on_format": {
1111 "source.fixAll.eslint": true
1112 }
1113 }
1114 }
1115}
1116```
1117
11183. Run only a single ESLint rule when using `fixAll`:
1119
1120```json
1121{
1122 "languages": {
1123 "JavaScript": {
1124 "code_actions_on_format": {
1125 "source.fixAll.eslint": true
1126 }
1127 }
1128 },
1129 "lsp": {
1130 "eslint": {
1131 "settings": {
1132 "codeActionOnSave": {
1133 "rules": ["import/order"]
1134 }
1135 }
1136 }
1137 }
1138}
1139```
1140
1141## Auto close
1142
1143- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1144- Setting: `use_autoclose`
1145- Default: `true`
1146
1147**Options**
1148
1149`boolean` values
1150
1151## Always Treat Brackets As Autoclosed
1152
1153- Description: Controls how the editor handles the autoclosed characters.
1154- Setting: `always_treat_brackets_as_autoclosed`
1155- Default: `false`
1156
1157**Options**
1158
1159`boolean` values
1160
1161**Example**
1162
1163If the setting is set to `true`:
1164
11651. Enter in the editor: `)))`
11662. Move the cursor to the start: `^)))`
11673. Enter again: `)))`
1168
1169The result is still `)))` and not `))))))`, which is what it would be by default.
1170
1171## File Scan Exclusions
1172
1173- Setting: `file_scan_exclusions`
1174- 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`.
1175- Default:
1176
1177```json
1178"file_scan_exclusions": [
1179 "**/.git",
1180 "**/.svn",
1181 "**/.hg",
1182 "**/.jj",
1183 "**/CVS",
1184 "**/.DS_Store",
1185 "**/Thumbs.db",
1186 "**/.classpath",
1187 "**/.settings"
1188],
1189```
1190
1191Note, 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.
1192
1193## File Scan Inclusions
1194
1195- Setting: `file_scan_inclusions`
1196- 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.
1197- Default:
1198
1199```json
1200"file_scan_inclusions": [".env*"],
1201```
1202
1203## File Types
1204
1205- Setting: `file_types`
1206- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1207- Default: `{}`
1208
1209**Examples**
1210
1211To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1212
1213```json
1214{
1215 "file_types": {
1216 "C++": ["c"],
1217 "TOML": ["MyLockFile"],
1218 "Dockerfile": ["Dockerfile*"]
1219 }
1220}
1221```
1222
1223## Diagnostics
1224
1225- Description: Configuration for diagnostics-related features.
1226- Setting: `diagnostics`
1227- Default:
1228
1229```json
1230{
1231 "diagnostics": {
1232 "include_warnings": true,
1233 "inline": {
1234 "enabled": false
1235 }
1236 "update_with_cursor": false,
1237 "primary_only": false,
1238 "use_rendered": false,
1239 }
1240}
1241```
1242
1243### Inline Diagnostics
1244
1245- Description: Whether or not to show diagnostics information inline.
1246- Setting: `inline`
1247- Default:
1248
1249```json
1250{
1251 "diagnostics": {
1252 "inline": {
1253 "enabled": false,
1254 "update_debounce_ms": 150,
1255 "padding": 4,
1256 "min_column": 0,
1257 "max_severity": null
1258 }
1259 }
1260}
1261```
1262
1263**Options**
1264
12651. Enable inline diagnostics.
1266
1267```json
1268{
1269 "diagnostics": {
1270 "inline": {
1271 "enabled": true
1272 }
1273 }
1274}
1275```
1276
12772. Delay diagnostic updates until some time after the last diagnostic update.
1278
1279```json
1280{
1281 "diagnostics": {
1282 "inline": {
1283 "enabled": true,
1284 "update_debounce_ms": 150
1285 }
1286 }
1287}
1288```
1289
12903. Set padding between the end of the source line and the start of the diagnostic.
1291
1292```json
1293{
1294 "diagnostics": {
1295 "inline": {
1296 "enabled": true,
1297 "padding": 4
1298 }
1299 }
1300}
1301```
1302
13034. Horizontally align inline diagnostics at the given column.
1304
1305```json
1306{
1307 "diagnostics": {
1308 "inline": {
1309 "enabled": true,
1310 "min_column": 80
1311 }
1312 }
1313}
1314```
1315
13165. Show only warning and error diagnostics.
1317
1318```json
1319{
1320 "diagnostics": {
1321 "inline": {
1322 "enabled": true,
1323 "max_severity": "warning"
1324 }
1325 }
1326}
1327```
1328
1329## Git
1330
1331- Description: Configuration for git-related features.
1332- Setting: `git`
1333- Default:
1334
1335```json
1336{
1337 "git": {
1338 "git_gutter": "tracked_files",
1339 "inline_blame": {
1340 "enabled": true
1341 }
1342 }
1343}
1344```
1345
1346### Git Gutter
1347
1348- Description: Whether or not to show the git gutter.
1349- Setting: `git_gutter`
1350- Default: `tracked_files`
1351
1352**Options**
1353
13541. Show git gutter in tracked files
1355
1356```json
1357{
1358 "git": {
1359 "git_gutter": "tracked_files"
1360 }
1361}
1362```
1363
13642. Hide git gutter
1365
1366```json
1367{
1368 "git": {
1369 "git_gutter": "hide"
1370 }
1371}
1372```
1373
1374### Inline Git Blame
1375
1376- Description: Whether or not to show git blame information inline, on the currently focused line.
1377- Setting: `inline_blame`
1378- Default:
1379
1380```json
1381{
1382 "git": {
1383 "inline_blame": {
1384 "enabled": true
1385 }
1386 }
1387}
1388```
1389
1390**Options**
1391
13921. Disable inline git blame:
1393
1394```json
1395{
1396 "git": {
1397 "inline_blame": {
1398 "enabled": false
1399 }
1400 }
1401}
1402```
1403
14042. Only show inline git blame after a delay (that starts after cursor stops moving):
1405
1406```json
1407{
1408 "git": {
1409 "inline_blame": {
1410 "enabled": true,
1411 "delay_ms": 500
1412 }
1413 }
1414}
1415```
1416
14173. Show a commit summary next to the commit date and author:
1418
1419```json
1420{
1421 "git": {
1422 "inline_blame": {
1423 "enabled": true,
1424 "show_commit_summary": true
1425 }
1426 }
1427}
1428```
1429
14304. Use this as the minimum column at which to display inline blame information:
1431
1432```json
1433{
1434 "git": {
1435 "inline_blame": {
1436 "enabled": true,
1437 "min_column": 80
1438 }
1439 }
1440}
1441```
1442
1443## Indent Guides
1444
1445- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
1446- Setting: `indent_guides`
1447- Default:
1448
1449```json
1450{
1451 "indent_guides": {
1452 "enabled": true,
1453 "line_width": 1,
1454 "active_line_width": 1,
1455 "coloring": "fixed",
1456 "background_coloring": "disabled"
1457 }
1458}
1459```
1460
1461**Options**
1462
14631. Disable indent guides
1464
1465```json
1466{
1467 "indent_guides": {
1468 "enabled": false
1469 }
1470}
1471```
1472
14732. Enable indent guides for a specific language.
1474
1475```json
1476{
1477 "languages": {
1478 "Python": {
1479 "indent_guides": {
1480 "enabled": true
1481 }
1482 }
1483 }
1484}
1485```
1486
14873. Enable indent aware coloring ("rainbow indentation").
1488 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.
1489
1490```json
1491{
1492 "indent_guides": {
1493 "enabled": true,
1494 "coloring": "indent_aware"
1495 }
1496}
1497```
1498
14994. Enable indent aware background coloring ("rainbow indentation").
1500 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.
1501
1502```json
1503{
1504 "indent_guides": {
1505 "enabled": true,
1506 "coloring": "indent_aware",
1507 "background_coloring": "indent_aware"
1508 }
1509}
1510```
1511
1512## Hard Tabs
1513
1514- Description: Whether to indent lines using tab characters or multiple spaces.
1515- Setting: `hard_tabs`
1516- Default: `false`
1517
1518**Options**
1519
1520`boolean` values
1521
1522## Hover Popover Enabled
1523
1524- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
1525- Setting: `hover_popover_enabled`
1526- Default: `true`
1527
1528**Options**
1529
1530`boolean` values
1531
1532## Inlay hints
1533
1534- Description: Configuration for displaying extra text with hints in the editor.
1535- Setting: `inlay_hints`
1536- Default:
1537
1538```json
1539"inlay_hints": {
1540 "enabled": false,
1541 "show_type_hints": true,
1542 "show_parameter_hints": true,
1543 "show_other_hints": true,
1544 "show_background": false,
1545 "edit_debounce_ms": 700,
1546 "scroll_debounce_ms": 50,
1547 "toggle_on_modifiers_press": null
1548}
1549```
1550
1551**Options**
1552
1553Inlay hints querying consists of two parts: editor (client) and LSP server.
1554With 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.
1555At 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.
1556
1557The following languages have inlay hints preconfigured by Zed:
1558
1559- [Go](https://docs.zed.dev/languages/go)
1560- [Rust](https://docs.zed.dev/languages/rust)
1561- [Svelte](https://docs.zed.dev/languages/svelte)
1562- [Typescript](https://docs.zed.dev/languages/typescript)
1563
1564Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
1565
1566Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
1567Settings-related hint updates are not debounced.
1568
1569All possible config values for `toggle_on_modifiers_press` are:
1570
1571```json
1572"inlay_hints": {
1573 "toggle_on_modifiers_press": {
1574 "control": true,
1575 "shift": true,
1576 "alt": true,
1577 "platform": true,
1578 "function": true
1579 }
1580}
1581```
1582
1583Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
1584
1585## Journal
1586
1587- Description: Configuration for the journal.
1588- Setting: `journal`
1589- Default:
1590
1591```json
1592"journal": {
1593 "path": "~",
1594 "hour_format": "hour12"
1595}
1596```
1597
1598### Path
1599
1600- Description: The path of the directory where journal entries are stored.
1601- Setting: `path`
1602- Default: `~`
1603
1604**Options**
1605
1606`string` values
1607
1608### Hour Format
1609
1610- Description: The format to use for displaying hours in the journal.
1611- Setting: `hour_format`
1612- Default: `hour12`
1613
1614**Options**
1615
16161. 12-hour format:
1617
1618```json
1619{
1620 "hour_format": "hour12"
1621}
1622```
1623
16242. 24-hour format:
1625
1626```json
1627{
1628 "hour_format": "hour24"
1629}
1630```
1631
1632## Languages
1633
1634- Description: Configuration for specific languages.
1635- Setting: `languages`
1636- Default: `null`
1637
1638**Options**
1639
1640To override settings for a language, add an entry for that languages name to the `languages` value. Example:
1641
1642```json
1643"languages": {
1644 "C": {
1645 "format_on_save": "off",
1646 "preferred_line_length": 64,
1647 "soft_wrap": "preferred_line_length"
1648 },
1649 "JSON": {
1650 "tab_size": 4
1651 }
1652}
1653```
1654
1655The following settings can be overridden for each specific language:
1656
1657- [`enable_language_server`](#enable-language-server)
1658- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
1659- [`format_on_save`](#format-on-save)
1660- [`formatter`](#formatter)
1661- [`hard_tabs`](#hard-tabs)
1662- [`preferred_line_length`](#preferred-line-length)
1663- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
1664- [`show_edit_predictions`](#show-edit-predictions)
1665- [`show_whitespaces`](#show-whitespaces)
1666- [`soft_wrap`](#soft-wrap)
1667- [`tab_size`](#tab-size)
1668- [`use_autoclose`](#use-autoclose)
1669- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
1670
1671These values take in the same options as the root-level settings with the same name.
1672
1673## Network Proxy
1674
1675- Description: Configure a network proxy for Zed.
1676- Setting: `proxy`
1677- Default: `null`
1678
1679**Options**
1680
1681The proxy setting must contain a URL to the proxy.
1682
1683The following URI schemes are supported:
1684
1685- `http`
1686- `https`
1687- `socks4` - SOCKS4 proxy with local DNS
1688- `socks4a` - SOCKS4 proxy with remote DNS
1689- `socks5` - SOCKS5 proxy with local DNS
1690- `socks5h` - SOCKS5 proxy with remote DNS
1691
1692`http` will be used when no scheme is specified.
1693
1694By 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`.
1695
1696For example, to set an `http` proxy, add the following to your settings:
1697
1698```json
1699{
1700 "proxy": "http://127.0.0.1:10809"
1701}
1702```
1703
1704Or to set a `socks5` proxy:
1705
1706```json
1707{
1708 "proxy": "socks5h://localhost:10808"
1709}
1710```
1711
1712## Preview tabs
1713
1714- Description:
1715 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. \
1716 There are several ways to convert a preview tab into a regular tab:
1717
1718 - Double-clicking on the file
1719 - Double-clicking on the tab header
1720 - Using the `project_panel::OpenPermanent` action
1721 - Editing the file
1722 - Dragging the file to a different pane
1723
1724- Setting: `preview_tabs`
1725- Default:
1726
1727```json
1728"preview_tabs": {
1729 "enabled": true,
1730 "enable_preview_from_file_finder": false,
1731 "enable_preview_from_code_navigation": false,
1732}
1733```
1734
1735### Enable preview from file finder
1736
1737- Description: Determines whether to open files in preview mode when selected from the file finder.
1738- Setting: `enable_preview_from_file_finder`
1739- Default: `false`
1740
1741**Options**
1742
1743`boolean` values
1744
1745### Enable preview from code navigation
1746
1747- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
1748- Setting: `enable_preview_from_code_navigation`
1749- Default: `false`
1750
1751**Options**
1752
1753`boolean` values
1754
1755## File Finder
1756
1757### Modal Max Width
1758
1759- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
1760- Setting: `modal_max_width`
1761- Default: `small`
1762
1763## Preferred Line Length
1764
1765- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
1766- Setting: `preferred_line_length`
1767- Default: `80`
1768
1769**Options**
1770
1771`integer` values
1772
1773## Projects Online By Default
1774
1775- Description: Whether or not to show the online projects view by default.
1776- Setting: `projects_online_by_default`
1777- Default: `true`
1778
1779**Options**
1780
1781`boolean` values
1782
1783## Remove Trailing Whitespace On Save
1784
1785- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
1786- Setting: `remove_trailing_whitespace_on_save`
1787- Default: `true`
1788
1789**Options**
1790
1791`boolean` values
1792
1793## Search
1794
1795- Description: Search options to enable by default when opening new project and buffer searches.
1796- Setting: `search`
1797- Default:
1798
1799```json
1800"search": {
1801 "whole_word": false,
1802 "case_sensitive": false,
1803 "include_ignored": false,
1804 "regex": false
1805},
1806```
1807
1808## Seed Search Query From Cursor
1809
1810- Description: When to populate a new search's query based on the text under the cursor.
1811- Setting: `seed_search_query_from_cursor`
1812- Default: `always`
1813
1814**Options**
1815
18161. `always` always populate the search query with the word under the cursor
18172. `selection` only populate the search query when there is text selected
18183. `never` never populate the search query
1819
1820## Use Smartcase Search
1821
1822- 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. \
1823 This applies to both in-file searches and project-wide searches.
1824
1825 Examples:
1826
1827 - Searching for "function" would match "function", "Function", "FUNCTION", etc.
1828 - Searching for "Function" would only match "Function", not "function" or "FUNCTION"
1829
1830- Setting: `use_smartcase_search`
1831- Default: `false`
1832
1833**Options**
1834
1835`boolean` values
1836
1837## Show Call Status Icon
1838
1839- Description: Whether or not to show the call status icon in the status bar.
1840- Setting: `show_call_status_icon`
1841- Default: `true`
1842
1843**Options**
1844
1845`boolean` values
1846
1847## Show Completions On Input
1848
1849- Description: Whether or not to show completions as you type.
1850- Setting: `show_completions_on_input`
1851- Default: `true`
1852
1853**Options**
1854
1855`boolean` values
1856
1857## Show Completion Documentation
1858
1859- Description: Whether to display inline and alongside documentation for items in the completions menu.
1860- Setting: `show_completion_documentation`
1861- Default: `true`
1862
1863**Options**
1864
1865`boolean` values
1866
1867## Show Edit Predictions
1868
1869- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
1870- Setting: `show_edit_predictions`
1871- Default: `true`
1872
1873**Options**
1874
1875`boolean` values
1876
1877## Show Whitespaces
1878
1879- Description: Whether or not to show render whitespace characters in the editor.
1880- Setting: `show_whitespaces`
1881- Default: `selection`
1882
1883**Options**
1884
18851. `all`
18862. `selection`
18873. `none`
18884. `boundary`
1889
1890## Soft Wrap
1891
1892- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
1893- Setting: `soft_wrap`
1894- Default: `none`
1895
1896**Options**
1897
18981. `none` to avoid wrapping generally, unless the line is too long
18992. `prefer_line` (deprecated, same as `none`)
19003. `editor_width` to wrap lines that overflow the editor width
19014. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
19025. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
1903
1904## Wrap Guides (Vertical Rulers)
1905
1906- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
1907- Setting: `wrap_guides`
1908- Default: []
1909
1910**Options**
1911
1912List of `integer` column numbers
1913
1914## Tab Size
1915
1916- Description: The number of spaces to use for each tab character.
1917- Setting: `tab_size`
1918- Default: `4`
1919
1920**Options**
1921
1922`integer` values
1923
1924## Telemetry
1925
1926- Description: Control what info is collected by Zed.
1927- Setting: `telemetry`
1928- Default:
1929
1930```json
1931"telemetry": {
1932 "diagnostics": true,
1933 "metrics": true
1934},
1935```
1936
1937**Options**
1938
1939### Diagnostics
1940
1941- Description: Setting for sending debug-related data, such as crash reports.
1942- Setting: `diagnostics`
1943- Default: `true`
1944
1945**Options**
1946
1947`boolean` values
1948
1949### Metrics
1950
1951- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
1952- Setting: `metrics`
1953- Default: `true`
1954
1955**Options**
1956
1957`boolean` values
1958
1959## Terminal
1960
1961- Description: Configuration for the terminal.
1962- Setting: `terminal`
1963- Default:
1964
1965```json
1966{
1967 "terminal": {
1968 "alternate_scroll": "off",
1969 "blinking": "terminal_controlled",
1970 "copy_on_select": false,
1971 "dock": "bottom",
1972 "detect_venv": {
1973 "on": {
1974 "directories": [".env", "env", ".venv", "venv"],
1975 "activate_script": "default"
1976 }
1977 },
1978 "env": {},
1979 "font_family": null,
1980 "font_features": null,
1981 "font_size": null,
1982 "line_height": "comfortable",
1983 "option_as_meta": false,
1984 "button": false,
1985 "shell": {},
1986 "toolbar": {
1987 "breadcrumbs": true
1988 },
1989 "working_directory": "current_project_directory",
1990 "scrollbar": {
1991 "show": null
1992 }
1993 }
1994}
1995```
1996
1997### Terminal: Dock
1998
1999- Description: Control the position of the dock
2000- Setting: `dock`
2001- Default: `bottom`
2002
2003**Options**
2004
2005`"bottom"`, `"left"` or `"right"`
2006
2007### Terminal: Alternate Scroll
2008
2009- 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.
2010- Setting: `alternate_scroll`
2011- Default: `off`
2012
2013**Options**
2014
20151. Default alternate scroll mode to on
2016
2017```json
2018{
2019 "terminal": {
2020 "alternate_scroll": "on"
2021 }
2022}
2023```
2024
20252. Default alternate scroll mode to off
2026
2027```json
2028{
2029 "terminal": {
2030 "alternate_scroll": "off"
2031 }
2032}
2033```
2034
2035### Terminal: Blinking
2036
2037- Description: Set the cursor blinking behavior in the terminal
2038- Setting: `blinking`
2039- Default: `terminal_controlled`
2040
2041**Options**
2042
20431. Never blink the cursor, ignore the terminal mode
2044
2045```json
2046{
2047 "terminal": {
2048 "blinking": "off"
2049 }
2050}
2051```
2052
20532. Default the cursor blink to off, but allow the terminal to turn blinking on
2054
2055```json
2056{
2057 "terminal": {
2058 "blinking": "terminal_controlled"
2059 }
2060}
2061```
2062
20633. Always blink the cursor, ignore the terminal mode
2064
2065```json
2066{
2067 "terminal": {
2068 "blinking": "on"
2069 }
2070}
2071```
2072
2073### Terminal: Copy On Select
2074
2075- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
2076- Setting: `copy_on_select`
2077- Default: `false`
2078
2079**Options**
2080
2081`boolean` values
2082
2083**Example**
2084
2085```json
2086{
2087 "terminal": {
2088 "copy_on_select": true
2089 }
2090}
2091```
2092
2093### Terminal: Env
2094
2095- 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
2096- Setting: `env`
2097- Default: `{}`
2098
2099**Example**
2100
2101```json
2102{
2103 "terminal": {
2104 "env": {
2105 "ZED": "1",
2106 "KEY": "value1:value2"
2107 }
2108 }
2109}
2110```
2111
2112### Terminal: Font Size
2113
2114- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
2115- Setting: `font_size`
2116- Default: `null`
2117
2118**Options**
2119
2120`integer` values
2121
2122```json
2123{
2124 "terminal": {
2125 "font_size": 15
2126 }
2127}
2128```
2129
2130### Terminal: Font Family
2131
2132- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
2133- Setting: `font_family`
2134- Default: `null`
2135
2136**Options**
2137
2138The name of any font family installed on the user's system
2139
2140```json
2141{
2142 "terminal": {
2143 "font_family": "Berkeley Mono"
2144 }
2145}
2146```
2147
2148### Terminal: Font Features
2149
2150- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
2151- Setting: `font_features`
2152- Default: `null`
2153- Platform: macOS and Windows.
2154
2155**Options**
2156
2157See Buffer Font Features
2158
2159```json
2160{
2161 "terminal": {
2162 "font_features": {
2163 "calt": false
2164 // See Buffer Font Features for more features
2165 }
2166 }
2167}
2168```
2169
2170### Terminal: Line Height
2171
2172- Description: Set the terminal's line height.
2173- Setting: `line_height`
2174- Default: `comfortable`
2175
2176**Options**
2177
21781. Use a line height that's `comfortable` for reading, 1.618. (default)
2179
2180```json
2181{
2182 "terminal": {
2183 "line_height": "comfortable"
2184 }
2185}
2186```
2187
21882. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
2189
2190```json
2191{
2192 "terminal": {
2193 "line_height": "standard"
2194 }
2195}
2196```
2197
21983. Use a custom line height.
2199
2200```json
2201{
2202 "terminal": {
2203 "line_height": {
2204 "custom": 2
2205 }
2206 }
2207}
2208```
2209
2210### Terminal: Option As Meta
2211
2212- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
2213- Setting: `option_as_meta`
2214- Default: `false`
2215
2216**Options**
2217
2218`boolean` values
2219
2220```json
2221{
2222 "terminal": {
2223 "option_as_meta": true
2224 }
2225}
2226```
2227
2228### Terminal: Shell
2229
2230- Description: What shell to use when launching the terminal.
2231- Setting: `shell`
2232- Default: `system`
2233
2234**Options**
2235
22361. Use the system's default terminal configuration (usually the `/etc/passwd` file).
2237
2238```json
2239{
2240 "terminal": {
2241 "shell": "system"
2242 }
2243}
2244```
2245
22462. A program to launch:
2247
2248```json
2249{
2250 "terminal": {
2251 "shell": {
2252 "program": "sh"
2253 }
2254 }
2255}
2256```
2257
22583. A program with arguments:
2259
2260```json
2261{
2262 "terminal": {
2263 "shell": {
2264 "with_arguments": {
2265 "program": "/bin/bash",
2266 "args": ["--login"]
2267 }
2268 }
2269 }
2270}
2271```
2272
2273## Terminal: Detect Virtual Environments {#terminal-detect_venv}
2274
2275- 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.
2276- Setting: `detect_venv`
2277- Default:
2278
2279```json
2280{
2281 "terminal": {
2282 "detect_venv": {
2283 "on": {
2284 // Default directories to search for virtual environments, relative
2285 // to the current working directory. We recommend overriding this
2286 // in your project's settings, rather than globally.
2287 "directories": [".venv", "venv"],
2288 // Can also be `csh`, `fish`, and `nushell`
2289 "activate_script": "default"
2290 }
2291 }
2292 }
2293}
2294```
2295
2296Disable with:
2297
2298```json
2299{
2300 "terminal": {
2301 "detect_venv": "off"
2302 }
2303}
2304```
2305
2306## Terminal: Toolbar
2307
2308- Description: Whether or not to show various elements in the terminal toolbar.
2309- Setting: `toolbar`
2310- Default:
2311
2312```json
2313{
2314 "terminal": {
2315 "toolbar": {
2316 "breadcrumbs": true
2317 }
2318 }
2319}
2320```
2321
2322**Options**
2323
2324At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
2325
2326If the terminal title is empty, the breadcrumbs won't be shown.
2327
2328The shell running in the terminal needs to be configured to emit the title.
2329
2330Example command to set the title: `echo -e "\e]2;New Title\007";`
2331
2332### Terminal: Button
2333
2334- Description: Control to show or hide the terminal button in the status bar
2335- Setting: `button`
2336- Default: `true`
2337
2338**Options**
2339
2340`boolean` values
2341
2342```json
2343{
2344 "terminal": {
2345 "button": false
2346 }
2347}
2348```
2349
2350### Terminal: Working Directory
2351
2352- Description: What working directory to use when launching the terminal.
2353- Setting: `working_directory`
2354- Default: `"current_project_directory"`
2355
2356**Options**
2357
23581. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
2359
2360```json
2361{
2362 "terminal": {
2363 "working_directory": "current_project_directory"
2364 }
2365}
2366```
2367
23682. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
2369
2370```json
2371{
2372 "terminal": {
2373 "working_directory": "first_project_directory"
2374 }
2375}
2376```
2377
23783. Always use this platform's home directory (if we can find it)
2379
2380```json
2381{
2382 "terminal": {
2383 "working_directory": "always_home"
2384 }
2385}
2386```
2387
23884. 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.
2389
2390```json
2391{
2392 "terminal": {
2393 "working_directory": {
2394 "always": {
2395 "directory": "~/zed/projects/"
2396 }
2397 }
2398 }
2399}
2400```
2401
2402## Theme
2403
2404- 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.
2405- Setting: `theme`
2406- Default: `One Dark`
2407
2408### Theme Object
2409
2410- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
2411- Setting: `theme`
2412- Default:
2413
2414```json
2415"theme": {
2416 "mode": "system",
2417 "dark": "One Dark",
2418 "light": "One Light"
2419},
2420```
2421
2422### Mode
2423
2424- Description: Specify theme mode.
2425- Setting: `mode`
2426- Default: `system`
2427
2428**Options**
2429
24301. Set the theme to dark mode
2431
2432```json
2433{
2434 "mode": "dark"
2435}
2436```
2437
24382. Set the theme to light mode
2439
2440```json
2441{
2442 "mode": "light"
2443}
2444```
2445
24463. Set the theme to system mode
2447
2448```json
2449{
2450 "mode": "system"
2451}
2452```
2453
2454### Dark
2455
2456- Description: The name of the dark Zed theme to use for the UI.
2457- Setting: `dark`
2458- Default: `One Dark`
2459
2460**Options**
2461
2462Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2463
2464### Light
2465
2466- Description: The name of the light Zed theme to use for the UI.
2467- Setting: `light`
2468- Default: `One Light`
2469
2470**Options**
2471
2472Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2473
2474## Vim
2475
2476- Description: Whether or not to enable vim mode (work in progress).
2477- Setting: `vim_mode`
2478- Default: `false`
2479
2480## Project Panel
2481
2482- Description: Customize project panel
2483- Setting: `project_panel`
2484- Default:
2485
2486```json
2487{
2488 "project_panel": {
2489 "button": true,
2490 "default_width": 240,
2491 "dock": "left",
2492 "entry_spacing": "comfortable",
2493 "file_icons": true,
2494 "folder_icons": true,
2495 "git_status": true,
2496 "indent_size": 20,
2497 "indent_guides": true,
2498 "auto_reveal_entries": true,
2499 "auto_fold_dirs": true,
2500 "scrollbar": {
2501 "show": null
2502 },
2503 "indent_guides": {
2504 "show": "always"
2505 }
2506 }
2507}
2508```
2509
2510### Dock
2511
2512- Description: Control the position of the dock
2513- Setting: `dock`
2514- Default: `left`
2515
2516**Options**
2517
25181. Default dock position to left
2519
2520```json
2521{
2522 "dock": "left"
2523}
2524```
2525
25262. Default dock position to right
2527
2528```json
2529{
2530 "dock": "right"
2531}
2532```
2533
2534### Entry Spacing
2535
2536- Description: Spacing between worktree entries
2537- Setting: `entry_spacing`
2538- Default: `comfortable`
2539
2540**Options**
2541
25421. Comfortable entry spacing
2543
2544```json
2545{
2546 "entry_spacing": "comfortable"
2547}
2548```
2549
25502. Standard entry spacing
2551
2552```json
2553{
2554 "entry_spacing": "standard"
2555}
2556```
2557
2558### Git Status
2559
2560- Description: Indicates newly created and updated files
2561- Setting: `git_status`
2562- Default: `true`
2563
2564**Options**
2565
25661. Default enable git status
2567
2568```json
2569{
2570 "git_status": true
2571}
2572```
2573
25742. Default disable git status
2575
2576```json
2577{
2578 "git_status": false
2579}
2580```
2581
2582### Default Width
2583
2584- Description: Customize default width taken by project panel
2585- Setting: `default_width`
2586- Default: N/A width in pixels (eg: 420)
2587
2588**Options**
2589
2590`boolean` values
2591
2592### Auto Reveal Entries
2593
2594- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
2595- Setting: `auto_reveal_entries`
2596- Default: `true`
2597
2598**Options**
2599
26001. Enable auto reveal entries
2601
2602```json
2603{
2604 "auto_reveal_entries": true
2605}
2606```
2607
26082. Disable auto reveal entries
2609
2610```json
2611{
2612 "auto_reveal_entries": false
2613}
2614```
2615
2616### Auto Fold Dirs
2617
2618- Description: Whether to fold directories automatically when directory has only one directory inside.
2619- Setting: `auto_fold_dirs`
2620- Default: `true`
2621
2622**Options**
2623
26241. Enable auto fold dirs
2625
2626```json
2627{
2628 "auto_fold_dirs": true
2629}
2630```
2631
26322. Disable auto fold dirs
2633
2634```json
2635{
2636 "auto_fold_dirs": false
2637}
2638```
2639
2640### Indent Size
2641
2642- Description: Amount of indentation (in pixels) for nested items.
2643- Setting: `indent_size`
2644- Default: `20`
2645
2646### Indent Guides: Show
2647
2648- Description: Whether to show indent guides in the project panel. Possible values: "always", "never".
2649- Setting: `indent_guides`
2650
2651```json
2652"indent_guides": {
2653 "show": "always"
2654}
2655```
2656
2657**Options**
2658
26591. Show indent guides in the project panel
2660
2661```json
2662{
2663 "indent_guides": {
2664 "show": "always"
2665 }
2666}
2667```
2668
26692. Hide indent guides in the project panel
2670
2671```json
2672{
2673 "indent_guides": {
2674 "show": "never"
2675 }
2676}
2677```
2678
2679### Scrollbar: Show
2680
2681- 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.
2682- Setting: `scrollbar`
2683- Default:
2684
2685```json
2686"scrollbar": {
2687 "show": null
2688}
2689```
2690
2691**Options**
2692
26931. Show scrollbar in the project panel
2694
2695```json
2696{
2697 "scrollbar": {
2698 "show": "always"
2699 }
2700}
2701```
2702
27032. Hide scrollbar in the project panel
2704
2705```json
2706{
2707 "scrollbar": {
2708 "show": "never"
2709 }
2710}
2711```
2712
2713## Assistant Panel
2714
2715- Description: Customize assistant panel
2716- Setting: `assistant`
2717- Default:
2718
2719```json
2720"assistant": {
2721 "enabled": true,
2722 "button": true,
2723 "dock": "right",
2724 "default_width": 640,
2725 "default_height": 320,
2726 "provider": "openai",
2727 "version": "1",
2728},
2729```
2730
2731## Outline Panel
2732
2733- Description: Customize outline Panel
2734- Setting: `outline_panel`
2735- Default:
2736
2737```json
2738"outline_panel": {
2739 "button": true,
2740 "default_width": 240,
2741 "dock": "left",
2742 "file_icons": true,
2743 "folder_icons": true,
2744 "git_status": true,
2745 "indent_size": 20,
2746 "auto_reveal_entries": true,
2747 "auto_fold_dirs": true,
2748 "indent_guides": {
2749 "show": "always"
2750 },
2751 "scrollbar": {
2752 "show": null
2753 }
2754}
2755```
2756
2757## Calls
2758
2759- Description: Customize behavior when participating in a call
2760- Setting: `calls`
2761- Default:
2762
2763```json
2764"calls": {
2765 // Join calls with the microphone live by default
2766 "mute_on_join": false,
2767 // Share your project when you are the first to join a channel
2768 "share_on_join": false
2769},
2770```
2771
2772## Unnecessary Code Fade
2773
2774- Description: How much to fade out unused code.
2775- Setting: `unnecessary_code_fade`
2776- Default: `0.3`
2777
2778**Options**
2779
2780Float values between `0.0` and `0.9`, where:
2781
2782- `0.0` means no fading (unused code looks the same as used code)
2783- `0.9` means maximum fading (unused code is very faint but still visible)
2784
2785**Example**
2786
2787```json
2788{
2789 "unnecessary_code_fade": 0.5
2790}
2791```
2792
2793## UI Font Family
2794
2795- Description: The name of the font to use for text in the UI.
2796- Setting: `ui_font_family`
2797- Default: `Zed Plex Sans`
2798
2799**Options**
2800
2801The name of any font family installed on the system.
2802
2803## UI Font Features
2804
2805- Description: The OpenType features to enable for text in the UI.
2806- Setting: `ui_font_features`
2807- Default: `null`
2808- Platform: macOS and Windows.
2809
2810**Options**
2811
2812Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
2813
2814For example, to disable font ligatures, add the following to your settings:
2815
2816```json
2817{
2818 "ui_font_features": {
2819 "calt": false
2820 }
2821}
2822```
2823
2824You can also set other OpenType features, like setting `cv01` to `7`:
2825
2826```json
2827{
2828 "ui_font_features": {
2829 "cv01": 7
2830 }
2831}
2832```
2833
2834## UI Font Fallbacks
2835
2836- Description: The font fallbacks to use for text in the UI.
2837- Setting: `ui_font_fallbacks`
2838- Default: `null`
2839- Platform: macOS and Windows.
2840
2841**Options**
2842
2843For example, to use `Nerd Font` as a fallback, add the following to your settings:
2844
2845```json
2846{
2847 "ui_font_fallbacks": ["Nerd Font"]
2848}
2849```
2850
2851## UI Font Size
2852
2853- Description: The default font size for text in the UI.
2854- Setting: `ui_font_size`
2855- Default: `16`
2856
2857**Options**
2858
2859`integer` values from `6` to `100` pixels (inclusive)
2860
2861## UI Font Weight
2862
2863- Description: The default font weight for text in the UI.
2864- Setting: `ui_font_weight`
2865- Default: `400`
2866
2867**Options**
2868
2869`integer` values between `100` and `900`
2870
2871## An example configuration:
2872
2873```json
2874// ~/.config/zed/settings.json
2875{
2876 "theme": "cave-light",
2877 "tab_size": 2,
2878 "preferred_line_length": 80,
2879 "soft_wrap": "none",
2880
2881 "buffer_font_size": 18,
2882 "buffer_font_family": "Zed Plex Mono",
2883
2884 "autosave": "on_focus_change",
2885 "format_on_save": "off",
2886 "vim_mode": false,
2887 "projects_online_by_default": true,
2888 "terminal": {
2889 "font_family": "FiraCode Nerd Font Mono",
2890 "blinking": "off"
2891 },
2892 "languages": {
2893 "C": {
2894 "format_on_save": "language_server",
2895 "preferred_line_length": 64,
2896 "soft_wrap": "preferred_line_length"
2897 }
2898 }
2899}
2900```