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 }
1353}
1354```
1355
1356### Git Gutter
1357
1358- Description: Whether or not to show the git gutter.
1359- Setting: `git_gutter`
1360- Default: `tracked_files`
1361
1362**Options**
1363
13641. Show git gutter in tracked files
1365
1366```json
1367{
1368 "git": {
1369 "git_gutter": "tracked_files"
1370 }
1371}
1372```
1373
13742. Hide git gutter
1375
1376```json
1377{
1378 "git": {
1379 "git_gutter": "hide"
1380 }
1381}
1382```
1383
1384### Inline Git Blame
1385
1386- Description: Whether or not to show git blame information inline, on the currently focused line.
1387- Setting: `inline_blame`
1388- Default:
1389
1390```json
1391{
1392 "git": {
1393 "inline_blame": {
1394 "enabled": true
1395 }
1396 }
1397}
1398```
1399
1400**Options**
1401
14021. Disable inline git blame:
1403
1404```json
1405{
1406 "git": {
1407 "inline_blame": {
1408 "enabled": false
1409 }
1410 }
1411}
1412```
1413
14142. Only show inline git blame after a delay (that starts after cursor stops moving):
1415
1416```json
1417{
1418 "git": {
1419 "inline_blame": {
1420 "enabled": true,
1421 "delay_ms": 500
1422 }
1423 }
1424}
1425```
1426
14273. Show a commit summary next to the commit date and author:
1428
1429```json
1430{
1431 "git": {
1432 "inline_blame": {
1433 "enabled": true,
1434 "show_commit_summary": true
1435 }
1436 }
1437}
1438```
1439
14404. Use this as the minimum column at which to display inline blame information:
1441
1442```json
1443{
1444 "git": {
1445 "inline_blame": {
1446 "enabled": true,
1447 "min_column": 80
1448 }
1449 }
1450}
1451```
1452
1453## Indent Guides
1454
1455- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
1456- Setting: `indent_guides`
1457- Default:
1458
1459```json
1460{
1461 "indent_guides": {
1462 "enabled": true,
1463 "line_width": 1,
1464 "active_line_width": 1,
1465 "coloring": "fixed",
1466 "background_coloring": "disabled"
1467 }
1468}
1469```
1470
1471**Options**
1472
14731. Disable indent guides
1474
1475```json
1476{
1477 "indent_guides": {
1478 "enabled": false
1479 }
1480}
1481```
1482
14832. Enable indent guides for a specific language.
1484
1485```json
1486{
1487 "languages": {
1488 "Python": {
1489 "indent_guides": {
1490 "enabled": true
1491 }
1492 }
1493 }
1494}
1495```
1496
14973. Enable indent aware coloring ("rainbow indentation").
1498 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.
1499
1500```json
1501{
1502 "indent_guides": {
1503 "enabled": true,
1504 "coloring": "indent_aware"
1505 }
1506}
1507```
1508
15094. Enable indent aware background coloring ("rainbow indentation").
1510 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.
1511
1512```json
1513{
1514 "indent_guides": {
1515 "enabled": true,
1516 "coloring": "indent_aware",
1517 "background_coloring": "indent_aware"
1518 }
1519}
1520```
1521
1522## Hard Tabs
1523
1524- Description: Whether to indent lines using tab characters or multiple spaces.
1525- Setting: `hard_tabs`
1526- Default: `false`
1527
1528**Options**
1529
1530`boolean` values
1531
1532## Hover Popover Enabled
1533
1534- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
1535- Setting: `hover_popover_enabled`
1536- Default: `true`
1537
1538**Options**
1539
1540`boolean` values
1541
1542## Inlay hints
1543
1544- Description: Configuration for displaying extra text with hints in the editor.
1545- Setting: `inlay_hints`
1546- Default:
1547
1548```json
1549"inlay_hints": {
1550 "enabled": false,
1551 "show_type_hints": true,
1552 "show_parameter_hints": true,
1553 "show_other_hints": true,
1554 "show_background": false,
1555 "edit_debounce_ms": 700,
1556 "scroll_debounce_ms": 50,
1557 "toggle_on_modifiers_press": null
1558}
1559```
1560
1561**Options**
1562
1563Inlay hints querying consists of two parts: editor (client) and LSP server.
1564With 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.
1565At 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.
1566
1567The following languages have inlay hints preconfigured by Zed:
1568
1569- [Go](https://docs.zed.dev/languages/go)
1570- [Rust](https://docs.zed.dev/languages/rust)
1571- [Svelte](https://docs.zed.dev/languages/svelte)
1572- [Typescript](https://docs.zed.dev/languages/typescript)
1573
1574Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
1575
1576Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
1577Settings-related hint updates are not debounced.
1578
1579All possible config values for `toggle_on_modifiers_press` are:
1580
1581```json
1582"inlay_hints": {
1583 "toggle_on_modifiers_press": {
1584 "control": true,
1585 "shift": true,
1586 "alt": true,
1587 "platform": true,
1588 "function": true
1589 }
1590}
1591```
1592
1593Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
1594
1595## Journal
1596
1597- Description: Configuration for the journal.
1598- Setting: `journal`
1599- Default:
1600
1601```json
1602"journal": {
1603 "path": "~",
1604 "hour_format": "hour12"
1605}
1606```
1607
1608### Path
1609
1610- Description: The path of the directory where journal entries are stored.
1611- Setting: `path`
1612- Default: `~`
1613
1614**Options**
1615
1616`string` values
1617
1618### Hour Format
1619
1620- Description: The format to use for displaying hours in the journal.
1621- Setting: `hour_format`
1622- Default: `hour12`
1623
1624**Options**
1625
16261. 12-hour format:
1627
1628```json
1629{
1630 "hour_format": "hour12"
1631}
1632```
1633
16342. 24-hour format:
1635
1636```json
1637{
1638 "hour_format": "hour24"
1639}
1640```
1641
1642## Languages
1643
1644- Description: Configuration for specific languages.
1645- Setting: `languages`
1646- Default: `null`
1647
1648**Options**
1649
1650To override settings for a language, add an entry for that languages name to the `languages` value. Example:
1651
1652```json
1653"languages": {
1654 "C": {
1655 "format_on_save": "off",
1656 "preferred_line_length": 64,
1657 "soft_wrap": "preferred_line_length"
1658 },
1659 "JSON": {
1660 "tab_size": 4
1661 }
1662}
1663```
1664
1665The following settings can be overridden for each specific language:
1666
1667- [`enable_language_server`](#enable-language-server)
1668- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
1669- [`format_on_save`](#format-on-save)
1670- [`formatter`](#formatter)
1671- [`hard_tabs`](#hard-tabs)
1672- [`preferred_line_length`](#preferred-line-length)
1673- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
1674- [`show_edit_predictions`](#show-edit-predictions)
1675- [`show_whitespaces`](#show-whitespaces)
1676- [`soft_wrap`](#soft-wrap)
1677- [`tab_size`](#tab-size)
1678- [`use_autoclose`](#use-autoclose)
1679- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
1680
1681These values take in the same options as the root-level settings with the same name.
1682
1683## Network Proxy
1684
1685- Description: Configure a network proxy for Zed.
1686- Setting: `proxy`
1687- Default: `null`
1688
1689**Options**
1690
1691The proxy setting must contain a URL to the proxy.
1692
1693The following URI schemes are supported:
1694
1695- `http`
1696- `https`
1697- `socks4` - SOCKS4 proxy with local DNS
1698- `socks4a` - SOCKS4 proxy with remote DNS
1699- `socks5` - SOCKS5 proxy with local DNS
1700- `socks5h` - SOCKS5 proxy with remote DNS
1701
1702`http` will be used when no scheme is specified.
1703
1704By 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`.
1705
1706For example, to set an `http` proxy, add the following to your settings:
1707
1708```json
1709{
1710 "proxy": "http://127.0.0.1:10809"
1711}
1712```
1713
1714Or to set a `socks5` proxy:
1715
1716```json
1717{
1718 "proxy": "socks5h://localhost:10808"
1719}
1720```
1721
1722## Preview tabs
1723
1724- Description:
1725 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. \
1726 There are several ways to convert a preview tab into a regular tab:
1727
1728 - Double-clicking on the file
1729 - Double-clicking on the tab header
1730 - Using the `project_panel::OpenPermanent` action
1731 - Editing the file
1732 - Dragging the file to a different pane
1733
1734- Setting: `preview_tabs`
1735- Default:
1736
1737```json
1738"preview_tabs": {
1739 "enabled": true,
1740 "enable_preview_from_file_finder": false,
1741 "enable_preview_from_code_navigation": false,
1742}
1743```
1744
1745### Enable preview from file finder
1746
1747- Description: Determines whether to open files in preview mode when selected from the file finder.
1748- Setting: `enable_preview_from_file_finder`
1749- Default: `false`
1750
1751**Options**
1752
1753`boolean` values
1754
1755### Enable preview from code navigation
1756
1757- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
1758- Setting: `enable_preview_from_code_navigation`
1759- Default: `false`
1760
1761**Options**
1762
1763`boolean` values
1764
1765## File Finder
1766
1767### Modal Max Width
1768
1769- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
1770- Setting: `modal_max_width`
1771- Default: `small`
1772
1773## Preferred Line Length
1774
1775- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
1776- Setting: `preferred_line_length`
1777- Default: `80`
1778
1779**Options**
1780
1781`integer` values
1782
1783## Projects Online By Default
1784
1785- Description: Whether or not to show the online projects view by default.
1786- Setting: `projects_online_by_default`
1787- Default: `true`
1788
1789**Options**
1790
1791`boolean` values
1792
1793## Remove Trailing Whitespace On Save
1794
1795- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
1796- Setting: `remove_trailing_whitespace_on_save`
1797- Default: `true`
1798
1799**Options**
1800
1801`boolean` values
1802
1803## Search
1804
1805- Description: Search options to enable by default when opening new project and buffer searches.
1806- Setting: `search`
1807- Default:
1808
1809```json
1810"search": {
1811 "whole_word": false,
1812 "case_sensitive": false,
1813 "include_ignored": false,
1814 "regex": false
1815},
1816```
1817
1818## Seed Search Query From Cursor
1819
1820- Description: When to populate a new search's query based on the text under the cursor.
1821- Setting: `seed_search_query_from_cursor`
1822- Default: `always`
1823
1824**Options**
1825
18261. `always` always populate the search query with the word under the cursor
18272. `selection` only populate the search query when there is text selected
18283. `never` never populate the search query
1829
1830## Use Smartcase Search
1831
1832- 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. \
1833 This applies to both in-file searches and project-wide searches.
1834
1835 Examples:
1836
1837 - Searching for "function" would match "function", "Function", "FUNCTION", etc.
1838 - Searching for "Function" would only match "Function", not "function" or "FUNCTION"
1839
1840- Setting: `use_smartcase_search`
1841- Default: `false`
1842
1843**Options**
1844
1845`boolean` values
1846
1847## Show Call Status Icon
1848
1849- Description: Whether or not to show the call status icon in the status bar.
1850- Setting: `show_call_status_icon`
1851- Default: `true`
1852
1853**Options**
1854
1855`boolean` values
1856
1857## Show Completions On Input
1858
1859- Description: Whether or not to show completions as you type.
1860- Setting: `show_completions_on_input`
1861- Default: `true`
1862
1863**Options**
1864
1865`boolean` values
1866
1867## Show Completion Documentation
1868
1869- Description: Whether to display inline and alongside documentation for items in the completions menu.
1870- Setting: `show_completion_documentation`
1871- Default: `true`
1872
1873**Options**
1874
1875`boolean` values
1876
1877## Show Edit Predictions
1878
1879- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
1880- Setting: `show_edit_predictions`
1881- Default: `true`
1882
1883**Options**
1884
1885`boolean` values
1886
1887## Show Whitespaces
1888
1889- Description: Whether or not to show render whitespace characters in the editor.
1890- Setting: `show_whitespaces`
1891- Default: `selection`
1892
1893**Options**
1894
18951. `all`
18962. `selection`
18973. `none`
18984. `boundary`
1899
1900## Soft Wrap
1901
1902- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
1903- Setting: `soft_wrap`
1904- Default: `none`
1905
1906**Options**
1907
19081. `none` to avoid wrapping generally, unless the line is too long
19092. `prefer_line` (deprecated, same as `none`)
19103. `editor_width` to wrap lines that overflow the editor width
19114. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
19125. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
1913
1914## Wrap Guides (Vertical Rulers)
1915
1916- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
1917- Setting: `wrap_guides`
1918- Default: []
1919
1920**Options**
1921
1922List of `integer` column numbers
1923
1924## Tab Size
1925
1926- Description: The number of spaces to use for each tab character.
1927- Setting: `tab_size`
1928- Default: `4`
1929
1930**Options**
1931
1932`integer` values
1933
1934## Telemetry
1935
1936- Description: Control what info is collected by Zed.
1937- Setting: `telemetry`
1938- Default:
1939
1940```json
1941"telemetry": {
1942 "diagnostics": true,
1943 "metrics": true
1944},
1945```
1946
1947**Options**
1948
1949### Diagnostics
1950
1951- Description: Setting for sending debug-related data, such as crash reports.
1952- Setting: `diagnostics`
1953- Default: `true`
1954
1955**Options**
1956
1957`boolean` values
1958
1959### Metrics
1960
1961- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
1962- Setting: `metrics`
1963- Default: `true`
1964
1965**Options**
1966
1967`boolean` values
1968
1969## Terminal
1970
1971- Description: Configuration for the terminal.
1972- Setting: `terminal`
1973- Default:
1974
1975```json
1976{
1977 "terminal": {
1978 "alternate_scroll": "off",
1979 "blinking": "terminal_controlled",
1980 "copy_on_select": false,
1981 "dock": "bottom",
1982 "detect_venv": {
1983 "on": {
1984 "directories": [".env", "env", ".venv", "venv"],
1985 "activate_script": "default"
1986 }
1987 },
1988 "env": {},
1989 "font_family": null,
1990 "font_features": null,
1991 "font_size": null,
1992 "line_height": "comfortable",
1993 "option_as_meta": false,
1994 "button": false,
1995 "shell": {},
1996 "toolbar": {
1997 "breadcrumbs": true
1998 },
1999 "working_directory": "current_project_directory",
2000 "scrollbar": {
2001 "show": null
2002 }
2003 }
2004}
2005```
2006
2007### Terminal: Dock
2008
2009- Description: Control the position of the dock
2010- Setting: `dock`
2011- Default: `bottom`
2012
2013**Options**
2014
2015`"bottom"`, `"left"` or `"right"`
2016
2017### Terminal: Alternate Scroll
2018
2019- 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.
2020- Setting: `alternate_scroll`
2021- Default: `off`
2022
2023**Options**
2024
20251. Default alternate scroll mode to on
2026
2027```json
2028{
2029 "terminal": {
2030 "alternate_scroll": "on"
2031 }
2032}
2033```
2034
20352. Default alternate scroll mode to off
2036
2037```json
2038{
2039 "terminal": {
2040 "alternate_scroll": "off"
2041 }
2042}
2043```
2044
2045### Terminal: Blinking
2046
2047- Description: Set the cursor blinking behavior in the terminal
2048- Setting: `blinking`
2049- Default: `terminal_controlled`
2050
2051**Options**
2052
20531. Never blink the cursor, ignore the terminal mode
2054
2055```json
2056{
2057 "terminal": {
2058 "blinking": "off"
2059 }
2060}
2061```
2062
20632. Default the cursor blink to off, but allow the terminal to turn blinking on
2064
2065```json
2066{
2067 "terminal": {
2068 "blinking": "terminal_controlled"
2069 }
2070}
2071```
2072
20733. Always blink the cursor, ignore the terminal mode
2074
2075```json
2076{
2077 "terminal": {
2078 "blinking": "on"
2079 }
2080}
2081```
2082
2083### Terminal: Copy On Select
2084
2085- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
2086- Setting: `copy_on_select`
2087- Default: `false`
2088
2089**Options**
2090
2091`boolean` values
2092
2093**Example**
2094
2095```json
2096{
2097 "terminal": {
2098 "copy_on_select": true
2099 }
2100}
2101```
2102
2103### Terminal: Env
2104
2105- 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
2106- Setting: `env`
2107- Default: `{}`
2108
2109**Example**
2110
2111```json
2112{
2113 "terminal": {
2114 "env": {
2115 "ZED": "1",
2116 "KEY": "value1:value2"
2117 }
2118 }
2119}
2120```
2121
2122### Terminal: Font Size
2123
2124- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
2125- Setting: `font_size`
2126- Default: `null`
2127
2128**Options**
2129
2130`integer` values
2131
2132```json
2133{
2134 "terminal": {
2135 "font_size": 15
2136 }
2137}
2138```
2139
2140### Terminal: Font Family
2141
2142- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
2143- Setting: `font_family`
2144- Default: `null`
2145
2146**Options**
2147
2148The name of any font family installed on the user's system
2149
2150```json
2151{
2152 "terminal": {
2153 "font_family": "Berkeley Mono"
2154 }
2155}
2156```
2157
2158### Terminal: Font Features
2159
2160- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
2161- Setting: `font_features`
2162- Default: `null`
2163- Platform: macOS and Windows.
2164
2165**Options**
2166
2167See Buffer Font Features
2168
2169```json
2170{
2171 "terminal": {
2172 "font_features": {
2173 "calt": false
2174 // See Buffer Font Features for more features
2175 }
2176 }
2177}
2178```
2179
2180### Terminal: Line Height
2181
2182- Description: Set the terminal's line height.
2183- Setting: `line_height`
2184- Default: `comfortable`
2185
2186**Options**
2187
21881. Use a line height that's `comfortable` for reading, 1.618. (default)
2189
2190```json
2191{
2192 "terminal": {
2193 "line_height": "comfortable"
2194 }
2195}
2196```
2197
21982. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
2199
2200```json
2201{
2202 "terminal": {
2203 "line_height": "standard"
2204 }
2205}
2206```
2207
22083. Use a custom line height.
2209
2210```json
2211{
2212 "terminal": {
2213 "line_height": {
2214 "custom": 2
2215 }
2216 }
2217}
2218```
2219
2220### Terminal: Option As Meta
2221
2222- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
2223- Setting: `option_as_meta`
2224- Default: `false`
2225
2226**Options**
2227
2228`boolean` values
2229
2230```json
2231{
2232 "terminal": {
2233 "option_as_meta": true
2234 }
2235}
2236```
2237
2238### Terminal: Shell
2239
2240- Description: What shell to use when launching the terminal.
2241- Setting: `shell`
2242- Default: `system`
2243
2244**Options**
2245
22461. Use the system's default terminal configuration (usually the `/etc/passwd` file).
2247
2248```json
2249{
2250 "terminal": {
2251 "shell": "system"
2252 }
2253}
2254```
2255
22562. A program to launch:
2257
2258```json
2259{
2260 "terminal": {
2261 "shell": {
2262 "program": "sh"
2263 }
2264 }
2265}
2266```
2267
22683. A program with arguments:
2269
2270```json
2271{
2272 "terminal": {
2273 "shell": {
2274 "with_arguments": {
2275 "program": "/bin/bash",
2276 "args": ["--login"]
2277 }
2278 }
2279 }
2280}
2281```
2282
2283## Terminal: Detect Virtual Environments {#terminal-detect_venv}
2284
2285- 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.
2286- Setting: `detect_venv`
2287- Default:
2288
2289```json
2290{
2291 "terminal": {
2292 "detect_venv": {
2293 "on": {
2294 // Default directories to search for virtual environments, relative
2295 // to the current working directory. We recommend overriding this
2296 // in your project's settings, rather than globally.
2297 "directories": [".venv", "venv"],
2298 // Can also be `csh`, `fish`, and `nushell`
2299 "activate_script": "default"
2300 }
2301 }
2302 }
2303}
2304```
2305
2306Disable with:
2307
2308```json
2309{
2310 "terminal": {
2311 "detect_venv": "off"
2312 }
2313}
2314```
2315
2316## Terminal: Toolbar
2317
2318- Description: Whether or not to show various elements in the terminal toolbar.
2319- Setting: `toolbar`
2320- Default:
2321
2322```json
2323{
2324 "terminal": {
2325 "toolbar": {
2326 "breadcrumbs": true
2327 }
2328 }
2329}
2330```
2331
2332**Options**
2333
2334At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
2335
2336If the terminal title is empty, the breadcrumbs won't be shown.
2337
2338The shell running in the terminal needs to be configured to emit the title.
2339
2340Example command to set the title: `echo -e "\e]2;New Title\007";`
2341
2342### Terminal: Button
2343
2344- Description: Control to show or hide the terminal button in the status bar
2345- Setting: `button`
2346- Default: `true`
2347
2348**Options**
2349
2350`boolean` values
2351
2352```json
2353{
2354 "terminal": {
2355 "button": false
2356 }
2357}
2358```
2359
2360### Terminal: Working Directory
2361
2362- Description: What working directory to use when launching the terminal.
2363- Setting: `working_directory`
2364- Default: `"current_project_directory"`
2365
2366**Options**
2367
23681. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
2369
2370```json
2371{
2372 "terminal": {
2373 "working_directory": "current_project_directory"
2374 }
2375}
2376```
2377
23782. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
2379
2380```json
2381{
2382 "terminal": {
2383 "working_directory": "first_project_directory"
2384 }
2385}
2386```
2387
23883. Always use this platform's home directory (if we can find it)
2389
2390```json
2391{
2392 "terminal": {
2393 "working_directory": "always_home"
2394 }
2395}
2396```
2397
23984. 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.
2399
2400```json
2401{
2402 "terminal": {
2403 "working_directory": {
2404 "always": {
2405 "directory": "~/zed/projects/"
2406 }
2407 }
2408 }
2409}
2410```
2411
2412## Theme
2413
2414- 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.
2415- Setting: `theme`
2416- Default: `One Dark`
2417
2418### Theme Object
2419
2420- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
2421- Setting: `theme`
2422- Default:
2423
2424```json
2425"theme": {
2426 "mode": "system",
2427 "dark": "One Dark",
2428 "light": "One Light"
2429},
2430```
2431
2432### Mode
2433
2434- Description: Specify theme mode.
2435- Setting: `mode`
2436- Default: `system`
2437
2438**Options**
2439
24401. Set the theme to dark mode
2441
2442```json
2443{
2444 "mode": "dark"
2445}
2446```
2447
24482. Set the theme to light mode
2449
2450```json
2451{
2452 "mode": "light"
2453}
2454```
2455
24563. Set the theme to system mode
2457
2458```json
2459{
2460 "mode": "system"
2461}
2462```
2463
2464### Dark
2465
2466- Description: The name of the dark Zed theme to use for the UI.
2467- Setting: `dark`
2468- Default: `One Dark`
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### Light
2475
2476- Description: The name of the light Zed theme to use for the UI.
2477- Setting: `light`
2478- Default: `One Light`
2479
2480**Options**
2481
2482Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2483
2484## Vim
2485
2486- Description: Whether or not to enable vim mode (work in progress).
2487- Setting: `vim_mode`
2488- Default: `false`
2489
2490## Project Panel
2491
2492- Description: Customize project panel
2493- Setting: `project_panel`
2494- Default:
2495
2496```json
2497{
2498 "project_panel": {
2499 "button": true,
2500 "default_width": 240,
2501 "dock": "left",
2502 "entry_spacing": "comfortable",
2503 "file_icons": true,
2504 "folder_icons": true,
2505 "git_status": true,
2506 "indent_size": 20,
2507 "indent_guides": true,
2508 "auto_reveal_entries": true,
2509 "auto_fold_dirs": true,
2510 "scrollbar": {
2511 "show": null
2512 },
2513 "indent_guides": {
2514 "show": "always"
2515 }
2516 }
2517}
2518```
2519
2520### Dock
2521
2522- Description: Control the position of the dock
2523- Setting: `dock`
2524- Default: `left`
2525
2526**Options**
2527
25281. Default dock position to left
2529
2530```json
2531{
2532 "dock": "left"
2533}
2534```
2535
25362. Default dock position to right
2537
2538```json
2539{
2540 "dock": "right"
2541}
2542```
2543
2544### Entry Spacing
2545
2546- Description: Spacing between worktree entries
2547- Setting: `entry_spacing`
2548- Default: `comfortable`
2549
2550**Options**
2551
25521. Comfortable entry spacing
2553
2554```json
2555{
2556 "entry_spacing": "comfortable"
2557}
2558```
2559
25602. Standard entry spacing
2561
2562```json
2563{
2564 "entry_spacing": "standard"
2565}
2566```
2567
2568### Git Status
2569
2570- Description: Indicates newly created and updated files
2571- Setting: `git_status`
2572- Default: `true`
2573
2574**Options**
2575
25761. Default enable git status
2577
2578```json
2579{
2580 "git_status": true
2581}
2582```
2583
25842. Default disable git status
2585
2586```json
2587{
2588 "git_status": false
2589}
2590```
2591
2592### Default Width
2593
2594- Description: Customize default width taken by project panel
2595- Setting: `default_width`
2596- Default: N/A width in pixels (eg: 420)
2597
2598**Options**
2599
2600`boolean` values
2601
2602### Auto Reveal Entries
2603
2604- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
2605- Setting: `auto_reveal_entries`
2606- Default: `true`
2607
2608**Options**
2609
26101. Enable auto reveal entries
2611
2612```json
2613{
2614 "auto_reveal_entries": true
2615}
2616```
2617
26182. Disable auto reveal entries
2619
2620```json
2621{
2622 "auto_reveal_entries": false
2623}
2624```
2625
2626### Auto Fold Dirs
2627
2628- Description: Whether to fold directories automatically when directory has only one directory inside.
2629- Setting: `auto_fold_dirs`
2630- Default: `true`
2631
2632**Options**
2633
26341. Enable auto fold dirs
2635
2636```json
2637{
2638 "auto_fold_dirs": true
2639}
2640```
2641
26422. Disable auto fold dirs
2643
2644```json
2645{
2646 "auto_fold_dirs": false
2647}
2648```
2649
2650### Indent Size
2651
2652- Description: Amount of indentation (in pixels) for nested items.
2653- Setting: `indent_size`
2654- Default: `20`
2655
2656### Indent Guides: Show
2657
2658- Description: Whether to show indent guides in the project panel. Possible values: "always", "never".
2659- Setting: `indent_guides`
2660
2661```json
2662"indent_guides": {
2663 "show": "always"
2664}
2665```
2666
2667**Options**
2668
26691. Show indent guides in the project panel
2670
2671```json
2672{
2673 "indent_guides": {
2674 "show": "always"
2675 }
2676}
2677```
2678
26792. Hide indent guides in the project panel
2680
2681```json
2682{
2683 "indent_guides": {
2684 "show": "never"
2685 }
2686}
2687```
2688
2689### Scrollbar: Show
2690
2691- 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.
2692- Setting: `scrollbar`
2693- Default:
2694
2695```json
2696"scrollbar": {
2697 "show": null
2698}
2699```
2700
2701**Options**
2702
27031. Show scrollbar in the project panel
2704
2705```json
2706{
2707 "scrollbar": {
2708 "show": "always"
2709 }
2710}
2711```
2712
27132. Hide scrollbar in the project panel
2714
2715```json
2716{
2717 "scrollbar": {
2718 "show": "never"
2719 }
2720}
2721```
2722
2723## Assistant Panel
2724
2725- Description: Customize assistant panel
2726- Setting: `assistant`
2727- Default:
2728
2729```json
2730"assistant": {
2731 "enabled": true,
2732 "button": true,
2733 "dock": "right",
2734 "default_width": 640,
2735 "default_height": 320,
2736 "provider": "openai",
2737 "version": "1",
2738},
2739```
2740
2741## Outline Panel
2742
2743- Description: Customize outline Panel
2744- Setting: `outline_panel`
2745- Default:
2746
2747```json
2748"outline_panel": {
2749 "button": true,
2750 "default_width": 240,
2751 "dock": "left",
2752 "file_icons": true,
2753 "folder_icons": true,
2754 "git_status": true,
2755 "indent_size": 20,
2756 "auto_reveal_entries": true,
2757 "auto_fold_dirs": true,
2758 "indent_guides": {
2759 "show": "always"
2760 },
2761 "scrollbar": {
2762 "show": null
2763 }
2764}
2765```
2766
2767## Calls
2768
2769- Description: Customize behavior when participating in a call
2770- Setting: `calls`
2771- Default:
2772
2773```json
2774"calls": {
2775 // Join calls with the microphone live by default
2776 "mute_on_join": false,
2777 // Share your project when you are the first to join a channel
2778 "share_on_join": false
2779},
2780```
2781
2782## Unnecessary Code Fade
2783
2784- Description: How much to fade out unused code.
2785- Setting: `unnecessary_code_fade`
2786- Default: `0.3`
2787
2788**Options**
2789
2790Float values between `0.0` and `0.9`, where:
2791
2792- `0.0` means no fading (unused code looks the same as used code)
2793- `0.9` means maximum fading (unused code is very faint but still visible)
2794
2795**Example**
2796
2797```json
2798{
2799 "unnecessary_code_fade": 0.5
2800}
2801```
2802
2803## UI Font Family
2804
2805- Description: The name of the font to use for text in the UI.
2806- Setting: `ui_font_family`
2807- Default: `Zed Plex Sans`
2808
2809**Options**
2810
2811The name of any font family installed on the system.
2812
2813## UI Font Features
2814
2815- Description: The OpenType features to enable for text in the UI.
2816- Setting: `ui_font_features`
2817- Default: `null`
2818- Platform: macOS and Windows.
2819
2820**Options**
2821
2822Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
2823
2824For example, to disable font ligatures, add the following to your settings:
2825
2826```json
2827{
2828 "ui_font_features": {
2829 "calt": false
2830 }
2831}
2832```
2833
2834You can also set other OpenType features, like setting `cv01` to `7`:
2835
2836```json
2837{
2838 "ui_font_features": {
2839 "cv01": 7
2840 }
2841}
2842```
2843
2844## UI Font Fallbacks
2845
2846- Description: The font fallbacks to use for text in the UI.
2847- Setting: `ui_font_fallbacks`
2848- Default: `null`
2849- Platform: macOS and Windows.
2850
2851**Options**
2852
2853For example, to use `Nerd Font` as a fallback, add the following to your settings:
2854
2855```json
2856{
2857 "ui_font_fallbacks": ["Nerd Font"]
2858}
2859```
2860
2861## UI Font Size
2862
2863- Description: The default font size for text in the UI.
2864- Setting: `ui_font_size`
2865- Default: `16`
2866
2867**Options**
2868
2869`integer` values from `6` to `100` pixels (inclusive)
2870
2871## UI Font Weight
2872
2873- Description: The default font weight for text in the UI.
2874- Setting: `ui_font_weight`
2875- Default: `400`
2876
2877**Options**
2878
2879`integer` values between `100` and `900`
2880
2881## An example configuration:
2882
2883```json
2884// ~/.config/zed/settings.json
2885{
2886 "theme": "cave-light",
2887 "tab_size": 2,
2888 "preferred_line_length": 80,
2889 "soft_wrap": "none",
2890
2891 "buffer_font_size": 18,
2892 "buffer_font_family": "Zed Plex Mono",
2893
2894 "autosave": "on_focus_change",
2895 "format_on_save": "off",
2896 "vim_mode": false,
2897 "projects_online_by_default": true,
2898 "terminal": {
2899 "font_family": "FiraCode Nerd Font Mono",
2900 "blinking": "off"
2901 },
2902 "languages": {
2903 "C": {
2904 "format_on_save": "language_server",
2905 "preferred_line_length": 64,
2906 "soft_wrap": "preferred_line_length"
2907 }
2908 }
2909}
2910```