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