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## Hide Mouse While Typing
537
538- Description: Determines whether the mouse cursor should be hidden while typing in an editor or input box.
539- Setting: `hide_mouse_while_typing`
540- Default: `true`
541
542**Options**
543
544`boolean` values
545
546## Editor Scrollbar
547
548- Description: Whether or not to show the editor scrollbar and various elements in it.
549- Setting: `scrollbar`
550- Default:
551
552```json
553"scrollbar": {
554 "show": "auto",
555 "cursors": true,
556 "git_diff": true,
557 "search_results": true,
558 "selected_text": true,
559 "selected_symbol": true,
560 "diagnostics": "all",
561 "axes": {
562 "horizontal": true,
563 "vertical": true,
564 },
565},
566```
567
568### Show Mode
569
570- Description: When to show the editor scrollbar.
571- Setting: `show`
572- Default: `auto`
573
574**Options**
575
5761. Show the scrollbar if there's important information or follow the system's configured behavior:
577
578```json
579"scrollbar": {
580 "show": "auto"
581}
582```
583
5842. Match the system's configured behavior:
585
586```json
587"scrollbar": {
588 "show": "system"
589}
590```
591
5923. Always show the scrollbar:
593
594```json
595"scrollbar": {
596 "show": "always"
597}
598```
599
6004. Never show the scrollbar:
601
602```json
603"scrollbar": {
604 "show": "never"
605}
606```
607
608### Cursor Indicators
609
610- Description: Whether to show cursor positions in the scrollbar.
611- Setting: `cursors`
612- Default: `true`
613
614**Options**
615
616`boolean` values
617
618### Git Diff Indicators
619
620- Description: Whether to show git diff indicators in the scrollbar.
621- Setting: `git_diff`
622- Default: `true`
623
624**Options**
625
626`boolean` values
627
628### Search Results Indicators
629
630- Description: Whether to show buffer search results in the scrollbar.
631- Setting: `search_results`
632- Default: `true`
633
634**Options**
635
636`boolean` values
637
638### Selected Text Indicators
639
640- Description: Whether to show selected text occurrences in the scrollbar.
641- Setting: `selected_text`
642- Default: `true`
643
644**Options**
645
646`boolean` values
647
648### Selected Symbols Indicators
649
650- Description: Whether to show selected symbol occurrences in the scrollbar.
651- Setting: `selected_symbol`
652- Default: `true`
653
654**Options**
655
656`boolean` values
657
658### Diagnostics
659
660- Description: Which diagnostic indicators to show in the scrollbar.
661- Setting: `diagnostics`
662- Default: `all`
663
664**Options**
665
6661. Show all diagnostics:
667
668```json
669{
670 "diagnostics": "all"
671}
672```
673
6742. Do not show any diagnostics:
675
676```json
677{
678 "diagnostics": "none"
679}
680```
681
6823. Show only errors:
683
684```json
685{
686 "diagnostics": "error"
687}
688```
689
6904. Show only errors and warnings:
691
692```json
693{
694 "diagnostics": "warning"
695}
696```
697
6985. Show only errors, warnings, and information:
699
700```json
701{
702 "diagnostics": "information"
703}
704```
705
706### Axes
707
708- Description: Forcefully enable or disable the scrollbar for each axis
709- Setting: `axes`
710- Default:
711
712```json
713"scrollbar": {
714 "axes": {
715 "horizontal": true,
716 "vertical": true,
717 },
718}
719```
720
721#### Horizontal
722
723- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
724- Setting: `horizontal`
725- Default: `true`
726
727**Options**
728
729`boolean` values
730
731#### Vertical
732
733- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
734- Setting: `vertical`
735- Default: `true`
736
737**Options**
738
739`boolean` values
740
741## Editor Tab Bar
742
743- Description: Settings related to the editor's tab bar.
744- Settings: `tab_bar`
745- Default:
746
747```json
748"tab_bar": {
749 "show": true,
750 "show_nav_history_buttons": true,
751 "show_tab_bar_buttons": true
752}
753```
754
755### Show
756
757- Description: Whether or not to show the tab bar in the editor.
758- Setting: `show`
759- Default: `true`
760
761**Options**
762
763`boolean` values
764
765### Navigation History Buttons
766
767- Description: Whether or not to show the navigation history buttons.
768- Setting: `show_nav_history_buttons`
769- Default: `true`
770
771**Options**
772
773`boolean` values
774
775### Tab Bar Buttons
776
777- Description: Whether or not to show the tab bar buttons.
778- Setting: `show_tab_bar_buttons`
779- Default: `true`
780
781**Options**
782
783`boolean` values
784
785## Editor Tabs
786
787- Description: Configuration for the editor tabs.
788- Setting: `tabs`
789- Default:
790
791```json
792"tabs": {
793 "close_position": "right",
794 "file_icons": false,
795 "git_status": false,
796 "activate_on_close": "history",
797 "always_show_close_button": false
798},
799```
800
801### Close Position
802
803- Description: Where to display close button within a tab.
804- Setting: `close_position`
805- Default: `right`
806
807**Options**
808
8091. Display the close button on the right:
810
811```json
812{
813 "close_position": "right"
814}
815```
816
8172. Display the close button on the left:
818
819```json
820{
821 "close_position": "left"
822}
823```
824
825### File Icons
826
827- Description: Whether to show the file icon for a tab.
828- Setting: `file_icons`
829- Default: `false`
830
831### Git Status
832
833- Description: Whether or not to show Git file status in tab.
834- Setting: `git_status`
835- Default: `false`
836
837### Activate on close
838
839- Description: What to do after closing the current tab.
840- Setting: `activate_on_close`
841- Default: `history`
842
843**Options**
844
8451. Activate the tab that was open previously:
846
847```json
848{
849 "activate_on_close": "history"
850}
851```
852
8532. Activate the right neighbour tab if present:
854
855```json
856{
857 "activate_on_close": "neighbour"
858}
859```
860
8613. Activate the left neighbour tab if present:
862
863```json
864{
865 "activate_on_close": "left_neighbour"
866}
867```
868
869### Always show the close button
870
871- Description: Whether to always show the close button on tabs.
872- Setting: `always_show_close_button`
873- Default: `false`
874
875## Editor Toolbar
876
877- Description: Whether or not to show various elements in the editor toolbar.
878- Setting: `toolbar`
879- Default:
880
881```json
882"toolbar": {
883 "breadcrumbs": true,
884 "quick_actions": true
885},
886```
887
888**Options**
889
890Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
891
892## Enable Language Server
893
894- Description: Whether or not to use language servers to provide code intelligence.
895- Setting: `enable_language_server`
896- Default: `true`
897
898**Options**
899
900`boolean` values
901
902## Ensure Final Newline On Save
903
904- Description: Whether or not to ensure there's a single newline at the end of a buffer when saving it.
905- Setting: `ensure_final_newline_on_save`
906- Default: `true`
907
908**Options**
909
910`boolean` values
911
912## LSP
913
914- Description: Configuration for language servers.
915- Setting: `lsp`
916- Default: `null`
917
918**Options**
919
920The following settings can be overridden for specific language servers:
921
922- `initialization_options`
923- `settings`
924
925To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
926
927Some 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.
928
929For example to pass the `check` option to `rust-analyzer`, use the following configuration:
930
931```json
932"lsp": {
933 "rust-analyzer": {
934 "initialization_options": {
935 "check": {
936 "command": "clippy" // rust-analyzer.check.command (default: "check")
937 }
938 }
939 }
940}
941```
942
943While other options may be changed at a runtime and should be placed under `settings`:
944
945```json
946"lsp": {
947 "yaml-language-server": {
948 "settings": {
949 "yaml": {
950 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
951 }
952 }
953 }
954}
955```
956
957## Format On Save
958
959- Description: Whether or not to perform a buffer format before saving.
960- Setting: `format_on_save`
961- Default: `on`
962
963**Options**
964
9651. `on`, enables format on save obeying `formatter` setting:
966
967```json
968{
969 "format_on_save": "on"
970}
971```
972
9732. `off`, disables format on save:
974
975```json
976{
977 "format_on_save": "off"
978}
979```
980
981## Formatter
982
983- Description: How to perform a buffer format.
984- Setting: `formatter`
985- Default: `auto`
986
987**Options**
988
9891. To use the current language server, use `"language_server"`:
990
991```json
992{
993 "formatter": "language_server"
994}
995```
996
9972. 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):
998
999```json
1000{
1001 "formatter": {
1002 "external": {
1003 "command": "sed",
1004 "arguments": ["-e", "s/ *$//"]
1005 }
1006 }
1007}
1008```
1009
10103. 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.
1011
1012WARNING: `{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.
1013
1014```json
1015 "formatter": {
1016 "external": {
1017 "command": "prettier",
1018 "arguments": ["--stdin-filepath", "{buffer_path}"]
1019 }
1020 }
1021```
1022
10234. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1024
1025```json
1026{
1027 "formatter": {
1028 "code_actions": {
1029 // Use ESLint's --fix:
1030 "source.fixAll.eslint": true,
1031 // Organize imports on save:
1032 "source.organizeImports": true
1033 }
1034 }
1035}
1036```
1037
10385. Or to use multiple formatters consecutively, use an array of formatters:
1039
1040```json
1041{
1042 "formatter": [
1043 { "language_server": { "name": "rust-analyzer" } },
1044 {
1045 "external": {
1046 "command": "sed",
1047 "arguments": ["-e", "s/ *$//"]
1048 }
1049 }
1050 ]
1051}
1052```
1053
1054Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1055If any of the formatters fails, the subsequent ones will still be executed.
1056
1057## Code Actions On Format
1058
1059- Description: The code actions to perform with the primary language server when formatting the buffer.
1060- Setting: `code_actions_on_format`
1061- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
1062
1063**Examples**
1064
1065<!--
1066TBD: Add Python Ruff source.organizeImports example
1067-->
1068
10691. Organize imports on format in TypeScript and TSX buffers:
1070
1071```json
1072{
1073 "languages": {
1074 "TypeScript": {
1075 "code_actions_on_format": {
1076 "source.organizeImports": true
1077 }
1078 },
1079 "TSX": {
1080 "code_actions_on_format": {
1081 "source.organizeImports": true
1082 }
1083 }
1084 }
1085}
1086```
1087
10882. Run ESLint `fixAll` code action when formatting:
1089
1090```json
1091{
1092 "languages": {
1093 "JavaScript": {
1094 "code_actions_on_format": {
1095 "source.fixAll.eslint": true
1096 }
1097 }
1098 }
1099}
1100```
1101
11023. Run only a single ESLint rule when using `fixAll`:
1103
1104```json
1105{
1106 "languages": {
1107 "JavaScript": {
1108 "code_actions_on_format": {
1109 "source.fixAll.eslint": true
1110 }
1111 }
1112 },
1113 "lsp": {
1114 "eslint": {
1115 "settings": {
1116 "codeActionOnSave": {
1117 "rules": ["import/order"]
1118 }
1119 }
1120 }
1121 }
1122}
1123```
1124
1125## Auto close
1126
1127- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1128- Setting: `use_autoclose`
1129- Default: `true`
1130
1131**Options**
1132
1133`boolean` values
1134
1135## Always Treat Brackets As Autoclosed
1136
1137- Description: Controls how the editor handles the autoclosed characters.
1138- Setting: `always_treat_brackets_as_autoclosed`
1139- Default: `false`
1140
1141**Options**
1142
1143`boolean` values
1144
1145**Example**
1146
1147If the setting is set to `true`:
1148
11491. Enter in the editor: `)))`
11502. Move the cursor to the start: `^)))`
11513. Enter again: `)))`
1152
1153The result is still `)))` and not `))))))`, which is what it would be by default.
1154
1155## File Scan Exclusions
1156
1157- Setting: `file_scan_exclusions`
1158- 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`.
1159- Default:
1160
1161```json
1162"file_scan_exclusions": [
1163 "**/.git",
1164 "**/.svn",
1165 "**/.hg",
1166 "**/.jj",
1167 "**/CVS",
1168 "**/.DS_Store",
1169 "**/Thumbs.db",
1170 "**/.classpath",
1171 "**/.settings"
1172],
1173```
1174
1175Note, 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.
1176
1177## File Scan Inclusions
1178
1179- Setting: `file_scan_inclusions`
1180- 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.
1181- Default:
1182
1183```json
1184"file_scan_inclusions": [".env*"],
1185```
1186
1187## File Types
1188
1189- Setting: `file_types`
1190- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1191- Default: `{}`
1192
1193**Examples**
1194
1195To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1196
1197```json
1198{
1199 "file_types": {
1200 "C++": ["c"],
1201 "TOML": ["MyLockFile"],
1202 "Dockerfile": ["Dockerfile*"]
1203 }
1204}
1205```
1206
1207## Git
1208
1209- Description: Configuration for git-related features.
1210- Setting: `git`
1211- Default:
1212
1213```json
1214{
1215 "git": {
1216 "git_gutter": "tracked_files",
1217 "inline_blame": {
1218 "enabled": true
1219 }
1220 }
1221}
1222```
1223
1224### Git Gutter
1225
1226- Description: Whether or not to show the git gutter.
1227- Setting: `git_gutter`
1228- Default: `tracked_files`
1229
1230**Options**
1231
12321. Show git gutter in tracked files
1233
1234```json
1235{
1236 "git": {
1237 "git_gutter": "tracked_files"
1238 }
1239}
1240```
1241
12422. Hide git gutter
1243
1244```json
1245{
1246 "git": {
1247 "git_gutter": "hide"
1248 }
1249}
1250```
1251
1252### Inline Git Blame
1253
1254- Description: Whether or not to show git blame information inline, on the currently focused line.
1255- Setting: `inline_blame`
1256- Default:
1257
1258```json
1259{
1260 "git": {
1261 "inline_blame": {
1262 "enabled": true
1263 }
1264 }
1265}
1266```
1267
1268**Options**
1269
12701. Disable inline git blame:
1271
1272```json
1273{
1274 "git": {
1275 "inline_blame": {
1276 "enabled": false
1277 }
1278 }
1279}
1280```
1281
12822. Only show inline git blame after a delay (that starts after cursor stops moving):
1283
1284```json
1285{
1286 "git": {
1287 "inline_blame": {
1288 "enabled": true,
1289 "delay_ms": 500
1290 }
1291 }
1292}
1293```
1294
12953. Show a commit summary next to the commit date and author:
1296
1297```json
1298{
1299 "git": {
1300 "inline_blame": {
1301 "enabled": true,
1302 "show_commit_summary": true
1303 }
1304 }
1305}
1306```
1307
13084. Use this as the minimum column at which to display inline blame information:
1309
1310```json
1311{
1312 "git": {
1313 "inline_blame": {
1314 "enabled": true,
1315 "min_column": 80
1316 }
1317 }
1318}
1319```
1320
1321## Indent Guides
1322
1323- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
1324- Setting: `indent_guides`
1325- Default:
1326
1327```json
1328{
1329 "indent_guides": {
1330 "enabled": true,
1331 "line_width": 1,
1332 "active_line_width": 1,
1333 "coloring": "fixed",
1334 "background_coloring": "disabled"
1335 }
1336}
1337```
1338
1339**Options**
1340
13411. Disable indent guides
1342
1343```json
1344{
1345 "indent_guides": {
1346 "enabled": false
1347 }
1348}
1349```
1350
13512. Enable indent guides for a specific language.
1352
1353```json
1354{
1355 "languages": {
1356 "Python": {
1357 "indent_guides": {
1358 "enabled": true
1359 }
1360 }
1361 }
1362}
1363```
1364
13653. Enable indent aware coloring ("rainbow indentation").
1366 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.
1367
1368```json
1369{
1370 "indent_guides": {
1371 "enabled": true,
1372 "coloring": "indent_aware"
1373 }
1374}
1375```
1376
13774. Enable indent aware background coloring ("rainbow indentation").
1378 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.
1379
1380```json
1381{
1382 "indent_guides": {
1383 "enabled": true,
1384 "coloring": "indent_aware",
1385 "background_coloring": "indent_aware"
1386 }
1387}
1388```
1389
1390## Hard Tabs
1391
1392- Description: Whether to indent lines using tab characters or multiple spaces.
1393- Setting: `hard_tabs`
1394- Default: `false`
1395
1396**Options**
1397
1398`boolean` values
1399
1400## Hover Popover Enabled
1401
1402- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
1403- Setting: `hover_popover_enabled`
1404- Default: `true`
1405
1406**Options**
1407
1408`boolean` values
1409
1410## Inlay hints
1411
1412- Description: Configuration for displaying extra text with hints in the editor.
1413- Setting: `inlay_hints`
1414- Default:
1415
1416```json
1417"inlay_hints": {
1418 "enabled": false,
1419 "show_type_hints": true,
1420 "show_parameter_hints": true,
1421 "show_other_hints": true,
1422 "show_background": false,
1423 "edit_debounce_ms": 700,
1424 "scroll_debounce_ms": 50
1425}
1426```
1427
1428**Options**
1429
1430Inlay hints querying consists of two parts: editor (client) and LSP server.
1431With 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.
1432At 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.
1433
1434The following languages have inlay hints preconfigured by Zed:
1435
1436- [Go](https://docs.zed.dev/languages/go)
1437- [Rust](https://docs.zed.dev/languages/rust)
1438- [Svelte](https://docs.zed.dev/languages/svelte)
1439- [Typescript](https://docs.zed.dev/languages/typescript)
1440
1441Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
1442
1443Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
1444Settings-related hint updates are not debounced.
1445
1446## Journal
1447
1448- Description: Configuration for the journal.
1449- Setting: `journal`
1450- Default:
1451
1452```json
1453"journal": {
1454 "path": "~",
1455 "hour_format": "hour12"
1456}
1457```
1458
1459### Path
1460
1461- Description: The path of the directory where journal entries are stored.
1462- Setting: `path`
1463- Default: `~`
1464
1465**Options**
1466
1467`string` values
1468
1469### Hour Format
1470
1471- Description: The format to use for displaying hours in the journal.
1472- Setting: `hour_format`
1473- Default: `hour12`
1474
1475**Options**
1476
14771. 12-hour format:
1478
1479```json
1480{
1481 "hour_format": "hour12"
1482}
1483```
1484
14852. 24-hour format:
1486
1487```json
1488{
1489 "hour_format": "hour24"
1490}
1491```
1492
1493## Languages
1494
1495- Description: Configuration for specific languages.
1496- Setting: `languages`
1497- Default: `null`
1498
1499**Options**
1500
1501To override settings for a language, add an entry for that languages name to the `languages` value. Example:
1502
1503```json
1504"languages": {
1505 "C": {
1506 "format_on_save": "off",
1507 "preferred_line_length": 64,
1508 "soft_wrap": "preferred_line_length"
1509 },
1510 "JSON": {
1511 "tab_size": 4
1512 }
1513}
1514```
1515
1516The following settings can be overridden for each specific language:
1517
1518- [`enable_language_server`](#enable-language-server)
1519- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
1520- [`format_on_save`](#format-on-save)
1521- [`formatter`](#formatter)
1522- [`hard_tabs`](#hard-tabs)
1523- [`preferred_line_length`](#preferred-line-length)
1524- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
1525- [`show_edit_predictions`](#show-edit-predictions)
1526- [`show_whitespaces`](#show-whitespaces)
1527- [`soft_wrap`](#soft-wrap)
1528- [`tab_size`](#tab-size)
1529- [`use_autoclose`](#use-autoclose)
1530- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
1531
1532These values take in the same options as the root-level settings with the same name.
1533
1534## Network Proxy
1535
1536- Description: Configure a network proxy for Zed.
1537- Setting: `proxy`
1538- Default: `null`
1539
1540**Options**
1541
1542The proxy setting must contain a URL to the proxy.
1543
1544The following URI schemes are supported:
1545
1546- `http`
1547- `https`
1548- `socks4` - SOCKS4 proxy with local DNS
1549- `socks4a` - SOCKS4 proxy with remote DNS
1550- `socks5` - SOCKS5 proxy with local DNS
1551- `socks5h` - SOCKS5 proxy with remote DNS
1552
1553`http` will be used when no scheme is specified.
1554
1555By 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`.
1556
1557For example, to set an `http` proxy, add the following to your settings:
1558
1559```json
1560{
1561 "proxy": "http://127.0.0.1:10809"
1562}
1563```
1564
1565Or to set a `socks5` proxy:
1566
1567```json
1568{
1569 "proxy": "socks5h://localhost:10808"
1570}
1571```
1572
1573## Preview tabs
1574
1575- Description:
1576 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. \
1577 There are several ways to convert a preview tab into a regular tab:
1578
1579 - Double-clicking on the file
1580 - Double-clicking on the tab header
1581 - Using the `project_panel::OpenPermanent` action
1582 - Editing the file
1583 - Dragging the file to a different pane
1584
1585- Setting: `preview_tabs`
1586- Default:
1587
1588```json
1589"preview_tabs": {
1590 "enabled": true,
1591 "enable_preview_from_file_finder": false,
1592 "enable_preview_from_code_navigation": false,
1593}
1594```
1595
1596### Enable preview from file finder
1597
1598- Description: Determines whether to open files in preview mode when selected from the file finder.
1599- Setting: `enable_preview_from_file_finder`
1600- Default: `false`
1601
1602**Options**
1603
1604`boolean` values
1605
1606### Enable preview from code navigation
1607
1608- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
1609- Setting: `enable_preview_from_code_navigation`
1610- Default: `false`
1611
1612**Options**
1613
1614`boolean` values
1615
1616## File Finder
1617
1618### Modal Max Width
1619
1620- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
1621- Setting: `modal_max_width`
1622- Default: `small`
1623
1624## Preferred Line Length
1625
1626- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
1627- Setting: `preferred_line_length`
1628- Default: `80`
1629
1630**Options**
1631
1632`integer` values
1633
1634## Projects Online By Default
1635
1636- Description: Whether or not to show the online projects view by default.
1637- Setting: `projects_online_by_default`
1638- Default: `true`
1639
1640**Options**
1641
1642`boolean` values
1643
1644## Remove Trailing Whitespace On Save
1645
1646- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
1647- Setting: `remove_trailing_whitespace_on_save`
1648- Default: `true`
1649
1650**Options**
1651
1652`boolean` values
1653
1654## Search
1655
1656- Description: Search options to enable by default when opening new project and buffer searches.
1657- Setting: `search`
1658- Default:
1659
1660```json
1661"search": {
1662 "whole_word": false,
1663 "case_sensitive": false,
1664 "include_ignored": false,
1665 "regex": false
1666},
1667```
1668
1669## Show Call Status Icon
1670
1671- Description: Whether or not to show the call status icon in the status bar.
1672- Setting: `show_call_status_icon`
1673- Default: `true`
1674
1675**Options**
1676
1677`boolean` values
1678
1679## Show Completions On Input
1680
1681- Description: Whether or not to show completions as you type.
1682- Setting: `show_completions_on_input`
1683- Default: `true`
1684
1685**Options**
1686
1687`boolean` values
1688
1689## Show Completion Documentation
1690
1691- Description: Whether to display inline and alongside documentation for items in the completions menu.
1692- Setting: `show_completion_documentation`
1693- Default: `true`
1694
1695**Options**
1696
1697`boolean` values
1698
1699## Show Edit Predictions
1700
1701- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
1702- Setting: `show_edit_predictions`
1703- Default: `true`
1704
1705**Options**
1706
1707`boolean` values
1708
1709## Show Whitespaces
1710
1711- Description: Whether or not to show render whitespace characters in the editor.
1712- Setting: `show_whitespaces`
1713- Default: `selection`
1714
1715**Options**
1716
17171. `all`
17182. `selection`
17193. `none`
17204. `boundary`
1721
1722## Soft Wrap
1723
1724- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
1725- Setting: `soft_wrap`
1726- Default: `none`
1727
1728**Options**
1729
17301. `none` to avoid wrapping generally, unless the line is too long
17312. `prefer_line` (deprecated, same as `none`)
17323. `editor_width` to wrap lines that overflow the editor width
17334. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
17345. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
1735
1736## Wrap Guides (Vertical Rulers)
1737
1738- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
1739- Setting: `wrap_guides`
1740- Default: []
1741
1742**Options**
1743
1744List of `integer` column numbers
1745
1746## Tab Size
1747
1748- Description: The number of spaces to use for each tab character.
1749- Setting: `tab_size`
1750- Default: `4`
1751
1752**Options**
1753
1754`integer` values
1755
1756## Telemetry
1757
1758- Description: Control what info is collected by Zed.
1759- Setting: `telemetry`
1760- Default:
1761
1762```json
1763"telemetry": {
1764 "diagnostics": true,
1765 "metrics": true
1766},
1767```
1768
1769**Options**
1770
1771### Diagnostics
1772
1773- Description: Setting for sending debug-related data, such as crash reports.
1774- Setting: `diagnostics`
1775- Default: `true`
1776
1777**Options**
1778
1779`boolean` values
1780
1781### Metrics
1782
1783- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
1784- Setting: `metrics`
1785- Default: `true`
1786
1787**Options**
1788
1789`boolean` values
1790
1791## Terminal
1792
1793- Description: Configuration for the terminal.
1794- Setting: `terminal`
1795- Default:
1796
1797```json
1798{
1799 "terminal": {
1800 "alternate_scroll": "off",
1801 "blinking": "terminal_controlled",
1802 "copy_on_select": false,
1803 "dock": "bottom",
1804 "detect_venv": {
1805 "on": {
1806 "directories": [".env", "env", ".venv", "venv"],
1807 "activate_script": "default"
1808 }
1809 },
1810 "env": {},
1811 "font_family": null,
1812 "font_features": null,
1813 "font_size": null,
1814 "line_height": "comfortable",
1815 "option_as_meta": false,
1816 "button": false,
1817 "shell": {},
1818 "toolbar": {
1819 "breadcrumbs": true
1820 },
1821 "working_directory": "current_project_directory",
1822 "scrollbar": {
1823 "show": null
1824 }
1825 }
1826}
1827```
1828
1829### Terminal: Dock
1830
1831- Description: Control the position of the dock
1832- Setting: `dock`
1833- Default: `bottom`
1834
1835**Options**
1836
1837`"bottom"`, `"left"` or `"right"`
1838
1839### Terminal: Alternate Scroll
1840
1841- 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.
1842- Setting: `alternate_scroll`
1843- Default: `off`
1844
1845**Options**
1846
18471. Default alternate scroll mode to on
1848
1849```json
1850{
1851 "terminal": {
1852 "alternate_scroll": "on"
1853 }
1854}
1855```
1856
18572. Default alternate scroll mode to off
1858
1859```json
1860{
1861 "terminal": {
1862 "alternate_scroll": "off"
1863 }
1864}
1865```
1866
1867### Terminal: Blinking
1868
1869- Description: Set the cursor blinking behavior in the terminal
1870- Setting: `blinking`
1871- Default: `terminal_controlled`
1872
1873**Options**
1874
18751. Never blink the cursor, ignore the terminal mode
1876
1877```json
1878{
1879 "terminal": {
1880 "blinking": "off"
1881 }
1882}
1883```
1884
18852. Default the cursor blink to off, but allow the terminal to turn blinking on
1886
1887```json
1888{
1889 "terminal": {
1890 "blinking": "terminal_controlled"
1891 }
1892}
1893```
1894
18953. Always blink the cursor, ignore the terminal mode
1896
1897```json
1898{
1899 "terminal": {
1900 "blinking": "on"
1901 }
1902}
1903```
1904
1905### Terminal: Copy On Select
1906
1907- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
1908- Setting: `copy_on_select`
1909- Default: `false`
1910
1911**Options**
1912
1913`boolean` values
1914
1915**Example**
1916
1917```json
1918{
1919 "terminal": {
1920 "copy_on_select": true
1921 }
1922}
1923```
1924
1925### Terminal: Env
1926
1927- 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
1928- Setting: `env`
1929- Default: `{}`
1930
1931**Example**
1932
1933```json
1934{
1935 "terminal": {
1936 "env": {
1937 "ZED": "1",
1938 "KEY": "value1:value2"
1939 }
1940 }
1941}
1942```
1943
1944### Terminal: Font Size
1945
1946- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
1947- Setting: `font_size`
1948- Default: `null`
1949
1950**Options**
1951
1952`integer` values
1953
1954```json
1955{
1956 "terminal": {
1957 "font_size": 15
1958 }
1959}
1960```
1961
1962### Terminal: Font Family
1963
1964- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
1965- Setting: `font_family`
1966- Default: `null`
1967
1968**Options**
1969
1970The name of any font family installed on the user's system
1971
1972```json
1973{
1974 "terminal": {
1975 "font_family": "Berkeley Mono"
1976 }
1977}
1978```
1979
1980### Terminal: Font Features
1981
1982- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
1983- Setting: `font_features`
1984- Default: `null`
1985- Platform: macOS and Windows.
1986
1987**Options**
1988
1989See Buffer Font Features
1990
1991```json
1992{
1993 "terminal": {
1994 "font_features": {
1995 "calt": false
1996 // See Buffer Font Features for more features
1997 }
1998 }
1999}
2000```
2001
2002### Terminal: Line Height
2003
2004- Description: Set the terminal's line height.
2005- Setting: `line_height`
2006- Default: `comfortable`
2007
2008**Options**
2009
20101. Use a line height that's `comfortable` for reading, 1.618. (default)
2011
2012```json
2013{
2014 "terminal": {
2015 "line_height": "comfortable"
2016 }
2017}
2018```
2019
20202. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
2021
2022```json
2023{
2024 "terminal": {
2025 "line_height": "standard"
2026 }
2027}
2028```
2029
20303. Use a custom line height.
2031
2032```json
2033{
2034 "terminal": {
2035 "line_height": {
2036 "custom": 2
2037 }
2038 }
2039}
2040```
2041
2042### Terminal: Option As Meta
2043
2044- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
2045- Setting: `option_as_meta`
2046- Default: `false`
2047
2048**Options**
2049
2050`boolean` values
2051
2052```json
2053{
2054 "terminal": {
2055 "option_as_meta": true
2056 }
2057}
2058```
2059
2060### Terminal: Shell
2061
2062- Description: What shell to use when launching the terminal.
2063- Setting: `shell`
2064- Default: `system`
2065
2066**Options**
2067
20681. Use the system's default terminal configuration (usually the `/etc/passwd` file).
2069
2070```json
2071{
2072 "terminal": {
2073 "shell": "system"
2074 }
2075}
2076```
2077
20782. A program to launch:
2079
2080```json
2081{
2082 "terminal": {
2083 "shell": {
2084 "program": "sh"
2085 }
2086 }
2087}
2088```
2089
20903. A program with arguments:
2091
2092```json
2093{
2094 "terminal": {
2095 "shell": {
2096 "with_arguments": {
2097 "program": "/bin/bash",
2098 "args": ["--login"]
2099 }
2100 }
2101 }
2102}
2103```
2104
2105## Terminal: Detect Virtual Environments {#terminal-detect_venv}
2106
2107- 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.
2108- Setting: `detect_venv`
2109- Default:
2110
2111```json
2112{
2113 "terminal": {
2114 "detect_venv": {
2115 "on": {
2116 // Default directories to search for virtual environments, relative
2117 // to the current working directory. We recommend overriding this
2118 // in your project's settings, rather than globally.
2119 "directories": [".venv", "venv"],
2120 // Can also be `csh`, `fish`, and `nushell`
2121 "activate_script": "default"
2122 }
2123 }
2124 }
2125}
2126```
2127
2128Disable with:
2129
2130```json
2131{
2132 "terminal": {
2133 "detect_venv": "off"
2134 }
2135}
2136```
2137
2138## Terminal: Toolbar
2139
2140- Description: Whether or not to show various elements in the terminal toolbar.
2141- Setting: `toolbar`
2142- Default:
2143
2144```json
2145{
2146 "terminal": {
2147 "toolbar": {
2148 "breadcrumbs": true
2149 }
2150 }
2151}
2152```
2153
2154**Options**
2155
2156At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
2157
2158If the terminal title is empty, the breadcrumbs won't be shown.
2159
2160The shell running in the terminal needs to be configured to emit the title.
2161
2162Example command to set the title: `echo -e "\e]2;New Title\007";`
2163
2164### Terminal: Button
2165
2166- Description: Control to show or hide the terminal button in the status bar
2167- Setting: `button`
2168- Default: `true`
2169
2170**Options**
2171
2172`boolean` values
2173
2174```json
2175{
2176 "terminal": {
2177 "button": false
2178 }
2179}
2180```
2181
2182### Terminal: Working Directory
2183
2184- Description: What working directory to use when launching the terminal.
2185- Setting: `working_directory`
2186- Default: `"current_project_directory"`
2187
2188**Options**
2189
21901. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
2191
2192```json
2193{
2194 "terminal": {
2195 "working_directory": "current_project_directory"
2196 }
2197}
2198```
2199
22002. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
2201
2202```json
2203{
2204 "terminal": {
2205 "working_directory": "first_project_directory"
2206 }
2207}
2208```
2209
22103. Always use this platform's home directory (if we can find it)
2211
2212```json
2213{
2214 "terminal": {
2215 "working_directory": "always_home"
2216 }
2217}
2218```
2219
22204. 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.
2221
2222```json
2223{
2224 "terminal": {
2225 "working_directory": {
2226 "always": {
2227 "directory": "~/zed/projects/"
2228 }
2229 }
2230 }
2231}
2232```
2233
2234## Theme
2235
2236- 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.
2237- Setting: `theme`
2238- Default: `One Dark`
2239
2240### Theme Object
2241
2242- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
2243- Setting: `theme`
2244- Default:
2245
2246```json
2247"theme": {
2248 "mode": "system",
2249 "dark": "One Dark",
2250 "light": "One Light"
2251},
2252```
2253
2254### Mode
2255
2256- Description: Specify theme mode.
2257- Setting: `mode`
2258- Default: `system`
2259
2260**Options**
2261
22621. Set the theme to dark mode
2263
2264```json
2265{
2266 "mode": "dark"
2267}
2268```
2269
22702. Set the theme to light mode
2271
2272```json
2273{
2274 "mode": "light"
2275}
2276```
2277
22783. Set the theme to system mode
2279
2280```json
2281{
2282 "mode": "system"
2283}
2284```
2285
2286### Dark
2287
2288- Description: The name of the dark Zed theme to use for the UI.
2289- Setting: `dark`
2290- Default: `One Dark`
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### Light
2297
2298- Description: The name of the light Zed theme to use for the UI.
2299- Setting: `light`
2300- Default: `One Light`
2301
2302**Options**
2303
2304Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
2305
2306## Vim
2307
2308- Description: Whether or not to enable vim mode (work in progress).
2309- Setting: `vim_mode`
2310- Default: `false`
2311
2312## Project Panel
2313
2314- Description: Customize project panel
2315- Setting: `project_panel`
2316- Default:
2317
2318```json
2319{
2320 "project_panel": {
2321 "button": true,
2322 "default_width": 240,
2323 "dock": "left",
2324 "entry_spacing": "comfortable",
2325 "file_icons": true,
2326 "folder_icons": true,
2327 "git_status": true,
2328 "indent_size": 20,
2329 "indent_guides": true,
2330 "auto_reveal_entries": true,
2331 "auto_fold_dirs": true,
2332 "scrollbar": {
2333 "show": null
2334 },
2335 "indent_guides": {
2336 "show": "always"
2337 }
2338 }
2339}
2340```
2341
2342### Dock
2343
2344- Description: Control the position of the dock
2345- Setting: `dock`
2346- Default: `left`
2347
2348**Options**
2349
23501. Default dock position to left
2351
2352```json
2353{
2354 "dock": "left"
2355}
2356```
2357
23582. Default dock position to right
2359
2360```json
2361{
2362 "dock": "right"
2363}
2364```
2365
2366### Entry Spacing
2367
2368- Description: Spacing between worktree entries
2369- Setting: `entry_spacing`
2370- Default: `comfortable`
2371
2372**Options**
2373
23741. Comfortable entry spacing
2375
2376```json
2377{
2378 "entry_spacing": "comfortable"
2379}
2380```
2381
23822. Standard entry spacing
2383
2384```json
2385{
2386 "entry_spacing": "standard"
2387}
2388```
2389
2390### Git Status
2391
2392- Description: Indicates newly created and updated files
2393- Setting: `git_status`
2394- Default: `true`
2395
2396**Options**
2397
23981. Default enable git status
2399
2400```json
2401{
2402 "git_status": true
2403}
2404```
2405
24062. Default disable git status
2407
2408```json
2409{
2410 "git_status": false
2411}
2412```
2413
2414### Default Width
2415
2416- Description: Customize default width taken by project panel
2417- Setting: `default_width`
2418- Default: N/A width in pixels (eg: 420)
2419
2420**Options**
2421
2422`boolean` values
2423
2424### Auto Reveal Entries
2425
2426- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
2427- Setting: `auto_reveal_entries`
2428- Default: `true`
2429
2430**Options**
2431
24321. Enable auto reveal entries
2433
2434```json
2435{
2436 "auto_reveal_entries": true
2437}
2438```
2439
24402. Disable auto reveal entries
2441
2442```json
2443{
2444 "auto_reveal_entries": false
2445}
2446```
2447
2448### Auto Fold Dirs
2449
2450- Description: Whether to fold directories automatically when directory has only one directory inside.
2451- Setting: `auto_fold_dirs`
2452- Default: `true`
2453
2454**Options**
2455
24561. Enable auto fold dirs
2457
2458```json
2459{
2460 "auto_fold_dirs": true
2461}
2462```
2463
24642. Disable auto fold dirs
2465
2466```json
2467{
2468 "auto_fold_dirs": false
2469}
2470```
2471
2472### Indent Size
2473
2474- Description: Amount of indentation (in pixels) for nested items.
2475- Setting: `indent_size`
2476- Default: `20`
2477
2478### Indent Guides: Show
2479
2480- Description: Whether to show indent guides in the project panel. Possible values: "always", "never".
2481- Setting: `indent_guides`
2482
2483```json
2484"indent_guides": {
2485 "show": "always"
2486}
2487```
2488
2489**Options**
2490
24911. Show indent guides in the project panel
2492
2493```json
2494{
2495 "indent_guides": {
2496 "show": "always"
2497 }
2498}
2499```
2500
25012. Hide indent guides in the project panel
2502
2503```json
2504{
2505 "indent_guides": {
2506 "show": "never"
2507 }
2508}
2509```
2510
2511### Scrollbar: Show
2512
2513- 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.
2514- Setting: `scrollbar`
2515- Default:
2516
2517```json
2518"scrollbar": {
2519 "show": null
2520}
2521```
2522
2523**Options**
2524
25251. Show scrollbar in the project panel
2526
2527```json
2528{
2529 "scrollbar": {
2530 "show": "always"
2531 }
2532}
2533```
2534
25352. Hide scrollbar in the project panel
2536
2537```json
2538{
2539 "scrollbar": {
2540 "show": "never"
2541 }
2542}
2543```
2544
2545## Assistant Panel
2546
2547- Description: Customize assistant panel
2548- Setting: `assistant`
2549- Default:
2550
2551```json
2552"assistant": {
2553 "enabled": true,
2554 "button": true,
2555 "dock": "right",
2556 "default_width": 640,
2557 "default_height": 320,
2558 "provider": "openai",
2559 "version": "1",
2560},
2561```
2562
2563## Outline Panel
2564
2565- Description: Customize outline Panel
2566- Setting: `outline_panel`
2567- Default:
2568
2569```json
2570"outline_panel": {
2571 "button": true,
2572 "default_width": 240,
2573 "dock": "left",
2574 "file_icons": true,
2575 "folder_icons": true,
2576 "git_status": true,
2577 "indent_size": 20,
2578 "auto_reveal_entries": true,
2579 "auto_fold_dirs": true,
2580 "indent_guides": {
2581 "show": "always"
2582 },
2583 "scrollbar": {
2584 "show": null
2585 }
2586}
2587```
2588
2589## Calls
2590
2591- Description: Customize behavior when participating in a call
2592- Setting: `calls`
2593- Default:
2594
2595```json
2596"calls": {
2597 // Join calls with the microphone live by default
2598 "mute_on_join": false,
2599 // Share your project when you are the first to join a channel
2600 "share_on_join": false
2601},
2602```
2603
2604## Unnecessary Code Fade
2605
2606- Description: How much to fade out unused code.
2607- Setting: `unnecessary_code_fade`
2608- Default: `0.3`
2609
2610**Options**
2611
2612Float values between `0.0` and `0.9`, where:
2613
2614- `0.0` means no fading (unused code looks the same as used code)
2615- `0.9` means maximum fading (unused code is very faint but still visible)
2616
2617**Example**
2618
2619```json
2620{
2621 "unnecessary_code_fade": 0.5
2622}
2623```
2624
2625## UI Font Family
2626
2627- Description: The name of the font to use for text in the UI.
2628- Setting: `ui_font_family`
2629- Default: `Zed Plex Sans`
2630
2631**Options**
2632
2633The name of any font family installed on the system.
2634
2635## UI Font Features
2636
2637- Description: The OpenType features to enable for text in the UI.
2638- Setting: `ui_font_features`
2639- Default: `null`
2640- Platform: macOS and Windows.
2641
2642**Options**
2643
2644Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
2645
2646For example, to disable font ligatures, add the following to your settings:
2647
2648```json
2649{
2650 "ui_font_features": {
2651 "calt": false
2652 }
2653}
2654```
2655
2656You can also set other OpenType features, like setting `cv01` to `7`:
2657
2658```json
2659{
2660 "ui_font_features": {
2661 "cv01": 7
2662 }
2663}
2664```
2665
2666## UI Font Fallbacks
2667
2668- Description: The font fallbacks to use for text in the UI.
2669- Setting: `ui_font_fallbacks`
2670- Default: `null`
2671- Platform: macOS and Windows.
2672
2673**Options**
2674
2675For example, to use `Nerd Font` as a fallback, add the following to your settings:
2676
2677```json
2678{
2679 "ui_font_fallbacks": ["Nerd Font"]
2680}
2681```
2682
2683## UI Font Size
2684
2685- Description: The default font size for text in the UI.
2686- Setting: `ui_font_size`
2687- Default: `16`
2688
2689**Options**
2690
2691`integer` values from `6` to `100` pixels (inclusive)
2692
2693## UI Font Weight
2694
2695- Description: The default font weight for text in the UI.
2696- Setting: `ui_font_weight`
2697- Default: `400`
2698
2699**Options**
2700
2701`integer` values between `100` and `900`
2702
2703## An example configuration:
2704
2705```json
2706// ~/.config/zed/settings.json
2707{
2708 "theme": "cave-light",
2709 "tab_size": 2,
2710 "preferred_line_length": 80,
2711 "soft_wrap": "none",
2712
2713 "buffer_font_size": 18,
2714 "buffer_font_family": "Zed Plex Mono",
2715
2716 "autosave": "on_focus_change",
2717 "format_on_save": "off",
2718 "vim_mode": false,
2719 "projects_online_by_default": true,
2720 "terminal": {
2721 "font_family": "FiraCode Nerd Font Mono",
2722 "blinking": "off"
2723 },
2724 "languages": {
2725 "C": {
2726 "format_on_save": "language_server",
2727 "preferred_line_length": 64,
2728 "soft_wrap": "preferred_line_length"
2729 }
2730 }
2731}
2732```