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: `75`
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## Git
1198
1199- Description: Configuration for git-related features.
1200- Setting: `git`
1201- Default:
1202
1203```json
1204{
1205 "git": {
1206 "git_gutter": "tracked_files",
1207 "inline_blame": {
1208 "enabled": true
1209 }
1210 }
1211}
1212```
1213
1214### Git Gutter
1215
1216- Description: Whether or not to show the git gutter.
1217- Setting: `git_gutter`
1218- Default: `tracked_files`
1219
1220**Options**
1221
12221. Show git gutter in tracked files
1223
1224```json
1225{
1226 "git": {
1227 "git_gutter": "tracked_files"
1228 }
1229}
1230```
1231
12322. Hide git gutter
1233
1234```json
1235{
1236 "git": {
1237 "git_gutter": "hide"
1238 }
1239}
1240```
1241
1242### Inline Git Blame
1243
1244- Description: Whether or not to show git blame information inline, on the currently focused line.
1245- Setting: `inline_blame`
1246- Default:
1247
1248```json
1249{
1250 "git": {
1251 "inline_blame": {
1252 "enabled": true
1253 }
1254 }
1255}
1256```
1257
1258**Options**
1259
12601. Disable inline git blame:
1261
1262```json
1263{
1264 "git": {
1265 "inline_blame": {
1266 "enabled": false
1267 }
1268 }
1269}
1270```
1271
12722. Only show inline git blame after a delay (that starts after cursor stops moving):
1273
1274```json
1275{
1276 "git": {
1277 "inline_blame": {
1278 "enabled": true,
1279 "delay_ms": 500
1280 }
1281 }
1282}
1283```
1284
12853. Show a commit summary next to the commit date and author:
1286
1287```json
1288{
1289 "git": {
1290 "inline_blame": {
1291 "enabled": true,
1292 "show_commit_summary": true
1293 }
1294 }
1295}
1296```
1297
12984. Use this as the minimum column at which to display inline blame information:
1299
1300```json
1301{
1302 "git": {
1303 "inline_blame": {
1304 "enabled": true,
1305 "min_column": 80
1306 }
1307 }
1308}
1309```
1310
1311## Indent Guides
1312
1313- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
1314- Setting: `indent_guides`
1315- Default:
1316
1317```json
1318{
1319 "indent_guides": {
1320 "enabled": true,
1321 "line_width": 1,
1322 "active_line_width": 1,
1323 "coloring": "fixed",
1324 "background_coloring": "disabled"
1325 }
1326}
1327```
1328
1329**Options**
1330
13311. Disable indent guides
1332
1333```json
1334{
1335 "indent_guides": {
1336 "enabled": false
1337 }
1338}
1339```
1340
13412. Enable indent guides for a specific language.
1342
1343```json
1344{
1345 "languages": {
1346 "Python": {
1347 "indent_guides": {
1348 "enabled": true
1349 }
1350 }
1351 }
1352}
1353```
1354
13553. Enable indent aware coloring ("rainbow indentation").
1356 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.
1357
1358```json
1359{
1360 "indent_guides": {
1361 "enabled": true,
1362 "coloring": "indent_aware"
1363 }
1364}
1365```
1366
13674. Enable indent aware background coloring ("rainbow indentation").
1368 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.
1369
1370```json
1371{
1372 "indent_guides": {
1373 "enabled": true,
1374 "coloring": "indent_aware",
1375 "background_coloring": "indent_aware"
1376 }
1377}
1378```
1379
1380## Hard Tabs
1381
1382- Description: Whether to indent lines using tab characters or multiple spaces.
1383- Setting: `hard_tabs`
1384- Default: `false`
1385
1386**Options**
1387
1388`boolean` values
1389
1390## Hover Popover Enabled
1391
1392- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
1393- Setting: `hover_popover_enabled`
1394- Default: `true`
1395
1396**Options**
1397
1398`boolean` values
1399
1400## Inlay hints
1401
1402- Description: Configuration for displaying extra text with hints in the editor.
1403- Setting: `inlay_hints`
1404- Default:
1405
1406```json
1407"inlay_hints": {
1408 "enabled": false,
1409 "show_type_hints": true,
1410 "show_parameter_hints": true,
1411 "show_other_hints": true,
1412 "show_background": false,
1413 "edit_debounce_ms": 700,
1414 "scroll_debounce_ms": 50
1415}
1416```
1417
1418**Options**
1419
1420Inlay hints querying consists of two parts: editor (client) and LSP server.
1421With 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.
1422At 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.
1423
1424The following languages have inlay hints preconfigured by Zed:
1425
1426- [Go](https://docs.zed.dev/languages/go)
1427- [Rust](https://docs.zed.dev/languages/rust)
1428- [Svelte](https://docs.zed.dev/languages/svelte)
1429- [Typescript](https://docs.zed.dev/languages/typescript)
1430
1431Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
1432
1433Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
1434Settings-related hint updates are not debounced.
1435
1436## Journal
1437
1438- Description: Configuration for the journal.
1439- Setting: `journal`
1440- Default:
1441
1442```json
1443"journal": {
1444 "path": "~",
1445 "hour_format": "hour12"
1446}
1447```
1448
1449### Path
1450
1451- Description: The path of the directory where journal entries are stored.
1452- Setting: `path`
1453- Default: `~`
1454
1455**Options**
1456
1457`string` values
1458
1459### Hour Format
1460
1461- Description: The format to use for displaying hours in the journal.
1462- Setting: `hour_format`
1463- Default: `hour12`
1464
1465**Options**
1466
14671. 12-hour format:
1468
1469```json
1470{
1471 "hour_format": "hour12"
1472}
1473```
1474
14752. 24-hour format:
1476
1477```json
1478{
1479 "hour_format": "hour24"
1480}
1481```
1482
1483## Languages
1484
1485- Description: Configuration for specific languages.
1486- Setting: `languages`
1487- Default: `null`
1488
1489**Options**
1490
1491To override settings for a language, add an entry for that languages name to the `languages` value. Example:
1492
1493```json
1494"languages": {
1495 "C": {
1496 "format_on_save": "off",
1497 "preferred_line_length": 64,
1498 "soft_wrap": "preferred_line_length"
1499 },
1500 "JSON": {
1501 "tab_size": 4
1502 }
1503}
1504```
1505
1506The following settings can be overridden for each specific language:
1507
1508- [`enable_language_server`](#enable-language-server)
1509- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
1510- [`format_on_save`](#format-on-save)
1511- [`formatter`](#formatter)
1512- [`hard_tabs`](#hard-tabs)
1513- [`preferred_line_length`](#preferred-line-length)
1514- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
1515- [`show_edit_predictions`](#show-edit-predictions)
1516- [`show_whitespaces`](#show-whitespaces)
1517- [`soft_wrap`](#soft-wrap)
1518- [`tab_size`](#tab-size)
1519- [`use_autoclose`](#use-autoclose)
1520- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
1521
1522These values take in the same options as the root-level settings with the same name.
1523
1524## Network Proxy
1525
1526- Description: Configure a network proxy for Zed.
1527- Setting: `proxy`
1528- Default: `null`
1529
1530**Options**
1531
1532The proxy setting must contain a URL to the proxy.
1533
1534The following URI schemes are supported:
1535
1536- `http`
1537- `https`
1538- `socks4` - SOCKS4 proxy with local DNS
1539- `socks4a` - SOCKS4 proxy with remote DNS
1540- `socks5` - SOCKS5 proxy with local DNS
1541- `socks5h` - SOCKS5 proxy with remote DNS
1542
1543`http` will be used when no scheme is specified.
1544
1545By 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`.
1546
1547For example, to set an `http` proxy, add the following to your settings:
1548
1549```json
1550{
1551 "proxy": "http://127.0.0.1:10809"
1552}
1553```
1554
1555Or to set a `socks5` proxy:
1556
1557```json
1558{
1559 "proxy": "socks5h://localhost:10808"
1560}
1561```
1562
1563## Preview tabs
1564
1565- Description:
1566 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. \
1567 There are several ways to convert a preview tab into a regular tab:
1568
1569 - Double-clicking on the file
1570 - Double-clicking on the tab header
1571 - Using the `project_panel::OpenPermanent` action
1572 - Editing the file
1573 - Dragging the file to a different pane
1574
1575- Setting: `preview_tabs`
1576- Default:
1577
1578```json
1579"preview_tabs": {
1580 "enabled": true,
1581 "enable_preview_from_file_finder": false,
1582 "enable_preview_from_code_navigation": false,
1583}
1584```
1585
1586### Enable preview from file finder
1587
1588- Description: Determines whether to open files in preview mode when selected from the file finder.
1589- Setting: `enable_preview_from_file_finder`
1590- Default: `false`
1591
1592**Options**
1593
1594`boolean` values
1595
1596### Enable preview from code navigation
1597
1598- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
1599- Setting: `enable_preview_from_code_navigation`
1600- Default: `false`
1601
1602**Options**
1603
1604`boolean` values
1605
1606## File Finder
1607
1608### Modal Max Width
1609
1610- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
1611- Setting: `modal_max_width`
1612- Default: `small`
1613
1614## Preferred Line Length
1615
1616- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
1617- Setting: `preferred_line_length`
1618- Default: `80`
1619
1620**Options**
1621
1622`integer` values
1623
1624## Projects Online By Default
1625
1626- Description: Whether or not to show the online projects view by default.
1627- Setting: `projects_online_by_default`
1628- Default: `true`
1629
1630**Options**
1631
1632`boolean` values
1633
1634## Remove Trailing Whitespace On Save
1635
1636- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
1637- Setting: `remove_trailing_whitespace_on_save`
1638- Default: `true`
1639
1640**Options**
1641
1642`boolean` values
1643
1644## Search
1645
1646- Description: Search options to enable by default when opening new project and buffer searches.
1647- Setting: `search`
1648- Default:
1649
1650```json
1651"search": {
1652 "whole_word": false,
1653 "case_sensitive": false,
1654 "include_ignored": false,
1655 "regex": false
1656},
1657```
1658
1659## Show Call Status Icon
1660
1661- Description: Whether or not to show the call status icon in the status bar.
1662- Setting: `show_call_status_icon`
1663- Default: `true`
1664
1665**Options**
1666
1667`boolean` values
1668
1669## Show Completions On Input
1670
1671- Description: Whether or not to show completions as you type.
1672- Setting: `show_completions_on_input`
1673- Default: `true`
1674
1675**Options**
1676
1677`boolean` values
1678
1679## Show Completion Documentation
1680
1681- Description: Whether to display inline and alongside documentation for items in the completions menu.
1682- Setting: `show_completion_documentation`
1683- Default: `true`
1684
1685**Options**
1686
1687`boolean` values
1688
1689## Show Edit Predictions
1690
1691- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
1692- Setting: `show_edit_predictions`
1693- Default: `true`
1694
1695**Options**
1696
1697`boolean` values
1698
1699## Show Whitespaces
1700
1701- Description: Whether or not to show render whitespace characters in the editor.
1702- Setting: `show_whitespaces`
1703- Default: `selection`
1704
1705**Options**
1706
17071. `all`
17082. `selection`
17093. `none`
17104. `boundary`
1711
1712## Soft Wrap
1713
1714- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
1715- Setting: `soft_wrap`
1716- Default: `none`
1717
1718**Options**
1719
17201. `none` to avoid wrapping generally, unless the line is too long
17212. `prefer_line` (deprecated, same as `none`)
17223. `editor_width` to wrap lines that overflow the editor width
17234. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
17245. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
1725
1726## Wrap Guides (Vertical Rulers)
1727
1728- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
1729- Setting: `wrap_guides`
1730- Default: []
1731
1732**Options**
1733
1734List of `integer` column numbers
1735
1736## Tab Size
1737
1738- Description: The number of spaces to use for each tab character.
1739- Setting: `tab_size`
1740- Default: `4`
1741
1742**Options**
1743
1744`integer` values
1745
1746## Telemetry
1747
1748- Description: Control what info is collected by Zed.
1749- Setting: `telemetry`
1750- Default:
1751
1752```json
1753"telemetry": {
1754 "diagnostics": true,
1755 "metrics": true
1756},
1757```
1758
1759**Options**
1760
1761### Diagnostics
1762
1763- Description: Setting for sending debug-related data, such as crash reports.
1764- Setting: `diagnostics`
1765- Default: `true`
1766
1767**Options**
1768
1769`boolean` values
1770
1771### Metrics
1772
1773- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
1774- Setting: `metrics`
1775- Default: `true`
1776
1777**Options**
1778
1779`boolean` values
1780
1781## Terminal
1782
1783- Description: Configuration for the terminal.
1784- Setting: `terminal`
1785- Default:
1786
1787```json
1788{
1789 "terminal": {
1790 "alternate_scroll": "off",
1791 "blinking": "terminal_controlled",
1792 "copy_on_select": false,
1793 "dock": "bottom",
1794 "detect_venv": {
1795 "on": {
1796 "directories": [".env", "env", ".venv", "venv"],
1797 "activate_script": "default"
1798 }
1799 },
1800 "env": {},
1801 "font_family": null,
1802 "font_features": null,
1803 "font_size": null,
1804 "line_height": "comfortable",
1805 "option_as_meta": false,
1806 "button": false,
1807 "shell": {},
1808 "toolbar": {
1809 "breadcrumbs": true
1810 },
1811 "working_directory": "current_project_directory",
1812 "scrollbar": {
1813 "show": null
1814 }
1815 }
1816}
1817```
1818
1819### Terminal: Dock
1820
1821- Description: Control the position of the dock
1822- Setting: `dock`
1823- Default: `bottom`
1824
1825**Options**
1826
1827`"bottom"`, `"left"` or `"right"`
1828
1829### Terminal: Alternate Scroll
1830
1831- 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.
1832- Setting: `alternate_scroll`
1833- Default: `off`
1834
1835**Options**
1836
18371. Default alternate scroll mode to on
1838
1839```json
1840{
1841 "terminal": {
1842 "alternate_scroll": "on"
1843 }
1844}
1845```
1846
18472. Default alternate scroll mode to off
1848
1849```json
1850{
1851 "terminal": {
1852 "alternate_scroll": "off"
1853 }
1854}
1855```
1856
1857### Terminal: Blinking
1858
1859- Description: Set the cursor blinking behavior in the terminal
1860- Setting: `blinking`
1861- Default: `terminal_controlled`
1862
1863**Options**
1864
18651. Never blink the cursor, ignore the terminal mode
1866
1867```json
1868{
1869 "terminal": {
1870 "blinking": "off"
1871 }
1872}
1873```
1874
18752. Default the cursor blink to off, but allow the terminal to turn blinking on
1876
1877```json
1878{
1879 "terminal": {
1880 "blinking": "terminal_controlled"
1881 }
1882}
1883```
1884
18853. Always blink the cursor, ignore the terminal mode
1886
1887```json
1888{
1889 "terminal": {
1890 "blinking": "on"
1891 }
1892}
1893```
1894
1895### Terminal: Copy On Select
1896
1897- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
1898- Setting: `copy_on_select`
1899- Default: `false`
1900
1901**Options**
1902
1903`boolean` values
1904
1905**Example**
1906
1907```json
1908{
1909 "terminal": {
1910 "copy_on_select": true
1911 }
1912}
1913```
1914
1915### Terminal: Env
1916
1917- 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
1918- Setting: `env`
1919- Default: `{}`
1920
1921**Example**
1922
1923```json
1924{
1925 "terminal": {
1926 "env": {
1927 "ZED": "1",
1928 "KEY": "value1:value2"
1929 }
1930 }
1931}
1932```
1933
1934### Terminal: Font Size
1935
1936- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
1937- Setting: `font_size`
1938- Default: `null`
1939
1940**Options**
1941
1942`integer` values
1943
1944```json
1945{
1946 "terminal": {
1947 "font_size": 15
1948 }
1949}
1950```
1951
1952### Terminal: Font Family
1953
1954- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
1955- Setting: `font_family`
1956- Default: `null`
1957
1958**Options**
1959
1960The name of any font family installed on the user's system
1961
1962```json
1963{
1964 "terminal": {
1965 "font_family": "Berkeley Mono"
1966 }
1967}
1968```
1969
1970### Terminal: Font Features
1971
1972- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
1973- Setting: `font_features`
1974- Default: `null`
1975- Platform: macOS and Windows.
1976
1977**Options**
1978
1979See Buffer Font Features
1980
1981```json
1982{
1983 "terminal": {
1984 "font_features": {
1985 "calt": false
1986 // See Buffer Font Features for more features
1987 }
1988 }
1989}
1990```
1991
1992### Terminal: Line Height
1993
1994- Description: Set the terminal's line height.
1995- Setting: `line_height`
1996- Default: `comfortable`
1997
1998**Options**
1999
20001. Use a line height that's `comfortable` for reading, 1.618. (default)
2001
2002```json
2003{
2004 "terminal": {
2005 "line_height": "comfortable"
2006 }
2007}
2008```
2009
20102. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
2011
2012```json
2013{
2014 "terminal": {
2015 "line_height": "standard"
2016 }
2017}
2018```
2019
20203. Use a custom line height.
2021
2022```json
2023{
2024 "terminal": {
2025 "line_height": {
2026 "custom": 2
2027 }
2028 }
2029}
2030```
2031
2032### Terminal: Option As Meta
2033
2034- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
2035- Setting: `option_as_meta`
2036- Default: `false`
2037
2038**Options**
2039
2040`boolean` values
2041
2042```json
2043{
2044 "terminal": {
2045 "option_as_meta": true
2046 }
2047}
2048```
2049
2050### Terminal: Shell
2051
2052- Description: What shell to use when launching the terminal.
2053- Setting: `shell`
2054- Default: `system`
2055
2056**Options**
2057
20581. Use the system's default terminal configuration (usually the `/etc/passwd` file).
2059
2060```json
2061{
2062 "terminal": {
2063 "shell": "system"
2064 }
2065}
2066```
2067
20682. A program to launch:
2069
2070```json
2071{
2072 "terminal": {
2073 "shell": {
2074 "program": "sh"
2075 }
2076 }
2077}
2078```
2079
20803. A program with arguments:
2081
2082```json
2083{
2084 "terminal": {
2085 "shell": {
2086 "with_arguments": {
2087 "program": "/bin/bash",
2088 "args": ["--login"]
2089 }
2090 }
2091 }
2092}
2093```
2094
2095## Terminal: Detect Virtual Environments {#terminal-detect_venv}
2096
2097- 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.
2098- Setting: `detect_venv`
2099- Default:
2100
2101```json
2102{
2103 "terminal": {
2104 "detect_venv": {
2105 "on": {
2106 // Default directories to search for virtual environments, relative
2107 // to the current working directory. We recommend overriding this
2108 // in your project's settings, rather than globally.
2109 "directories": [".venv", "venv"],
2110 // Can also be `csh`, `fish`, and `nushell`
2111 "activate_script": "default"
2112 }
2113 }
2114 }
2115}
2116```
2117
2118Disable with:
2119
2120```json
2121{
2122 "terminal": {
2123 "detect_venv": "off"
2124 }
2125}
2126```
2127
2128## Terminal: Toolbar
2129
2130- Description: Whether or not to show various elements in the terminal toolbar.
2131- Setting: `toolbar`
2132- Default:
2133
2134```json
2135{
2136 "terminal": {
2137 "toolbar": {
2138 "breadcrumbs": true
2139 }
2140 }
2141}
2142```
2143
2144**Options**
2145
2146At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
2147
2148If the terminal title is empty, the breadcrumbs won't be shown.
2149
2150The shell running in the terminal needs to be configured to emit the title.
2151
2152Example command to set the title: `echo -e "\e]2;New Title\007";`
2153
2154### Terminal: Button
2155
2156- Description: Control to show or hide the terminal button in the status bar
2157- Setting: `button`
2158- Default: `true`
2159
2160**Options**
2161
2162`boolean` values
2163
2164```json
2165{
2166 "terminal": {
2167 "button": false
2168 }
2169}
2170```
2171
2172### Terminal: Working Directory
2173
2174- Description: What working directory to use when launching the terminal.
2175- Setting: `working_directory`
2176- Default: `"current_project_directory"`
2177
2178**Options**
2179
21801. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
2181
2182```json
2183{
2184 "terminal": {
2185 "working_directory": "current_project_directory"
2186 }
2187}
2188```
2189
21902. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
2191
2192```json
2193{
2194 "terminal": {
2195 "working_directory": "first_project_directory"
2196 }
2197}
2198```
2199
22003. Always use this platform's home directory (if we can find it)
2201
2202```json
2203{
2204 "terminal": {
2205 "working_directory": "always_home"
2206 }
2207}
2208```
2209
22104. 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.
2211
2212```json
2213{
2214 "terminal": {
2215 "working_directory": {
2216 "always": {
2217 "directory": "~/zed/projects/"
2218 }
2219 }
2220 }
2221}
2222```
2223
2224## Theme
2225
2226- 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.
2227- Setting: `theme`
2228- Default: `One Dark`
2229
2230### Theme Object
2231
2232- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
2233- Setting: `theme`
2234- Default:
2235
2236```json
2237"theme": {
2238 "mode": "system",
2239 "dark": "One Dark",
2240 "light": "One Light"
2241},
2242```
2243
2244### Mode
2245
2246- Description: Specify theme mode.
2247- Setting: `mode`
2248- Default: `system`
2249
2250**Options**
2251
22521. Set the theme to dark mode
2253
2254```json
2255{
2256 "mode": "dark"
2257}
2258```
2259
22602. Set the theme to light mode
2261
2262```json
2263{
2264 "mode": "light"
2265}
2266```
2267
22683. Set the theme to system mode
2269
2270```json
2271{
2272 "mode": "system"
2273}
2274```
2275
2276### Dark
2277
2278- Description: The name of the dark Zed theme to use for the UI.
2279- Setting: `dark`
2280- Default: `One Dark`
2281
2282**Options**
2283
2284Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2285
2286### Light
2287
2288- Description: The name of the light Zed theme to use for the UI.
2289- Setting: `light`
2290- Default: `One Light`
2291
2292**Options**
2293
2294Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2295
2296## Vim
2297
2298- Description: Whether or not to enable vim mode (work in progress).
2299- Setting: `vim_mode`
2300- Default: `false`
2301
2302## Project Panel
2303
2304- Description: Customize project panel
2305- Setting: `project_panel`
2306- Default:
2307
2308```json
2309{
2310 "project_panel": {
2311 "button": true,
2312 "default_width": 240,
2313 "dock": "left",
2314 "entry_spacing": "comfortable",
2315 "file_icons": true,
2316 "folder_icons": true,
2317 "git_status": true,
2318 "indent_size": 20,
2319 "indent_guides": true,
2320 "auto_reveal_entries": true,
2321 "auto_fold_dirs": true,
2322 "scrollbar": {
2323 "show": null
2324 },
2325 "indent_guides": {
2326 "show": "always"
2327 }
2328 }
2329}
2330```
2331
2332### Dock
2333
2334- Description: Control the position of the dock
2335- Setting: `dock`
2336- Default: `left`
2337
2338**Options**
2339
23401. Default dock position to left
2341
2342```json
2343{
2344 "dock": "left"
2345}
2346```
2347
23482. Default dock position to right
2349
2350```json
2351{
2352 "dock": "right"
2353}
2354```
2355
2356### Entry Spacing
2357
2358- Description: Spacing between worktree entries
2359- Setting: `entry_spacing`
2360- Default: `comfortable`
2361
2362**Options**
2363
23641. Comfortable entry spacing
2365
2366```json
2367{
2368 "entry_spacing": "comfortable"
2369}
2370```
2371
23722. Standard entry spacing
2373
2374```json
2375{
2376 "entry_spacing": "standard"
2377}
2378```
2379
2380### Git Status
2381
2382- Description: Indicates newly created and updated files
2383- Setting: `git_status`
2384- Default: `true`
2385
2386**Options**
2387
23881. Default enable git status
2389
2390```json
2391{
2392 "git_status": true
2393}
2394```
2395
23962. Default disable git status
2397
2398```json
2399{
2400 "git_status": false
2401}
2402```
2403
2404### Default Width
2405
2406- Description: Customize default width taken by project panel
2407- Setting: `default_width`
2408- Default: N/A width in pixels (eg: 420)
2409
2410**Options**
2411
2412`boolean` values
2413
2414### Auto Reveal Entries
2415
2416- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
2417- Setting: `auto_reveal_entries`
2418- Default: `true`
2419
2420**Options**
2421
24221. Enable auto reveal entries
2423
2424```json
2425{
2426 "auto_reveal_entries": true
2427}
2428```
2429
24302. Disable auto reveal entries
2431
2432```json
2433{
2434 "auto_reveal_entries": false
2435}
2436```
2437
2438### Auto Fold Dirs
2439
2440- Description: Whether to fold directories automatically when directory has only one directory inside.
2441- Setting: `auto_fold_dirs`
2442- Default: `true`
2443
2444**Options**
2445
24461. Enable auto fold dirs
2447
2448```json
2449{
2450 "auto_fold_dirs": true
2451}
2452```
2453
24542. Disable auto fold dirs
2455
2456```json
2457{
2458 "auto_fold_dirs": false
2459}
2460```
2461
2462### Indent Size
2463
2464- Description: Amount of indentation (in pixels) for nested items.
2465- Setting: `indent_size`
2466- Default: `20`
2467
2468### Indent Guides: Show
2469
2470- Description: Whether to show indent guides in the project panel. Possible values: "always", "never".
2471- Setting: `indent_guides`
2472
2473```json
2474"indent_guides": {
2475 "show": "always"
2476}
2477```
2478
2479**Options**
2480
24811. Show indent guides in the project panel
2482
2483```json
2484{
2485 "indent_guides": {
2486 "show": "always"
2487 }
2488}
2489```
2490
24912. Hide indent guides in the project panel
2492
2493```json
2494{
2495 "indent_guides": {
2496 "show": "never"
2497 }
2498}
2499```
2500
2501### Scrollbar: Show
2502
2503- 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.
2504- Setting: `scrollbar`
2505- Default:
2506
2507```json
2508"scrollbar": {
2509 "show": null
2510}
2511```
2512
2513**Options**
2514
25151. Show scrollbar in the project panel
2516
2517```json
2518{
2519 "scrollbar": {
2520 "show": "always"
2521 }
2522}
2523```
2524
25252. Hide scrollbar in the project panel
2526
2527```json
2528{
2529 "scrollbar": {
2530 "show": "never"
2531 }
2532}
2533```
2534
2535## Assistant Panel
2536
2537- Description: Customize assistant panel
2538- Setting: `assistant`
2539- Default:
2540
2541```json
2542"assistant": {
2543 "enabled": true,
2544 "button": true,
2545 "dock": "right",
2546 "default_width": 640,
2547 "default_height": 320,
2548 "provider": "openai",
2549 "version": "1",
2550},
2551```
2552
2553## Outline Panel
2554
2555- Description: Customize outline Panel
2556- Setting: `outline_panel`
2557- Default:
2558
2559```json
2560"outline_panel": {
2561 "button": true,
2562 "default_width": 240,
2563 "dock": "left",
2564 "file_icons": true,
2565 "folder_icons": true,
2566 "git_status": true,
2567 "indent_size": 20,
2568 "auto_reveal_entries": true,
2569 "auto_fold_dirs": true,
2570 "indent_guides": {
2571 "show": "always"
2572 },
2573 "scrollbar": {
2574 "show": null
2575 }
2576}
2577```
2578
2579## Calls
2580
2581- Description: Customize behavior when participating in a call
2582- Setting: `calls`
2583- Default:
2584
2585```json
2586"calls": {
2587 // Join calls with the microphone live by default
2588 "mute_on_join": false,
2589 // Share your project when you are the first to join a channel
2590 "share_on_join": false
2591},
2592```
2593
2594## Unnecessary Code Fade
2595
2596- Description: How much to fade out unused code.
2597- Setting: `unnecessary_code_fade`
2598- Default: `0.3`
2599
2600**Options**
2601
2602Float values between `0.0` and `0.9`, where:
2603
2604- `0.0` means no fading (unused code looks the same as used code)
2605- `0.9` means maximum fading (unused code is very faint but still visible)
2606
2607**Example**
2608
2609```json
2610{
2611 "unnecessary_code_fade": 0.5
2612}
2613```
2614
2615## UI Font Family
2616
2617- Description: The name of the font to use for text in the UI.
2618- Setting: `ui_font_family`
2619- Default: `Zed Plex Sans`
2620
2621**Options**
2622
2623The name of any font family installed on the system.
2624
2625## UI Font Features
2626
2627- Description: The OpenType features to enable for text in the UI.
2628- Setting: `ui_font_features`
2629- Default: `null`
2630- Platform: macOS and Windows.
2631
2632**Options**
2633
2634Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
2635
2636For example, to disable font ligatures, add the following to your settings:
2637
2638```json
2639{
2640 "ui_font_features": {
2641 "calt": false
2642 }
2643}
2644```
2645
2646You can also set other OpenType features, like setting `cv01` to `7`:
2647
2648```json
2649{
2650 "ui_font_features": {
2651 "cv01": 7
2652 }
2653}
2654```
2655
2656## UI Font Fallbacks
2657
2658- Description: The font fallbacks to use for text in the UI.
2659- Setting: `ui_font_fallbacks`
2660- Default: `null`
2661- Platform: macOS and Windows.
2662
2663**Options**
2664
2665For example, to use `Nerd Font` as a fallback, add the following to your settings:
2666
2667```json
2668{
2669 "ui_font_fallbacks": ["Nerd Font"]
2670}
2671```
2672
2673## UI Font Size
2674
2675- Description: The default font size for text in the UI.
2676- Setting: `ui_font_size`
2677- Default: `16`
2678
2679**Options**
2680
2681`integer` values from `6` to `100` pixels (inclusive)
2682
2683## UI Font Weight
2684
2685- Description: The default font weight for text in the UI.
2686- Setting: `ui_font_weight`
2687- Default: `400`
2688
2689**Options**
2690
2691`integer` values between `100` and `900`
2692
2693## An example configuration:
2694
2695```json
2696// ~/.config/zed/settings.json
2697{
2698 "theme": "cave-light",
2699 "tab_size": 2,
2700 "preferred_line_length": 80,
2701 "soft_wrap": "none",
2702
2703 "buffer_font_size": 18,
2704 "buffer_font_family": "Zed Plex Mono",
2705
2706 "autosave": "on_focus_change",
2707 "format_on_save": "off",
2708 "vim_mode": false,
2709 "projects_online_by_default": true,
2710 "terminal": {
2711 "font_family": "FiraCode Nerd Font Mono",
2712 "blinking": "off"
2713 },
2714 "languages": {
2715 "C": {
2716 "format_on_save": "language_server",
2717 "preferred_line_length": 64,
2718 "soft_wrap": "preferred_line_length"
2719 }
2720 }
2721}
2722```