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 Magnification
33
34- 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.
35- Setting: `active_pane_magnification`
36- Default: `1.0`
37
38**Options**
39
40`float` values
41
42## Autosave
43
44- Description: When to automatically save edited buffers.
45- Setting: `autosave`
46- Default: `off`
47
48**Options**
49
501. To disable autosave, set it to `off`:
51
52```json
53{
54 "autosave": "off"
55}
56```
57
582. To autosave when focus changes, use `on_focus_change`:
59
60```json
61{
62 "autosave": "on_focus_change"
63}
64```
65
663. To autosave when the active window changes, use `on_window_change`:
67
68```json
69{
70 "autosave": "on_window_change"
71}
72```
73
744. To autosave after an inactivity period, use `after_delay`:
75
76```json
77{
78 "autosave": {
79 "after_delay": {
80 "milliseconds": 1000
81 }
82 }
83}
84```
85
86## Auto Update
87
88- Description: Whether or not to automatically check for updates.
89- Setting: `auto_update`
90- Default: `true`
91
92**Options**
93
94`boolean` values
95
96## Base Keymap
97
98- Description: Base key bindings scheme. Base keymaps can be overridden with user keymaps.
99- Setting: `base_keymap`
100- Default: `VSCode`
101
102**Options**
103
1041. VSCode
105
106```json
107{
108 "base_keymap": "VSCode"
109}
110```
111
1122. Atom
113
114```json
115{
116 "base_keymap": "Atom"
117}
118```
119
1203. JetBrains
121
122```json
123{
124 "base_keymap": "JetBrains"
125}
126```
127
1284. None
129
130```json
131{
132 "base_keymap": "None"
133}
134```
135
1365. SublimeText
137
138```json
139{
140 "base_keymap": "SublimeText"
141}
142```
143
1446. TextMate
145
146```json
147{
148 "base_keymap": "TextMate"
149}
150```
151
152## Buffer Font Family
153
154- Description: The name of a font to use for rendering text in the editor.
155- Setting: `buffer_font_family`
156- Default: `Zed Plex Mono`
157
158**Options**
159
160The name of any font family installed on the user's system
161
162## Buffer Font Features
163
164- Description: The OpenType features to enable for text in the editor.
165- Setting: `buffer_font_features`
166- Default: `null`
167- Platform: macOS and Windows.
168
169**Options**
170
171Zed 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.
172
173For example, to disable font ligatures, add the following to your settings:
174
175```json
176{
177 "buffer_font_features": {
178 "calt": false
179 }
180}
181```
182
183You can also set other OpenType features, like setting `cv01` to `7`:
184
185```json
186{
187 "buffer_font_features": {
188 "cv01": 7
189 }
190}
191```
192
193## Buffer Font Fallbacks
194
195- Description: Set the buffer text's font fallbacks, this will be merged with the platform's default fallbacks.
196- Setting: `buffer_font_fallbacks`
197- Default: `null`
198- Platform: macOS and Windows.
199
200**Options**
201
202For example, to use `Nerd Font` as a fallback, add the following to your settings:
203
204```json
205{
206 "buffer_font_fallbacks": ["Nerd Font"]
207}
208```
209
210## Buffer Font Size
211
212- Description: The default font size for text in the editor.
213- Setting: `buffer_font_size`
214- Default: `15`
215
216**Options**
217
218`integer` values from `6` to `100` pixels (inclusive)
219
220## Buffer Font Weight
221
222- Description: The default font weight for text in the editor.
223- Setting: `buffer_font_weight`
224- Default: `400`
225
226**Options**
227
228`integer` values between `100` and `900`
229
230## Buffer Line Height
231
232- Description: The default line height for text in the editor.
233- Setting: `buffer_line_height`
234- Default: `"comfortable"`
235
236**Options**
237
238`"standard"`, `"comfortable"` or `{"custom": float}` (`1` is very compact, `2` very loose)
239
240## Confirm Quit
241
242- Description: Whether or not to prompt the user to confirm before closing the application.
243- Setting: `confirm_quit`
244- Default: `false`
245
246**Options**
247
248`boolean` values
249
250## Centered Layout
251
252- Description: Configuration for the centered layout mode.
253- Setting: `centered_layout`
254- Default:
255
256```json
257"centered_layout": {
258 "left_padding": 0.2,
259 "right_padding": 0.2,
260}
261```
262
263**Options**
264
265The `left_padding` and `right_padding` options define the relative width of the
266left 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`.
267
268## Direnv Integration
269
270- Description: Settings for [direnv](https://direnv.net/) integration. Requires `direnv` to be installed.
271 `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.
272 It also allows for those environment variables to be used in tasks.
273- Setting: `load_direnv`
274- Default:
275
276```json
277"load_direnv": "direct"
278```
279
280**Options**
281There are two options to choose from:
282
2831. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
2842. `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.
285
286## Inline Completions
287
288- Description: Settings for inline completions.
289- Setting: `inline_completions`
290- Default:
291
292```json
293"inline_completions": {
294 "disabled_globs": [
295 ".env"
296 ]
297}
298```
299
300**Options**
301
302### Disabled Globs
303
304- Description: A list of globs representing files that inline completions should be disabled for.
305- Setting: `disabled_globs`
306- Default: `[".env"]`
307
308**Options**
309
310List of `string` values
311
312## Current Line Highlight
313
314- Description: How to highlight the current line in the editor.
315- Setting: `current_line_highlight`
316- Default: `all`
317
318**Options**
319
3201. Don't highlight the current line:
321
322```json
323"current_line_highlight": "none"
324```
325
3262. Highlight the gutter area:
327
328```json
329"current_line_highlight": "gutter"
330```
331
3323. Highlight the editor area:
333
334```json
335"current_line_highlight": "line"
336```
337
3384. Highlight the full line:
339
340```json
341"current_line_highlight": "all"
342```
343
344## Cursor Blink
345
346- Description: Whether or not the cursor blinks.
347- Setting: `cursor_blink`
348- Default: `true`
349
350**Options**
351
352`boolean` values
353
354## Cursor Shape
355
356- Description: Cursor shape for the default editor.
357- Setting: `cursor_shape`
358- Default: `bar`
359
360**Options**
361
3621. A vertical bar:
363
364```json
365"cursor_shape": "bar"
366```
367
3682. A block that surrounds the following character:
369
370```json
371"cursor_shape": "block"
372```
373
3743. An underline / underscore that runs along the following character:
375
376```json
377"cursor_shape": "underline"
378```
379
3804. An box drawn around the following character:
381
382```json
383"cursor_shape": "hollow"
384```
385
386**Options**
387
3881. Position the dock attached to the bottom of the workspace: `bottom`
3892. Position the dock to the right of the workspace like a side panel: `right`
3903. Position the dock full screen over the entire workspace: `expanded`
391
392## Editor Scrollbar
393
394- Description: Whether or not to show the editor scrollbar and various elements in it.
395- Setting: `scrollbar`
396- Default:
397
398```json
399"scrollbar": {
400 "show": "auto",
401 "cursors": true,
402 "git_diff": true,
403 "search_results": true,
404 "selected_symbol": true,
405 "diagnostics": true
406},
407```
408
409### Show Mode
410
411- Description: When to show the editor scrollbar.
412- Setting: `show`
413- Default: `auto`
414
415**Options**
416
4171. Show the scrollbar if there's important information or follow the system's configured behavior:
418
419```json
420"scrollbar": {
421 "show": "auto"
422}
423```
424
4252. Match the system's configured behavior:
426
427```json
428"scrollbar": {
429 "show": "system"
430}
431```
432
4333. Always show the scrollbar:
434
435```json
436"scrollbar": {
437 "show": "always"
438}
439```
440
4414. Never show the scrollbar:
442
443```json
444"scrollbar": {
445 "show": "never"
446}
447```
448
449### Cursor Indicators
450
451- Description: Whether to show cursor positions in the scrollbar.
452- Setting: `cursors`
453- Default: `true`
454
455**Options**
456
457`boolean` values
458
459### Git Diff Indicators
460
461- Description: Whether to show git diff indicators in the scrollbar.
462- Setting: `git_diff`
463- Default: `true`
464
465**Options**
466
467`boolean` values
468
469### Search Results Indicators
470
471- Description: Whether to show buffer search results in the scrollbar.
472- Setting: `search_results`
473- Default: `true`
474
475**Options**
476
477`boolean` values
478
479### Selected Symbols Indicators
480
481- Description: Whether to show selected symbol occurrences in the scrollbar.
482- Setting: `selected_symbol`
483- Default: `true`
484
485**Options**
486
487`boolean` values
488
489### Diagnostics
490
491- Description: Whether to show diagnostic indicators in the scrollbar.
492- Setting: `diagnostics`
493- Default: `true`
494
495**Options**
496
497`boolean` values
498
499## Editor Tab Bar
500
501- Description: Settings related to the editor's tab bar.
502- Settings: `tab_bar`
503- Default:
504
505```json
506"tab_bar": {
507 "show": true,
508 "show_nav_history_buttons": true
509}
510```
511
512### Show
513
514- Description: Whether or not to show the tab bar in the editor.
515- Setting: `show`
516- Default: `true`
517
518**Options**
519
520`boolean` values
521
522### Navigation History Buttons
523
524- Description: Whether or not to show the navigation history buttons.
525- Setting: `show_nav_history_buttons`
526- Default: `true`
527
528**Options**
529
530`boolean` values
531
532## Editor Tabs
533
534- Description: Configuration for the editor tabs.
535- Setting: `tabs`
536- Default:
537
538```json
539"tabs": {
540 "close_position": "right",
541 "file_icons": false,
542 "git_status": false,
543 "activate_on_close": "history"
544},
545```
546
547### Close Position
548
549- Description: Where to display close button within a tab.
550- Setting: `close_position`
551- Default: `right`
552
553**Options**
554
5551. Display the close button on the right:
556
557```json
558{
559 "close_position": "right"
560}
561```
562
5632. Display the close button on the left:
564
565```json
566{
567 "close_position": "left"
568}
569```
570
571### File Icons
572
573- Description: Whether to show the file icon for a tab.
574- Setting: `file_icons`
575- Default: `false`
576
577### Git Status
578
579- Description: Whether or not to show Git file status in tab.
580- Setting: `git_status`
581- Default: `false`
582
583### Activate on close
584
585- Description: What to do after closing the current tab.
586- Setting: `activate_on_close`
587- Default: `history`
588
589**Options**
590
5911. Activate the tab that was open previously:
592
593```json
594{
595 "activate_on_close": "history"
596}
597```
598
5992. Activate the neighbour tab (prefers the right one, if present):
600
601```json
602{
603 "activate_on_close": "neighbour"
604}
605```
606
607## Editor Toolbar
608
609- Description: Whether or not to show various elements in the editor toolbar.
610- Setting: `toolbar`
611- Default:
612
613```json
614"toolbar": {
615 "breadcrumbs": true,
616 "quick_actions": true
617},
618```
619
620**Options**
621
622Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
623
624## Enable Language Server
625
626- Description: Whether or not to use language servers to provide code intelligence.
627- Setting: `enable_language_server`
628- Default: `true`
629
630**Options**
631
632`boolean` values
633
634## Ensure Final Newline On Save
635
636- Description: Whether or not to ensure there's a single newline at the end of a buffer when saving it.
637- Setting: `ensure_final_newline_on_save`
638- Default: `true`
639
640**Options**
641
642`boolean` values
643
644## LSP
645
646- Description: Configuration for language servers.
647- Setting: `lsp`
648- Default: `null`
649
650**Options**
651
652The following settings can be overridden for specific language servers:
653
654- `initialization_options`
655- `settings`
656
657To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
658
659Some 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.
660
661For example to pass the `check` option to `rust-analyzer`, use the following configuration:
662
663```json
664"lsp": {
665 "rust-analyzer": {
666 "initialization_options": {
667 "check": {
668 "command": "clippy" // rust-analyzer.check.command (default: "check")
669 }
670 }
671 }
672}
673```
674
675While other options may be changed at a runtime and should be placed under `settings`:
676
677```json
678"lsp": {
679 "yaml-language-server": {
680 "settings": {
681 "yaml": {
682 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
683 }
684 }
685 }
686}
687```
688
689## Format On Save
690
691- Description: Whether or not to perform a buffer format before saving.
692- Setting: `format_on_save`
693- Default: `on`
694
695**Options**
696
6971. `on`, enables format on save obeying `formatter` setting:
698
699```json
700{
701 "format_on_save": "on"
702}
703```
704
7052. `off`, disables format on save:
706
707```json
708{
709 "format_on_save": "off"
710}
711```
712
713## Formatter
714
715- Description: How to perform a buffer format.
716- Setting: `formatter`
717- Default: `auto`
718
719**Options**
720
7211. To use the current language server, use `"language_server"`:
722
723```json
724{
725 "formatter": "language_server"
726}
727```
728
7292. 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):
730
731```json
732{
733 "formatter": {
734 "external": {
735 "command": "sed",
736 "arguments": ["-e", "s/ *$//"]
737 }
738 }
739}
740```
741
7423. 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.
743
744```json
745 "formatter": {
746 "external": {
747 "command": "prettier",
748 "arguments": ["--stdin-filepath", "{buffer_path}"]
749 }
750 }
751```
752
7534. Or to use code actions provided by the connected language servers, use `"code_actions"`:
754
755```json
756{
757 "formatter": {
758 "code_actions": {
759 // Use ESLint's --fix:
760 "source.fixAll.eslint": true,
761 // Organize imports on save:
762 "source.organizeImports": true
763 }
764 }
765}
766```
767
7685. Or to use multiple formatters consecutively, use an array of formatters:
769
770```json
771{
772 "formatter": [
773 {"language_server": {"name": "rust-analyzer"}},
774 {"external": {
775 "command": "sed",
776 "arguments": ["-e", "s/ *$//"]
777 }
778 ]
779}
780```
781
782Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
783If any of the formatters fails, the subsequent ones will still be executed.
784
785## Code Actions On Format
786
787- Description: The code actions to perform with the primary language server when formatting the buffer.
788- Setting: `code_actions_on_format`
789- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
790
791**Examples**
792
793<!--
794TBD: Add Python Ruff source.organizeImports example
795-->
796
7971. Organize imports on format in TypeScript and TSX buffers:
798
799```json
800{
801 "languages": {
802 "TypeScript": {
803 "code_actions_on_format": {
804 "source.organizeImports": true
805 }
806 },
807 "TSX": {
808 "code_actions_on_format": {
809 "source.organizeImports": true
810 }
811 }
812 }
813}
814```
815
8162. Run ESLint `fixAll` code action when formatting:
817
818```json
819{
820 "languages": {
821 "JavaScript": {
822 "code_actions_on_format": {
823 "source.fixAll.eslint": true
824 }
825 }
826 }
827}
828```
829
8303. Run only a single ESLint rule when using `fixAll`:
831
832```json
833{
834 "languages": {
835 "JavaScript": {
836 "code_actions_on_format": {
837 "source.fixAll.eslint": true
838 }
839 }
840 },
841 "lsp": {
842 "eslint": {
843 "settings": {
844 "codeActionOnSave": {
845 "rules": ["import/order"]
846 }
847 }
848 }
849 }
850}
851```
852
853## Auto close
854
855- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
856- Setting: `use_autoclose`
857- Default: `true`
858
859**Options**
860
861`boolean` values
862
863## Always Treat Brackets As Autoclosed
864
865- Description: Controls how the editor handles the autoclosed characters.
866- Setting: `always_treat_brackets_as_autoclosed`
867- Default: `false`
868
869**Options**
870
871`boolean` values
872
873**Example**
874
875If the setting is set to `true`:
876
8771. Enter in the editor: `)))`
8782. Move the cursor to the start: `^)))`
8793. Enter again: `)))`
880
881The result is still `)))` and not `))))))`, which is what it would be by default.
882
883## File Scan Exclusions
884
885- Setting: `file_scan_exclusions`
886- Description: Configure how Add filename or directory globs that will be excluded by Zed entirely. They will be skipped during file scans, file searches and hidden from project file tree.
887- Default:
888
889```json
890"file_scan_exclusions": [
891 "**/.git",
892 "**/.svn",
893 "**/.hg",
894 "**/CVS",
895 "**/.DS_Store",
896 "**/Thumbs.db",
897 "**/.classpath",
898 "**/.settings"
899],
900```
901
902Note, 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.
903
904## File Types
905
906- Setting: `file_types`
907- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
908- Default: `{}`
909
910**Examples**
911
912To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
913
914```json
915{
916 "file_types": {
917 "C++": ["c"],
918 "TOML": ["MyLockFile"],
919 "Dockerfile": ["Dockerfile*"]
920 }
921}
922```
923
924## Git
925
926- Description: Configuration for git-related features.
927- Setting: `git`
928- Default:
929
930```json
931{
932 "git": {
933 "git_gutter": "tracked_files",
934 "inline_blame": {
935 "enabled": true
936 }
937 }
938}
939```
940
941### Git Gutter
942
943- Description: Whether or not to show the git gutter.
944- Setting: `git_gutter`
945- Default: `tracked_files`
946
947**Options**
948
9491. Show git gutter in tracked files
950
951```json
952{
953 "git": {
954 "git_gutter": "tracked_files"
955 }
956}
957```
958
9592. Hide git gutter
960
961```json
962{
963 "git": {
964 "git_gutter": "hide"
965 }
966}
967```
968
969### Inline Git Blame
970
971- Description: Whether or not to show git blame information inline, on the currently focused line.
972- Setting: `inline_blame`
973- Default:
974
975```json
976{
977 "git": {
978 "inline_blame": {
979 "enabled": true
980 }
981 }
982}
983```
984
985**Options**
986
9871. Disable inline git blame:
988
989```json
990{
991 "git": {
992 "inline_blame": {
993 "enabled": false
994 }
995 }
996}
997```
998
9992. Only show inline git blame after a delay (that starts after cursor stops moving):
1000
1001```json
1002{
1003 "git": {
1004 "inline_blame": {
1005 "enabled": true,
1006 "delay_ms": 500
1007 }
1008 }
1009}
1010```
1011
1012## Indent Guides
1013
1014- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
1015- Setting: `indent_guides`
1016- Default:
1017
1018```json
1019{
1020 "indent_guides": {
1021 "enabled": true,
1022 "line_width": 1,
1023 "active_line_width": 1,
1024 "coloring": "fixed",
1025 "background_coloring": "disabled"
1026 }
1027}
1028```
1029
1030**Options**
1031
10321. Disable indent guides
1033
1034```json
1035{
1036 "indent_guides": {
1037 "enabled": false
1038 }
1039}
1040```
1041
10422. Enable indent guides for a specific language.
1043
1044```json
1045{
1046 "languages": {
1047 "Python": {
1048 "indent_guides": {
1049 "enabled": true
1050 }
1051 }
1052 }
1053}
1054```
1055
10563. Enable indent aware coloring ("rainbow indentation").
1057 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.
1058
1059```json
1060{
1061 "indent_guides": {
1062 "enabled": true,
1063 "coloring": "indent_aware"
1064 }
1065}
1066```
1067
10684. Enable indent aware background coloring ("rainbow indentation").
1069 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.
1070
1071```json
1072{
1073 "indent_guides": {
1074 "enabled": true,
1075 "coloring": "indent_aware",
1076 "background_coloring": "indent_aware"
1077 }
1078}
1079```
1080
1081## Hard Tabs
1082
1083- Description: Whether to indent lines using tab characters or multiple spaces.
1084- Setting: `hard_tabs`
1085- Default: `false`
1086
1087**Options**
1088
1089`boolean` values
1090
1091## Hover Popover Enabled
1092
1093- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
1094- Setting: `hover_popover_enabled`
1095- Default: `true`
1096
1097**Options**
1098
1099`boolean` values
1100
1101## Inlay hints
1102
1103- Description: Configuration for displaying extra text with hints in the editor.
1104- Setting: `inlay_hints`
1105- Default:
1106
1107```json
1108"inlay_hints": {
1109 "enabled": false,
1110 "show_type_hints": true,
1111 "show_parameter_hints": true,
1112 "show_other_hints": true,
1113 "show_background": false,
1114 "edit_debounce_ms": 700,
1115 "scroll_debounce_ms": 50
1116}
1117```
1118
1119**Options**
1120
1121Inlay hints querying consists of two parts: editor (client) and LSP server.
1122With 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.
1123At 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.
1124
1125The following languages have inlay hints preconfigured by Zed:
1126
1127- [Go](https://docs.zed.dev/languages/go)
1128- [Rust](https://docs.zed.dev/languages/rust)
1129- [Svelte](https://docs.zed.dev/languages/svelte)
1130- [Typescript](https://docs.zed.dev/languages/typescript)
1131
1132Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
1133
1134Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
1135Settings-related hint updates are not debounced.
1136
1137## Journal
1138
1139- Description: Configuration for the journal.
1140- Setting: `journal`
1141- Default:
1142
1143```json
1144"journal": {
1145 "path": "~",
1146 "hour_format": "hour12"
1147}
1148```
1149
1150### Path
1151
1152- Description: The path of the directory where journal entries are stored.
1153- Setting: `path`
1154- Default: `~`
1155
1156**Options**
1157
1158`string` values
1159
1160### Hour Format
1161
1162- Description: The format to use for displaying hours in the journal.
1163- Setting: `hour_format`
1164- Default: `hour12`
1165
1166**Options**
1167
11681. 12-hour format:
1169
1170```json
1171{
1172 "hour_format": "hour12"
1173}
1174```
1175
11762. 24-hour format:
1177
1178```json
1179{
1180 "hour_format": "hour24"
1181}
1182```
1183
1184## Languages
1185
1186- Description: Configuration for specific languages.
1187- Setting: `languages`
1188- Default: `null`
1189
1190**Options**
1191
1192To override settings for a language, add an entry for that languages name to the `languages` value. Example:
1193
1194```json
1195"languages": {
1196 "C": {
1197 "format_on_save": "off",
1198 "preferred_line_length": 64,
1199 "soft_wrap": "preferred_line_length"
1200 },
1201 "JSON": {
1202 "tab_size": 4
1203 }
1204}
1205```
1206
1207The following settings can be overridden for each specific language:
1208
1209- `enable_language_server`
1210- `ensure_final_newline_on_save`
1211- `format_on_save`
1212- `formatter`
1213- `hard_tabs`
1214- `preferred_line_length`
1215- `remove_trailing_whitespace_on_save`
1216- `show_inline_completions`
1217- `show_whitespaces`
1218- `soft_wrap`
1219- `tab_size`
1220- `use_autoclose`
1221- `always_treat_brackets_as_autoclosed`
1222
1223These values take in the same options as the root-level settings with the same name.
1224
1225## Network Proxy
1226
1227- Description: Configure a network proxy for Zed.
1228- Setting: `proxy`
1229- Default: `null`
1230
1231**Options**
1232
1233The proxy setting must contain a URL to the proxy.
1234
1235The following URI schemes are supported:
1236
1237- `http`
1238- `https`
1239- `socks4` - SOCKS4 proxy with local DNS
1240- `socks4a` - SOCKS4 proxy with remote DNS
1241- `socks5` - SOCKS5 proxy with local DNS
1242- `socks5h` - SOCKS5 proxy with remote DNS
1243
1244`http` will be used when no scheme is specified.
1245
1246By 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`.
1247
1248For example, to set an `http` proxy, add the following to your settings:
1249
1250```json
1251{
1252 "proxy": "http://127.0.0.1:10809"
1253}
1254```
1255
1256Or to set a `socks5` proxy:
1257
1258```json
1259{
1260 "proxy": "socks5h://localhost:10808"
1261}
1262```
1263
1264## Preview tabs
1265
1266- Description:
1267 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. \
1268 There are several ways to convert a preview tab into a regular tab:
1269
1270 - Double-clicking on the file
1271 - Double-clicking on the tab header
1272 - Using the `project_panel::OpenPermanent` action
1273 - Editing the file
1274 - Dragging the file to a different pane
1275
1276- Setting: `preview_tabs`
1277- Default:
1278
1279```json
1280"preview_tabs": {
1281 "enabled": true,
1282 "enable_preview_from_file_finder": false,
1283 "enable_preview_from_code_navigation": false,
1284}
1285```
1286
1287### Enable preview from file finder
1288
1289- Description: Determines whether to open files in preview mode when selected from the file finder.
1290- Setting: `enable_preview_from_file_finder`
1291- Default: `false`
1292
1293**Options**
1294
1295`boolean` values
1296
1297### Enable preview from code navigation
1298
1299- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
1300- Setting: `enable_preview_from_code_navigation`
1301- Default: `false`
1302
1303**Options**
1304
1305`boolean` values
1306
1307## Preferred Line Length
1308
1309- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
1310- Setting: `preferred_line_length`
1311- Default: `80`
1312
1313**Options**
1314
1315`integer` values
1316
1317## Projects Online By Default
1318
1319- Description: Whether or not to show the online projects view by default.
1320- Setting: `projects_online_by_default`
1321- Default: `true`
1322
1323**Options**
1324
1325`boolean` values
1326
1327## Remove Trailing Whitespace On Save
1328
1329- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
1330- Setting: `remove_trailing_whitespace_on_save`
1331- Default: `true`
1332
1333**Options**
1334
1335`boolean` values
1336
1337## Search
1338
1339- Description: Search options to enable by default when opening new project and buffer searches.
1340- Setting: `search`
1341- Default:
1342
1343```json
1344"search": {
1345 "whole_word": false,
1346 "case_sensitive": false,
1347 "include_ignored": false,
1348 "regex": false
1349},
1350```
1351
1352## Show Call Status Icon
1353
1354- Description: Whether or not to show the call status icon in the status bar.
1355- Setting: `show_call_status_icon`
1356- Default: `true`
1357
1358**Options**
1359
1360`boolean` values
1361
1362## Show Completions On Input
1363
1364- Description: Whether or not to show completions as you type.
1365- Setting: `show_completions_on_input`
1366- Default: `true`
1367
1368**Options**
1369
1370`boolean` values
1371
1372## Show Completion Documentation
1373
1374- Description: Whether to display inline and alongside documentation for items in the completions menu.
1375- Setting: `show_completion_documentation`
1376- Default: `true`
1377
1378**Options**
1379
1380`boolean` values
1381
1382## Completion Documentation Debounce Delay
1383
1384- Description: The debounce delay before re-querying the language server for completion documentation when not included in original completion list.
1385- Setting: `completion_documentation_secondary_query_debounce`
1386- Default: `300` ms
1387
1388**Options**
1389
1390`integer` values
1391
1392## Show Inline Completions
1393
1394- Description: Whether to show inline completions as you type or manually by triggering `editor::ShowInlineCompletion`.
1395- Setting: `show_inline_completions`
1396- Default: `true`
1397
1398**Options**
1399
1400`boolean` values
1401
1402## Show Whitespaces
1403
1404- Description: Whether or not to show render whitespace characters in the editor.
1405- Setting: `show_whitespaces`
1406- Default: `selection`
1407
1408**Options**
1409
14101. `all`
14112. `selection`
14123. `none`
14134. `boundary`
1414
1415## Soft Wrap
1416
1417- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
1418- Setting: `soft_wrap`
1419- Default: `none`
1420
1421**Options**
1422
14231. `none` to avoid wrapping generally, unless the line is too long
14242. `prefer_line` (deprecated, same as `none`)
14253. `editor_width` to wrap lines that overflow the editor width
14264. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
1427
1428## Wrap Guides (Vertical Rulers)
1429
1430- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
1431- Setting: `wrap_guides`
1432- Default: []
1433
1434**Options**
1435
1436List of `integer` column numbers
1437
1438## Tab Size
1439
1440- Description: The number of spaces to use for each tab character.
1441- Setting: `tab_size`
1442- Default: `4`
1443
1444**Options**
1445
1446`integer` values
1447
1448## Telemetry
1449
1450- Description: Control what info is collected by Zed.
1451- Setting: `telemetry`
1452- Default:
1453
1454```json
1455"telemetry": {
1456 "diagnostics": true,
1457 "metrics": true
1458},
1459```
1460
1461**Options**
1462
1463### Diagnostics
1464
1465- Description: Setting for sending debug-related data, such as crash reports.
1466- Setting: `diagnostics`
1467- Default: `true`
1468
1469**Options**
1470
1471`boolean` values
1472
1473### Metrics
1474
1475- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
1476- Setting: `metrics`
1477- Default: `true`
1478
1479**Options**
1480
1481`boolean` values
1482
1483## Terminal
1484
1485- Description: Configuration for the terminal.
1486- Setting: `terminal`
1487- Default:
1488
1489```json
1490{
1491 "terminal": {
1492 "alternate_scroll": "off",
1493 "blinking": "terminal_controlled",
1494 "copy_on_select": false,
1495 "dock": "bottom",
1496 "detect_venv": {
1497 "on": {
1498 "directories": [".env", "env", ".venv", "venv"],
1499 "activate_script": "default"
1500 }
1501 }
1502 "env": {},
1503 "font_family": null,
1504 "font_features": null,
1505 "font_size": null,
1506 "line_height": "comfortable",
1507 "option_as_meta": true,
1508 "button": false,
1509 "shell": {},
1510 "toolbar": {
1511 "title": true
1512 },
1513 "working_directory": "current_project_directory"
1514 }
1515}
1516```
1517
1518### Terminal: Dock
1519
1520- Description: Control the position of the dock
1521- Setting: `dock`
1522- Default: `bottom`
1523
1524**Options**
1525
1526`"bottom"`, `"left"` or `"right"`
1527
1528### Terminal: Alternate Scroll
1529
1530- 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.
1531- Setting: `alternate_scroll`
1532- Default: `off`
1533
1534**Options**
1535
15361. Default alternate scroll mode to on
1537
1538```json
1539{
1540 "terminal": {
1541 "alternate_scroll": "on"
1542 }
1543}
1544```
1545
15462. Default alternate scroll mode to off
1547
1548```json
1549{
1550 "terminal": {
1551 "alternate_scroll": "off"
1552 }
1553}
1554```
1555
1556### Terminal: Blinking
1557
1558- Description: Set the cursor blinking behavior in the terminal
1559- Setting: `blinking`
1560- Default: `terminal_controlled`
1561
1562**Options**
1563
15641. Never blink the cursor, ignore the terminal mode
1565
1566```json
1567{
1568 "terminal": {
1569 "blinking": "off"
1570 }
1571}
1572```
1573
15742. Default the cursor blink to off, but allow the terminal to turn blinking on
1575
1576```json
1577{
1578 "terminal": {
1579 "blinking": "terminal_controlled"
1580 }
1581}
1582```
1583
15843. Always blink the cursor, ignore the terminal mode
1585
1586```json
1587{
1588 "terminal": {
1589 "blinking": "on"
1590 }
1591}
1592```
1593
1594### Terminal: Copy On Select
1595
1596- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
1597- Setting: `copy_on_select`
1598- Default: `false`
1599
1600**Options**
1601
1602`boolean` values
1603
1604**Example**
1605
1606```json
1607{
1608 "terminal": {
1609 "copy_on_select": true
1610 }
1611}
1612```
1613
1614### Terminal: Env
1615
1616- 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
1617- Setting: `env`
1618- Default: `{}`
1619
1620**Example**
1621
1622```json
1623{
1624 "terminal": {
1625 "env": {
1626 "ZED": "1",
1627 "KEY": "value1:value2"
1628 }
1629 }
1630}
1631```
1632
1633### Terminal: Font Size
1634
1635- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
1636- Setting: `font_size`
1637- Default: `null`
1638
1639**Options**
1640
1641`integer` values
1642
1643```json
1644{
1645 "terminal": {
1646 "font_size": 15
1647 }
1648}
1649```
1650
1651### Terminal: Font Family
1652
1653- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
1654- Setting: `font_family`
1655- Default: `null`
1656
1657**Options**
1658
1659The name of any font family installed on the user's system
1660
1661```json
1662{
1663 "terminal": {
1664 "font_family": "Berkeley Mono"
1665 }
1666}
1667```
1668
1669### Terminal: Font Features
1670
1671- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
1672- Setting: `font_features`
1673- Default: `null`
1674- Platform: macOS and Windows.
1675
1676**Options**
1677
1678See Buffer Font Features
1679
1680```json
1681{
1682 "terminal": {
1683 "font_features": {
1684 "calt": false
1685 // See Buffer Font Features for more features
1686 }
1687 }
1688}
1689```
1690
1691### Terminal: Line Height
1692
1693- Description: Set the terminal's line height.
1694- Setting: `line_height`
1695- Default: `comfortable`
1696
1697**Options**
1698
16991. Use a line height that's `comfortable` for reading, 1.618. (default)
1700
1701```json
1702{
1703 "terminal": {
1704 "line_height": "comfortable"
1705 }
1706}
1707```
1708
17092. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
1710
1711```json
1712{
1713 "terminal": {
1714 "line_height": "standard"
1715 }
1716}
1717```
1718
17193. Use a custom line height.
1720
1721```json
1722{
1723 "terminal": {
1724 "line_height": {
1725 "custom": 2
1726 }
1727 }
1728}
1729```
1730
1731### Terminal: Option As Meta
1732
1733- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
1734- Setting: `option_as_meta`
1735- Default: `true`
1736
1737**Options**
1738
1739`boolean` values
1740
1741```json
1742{
1743 "terminal": {
1744 "option_as_meta": true
1745 }
1746}
1747```
1748
1749### Terminal: Shell
1750
1751- Description: What shell to use when launching the terminal.
1752- Setting: `shell`
1753- Default: `system`
1754
1755**Options**
1756
17571. Use the system's default terminal configuration (usually the `/etc/passwd` file).
1758
1759```json
1760{
1761 "terminal": {
1762 "shell": "system"
1763 }
1764}
1765```
1766
17672. A program to launch:
1768
1769```json
1770{
1771 "terminal": {
1772 "shell": {
1773 "program": "sh"
1774 }
1775 }
1776}
1777```
1778
17793. A program with arguments:
1780
1781```json
1782{
1783 "terminal": {
1784 "shell": {
1785 "with_arguments": {
1786 "program": "/bin/bash",
1787 "args": ["--login"]
1788 }
1789 }
1790 }
1791}
1792```
1793
1794## Terminal: Detect Virtual Environments {#terminal-detect_venv}
1795
1796- 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.
1797- Setting: `detect_venv`
1798- Default:
1799
1800```json
1801{
1802 "terminal": {
1803 "detect_venv": {
1804 "on": {
1805 // Default directories to search for virtual environments, relative
1806 // to the current working directory. We recommend overriding this
1807 // in your project's settings, rather than globally.
1808 "directories": [".venv", "venv"],
1809 // Can also be `csh`, `fish`, and `nushell`
1810 "activate_script": "default"
1811 }
1812 }
1813 }
1814}
1815```
1816
1817Disable with:
1818
1819```json
1820{
1821 "terminal": {
1822 "detect_venv": "off"
1823 }
1824}
1825```
1826
1827## Terminal: Toolbar
1828
1829- Description: Whether or not to show various elements in the terminal toolbar. It only affects terminals placed in the editor pane.
1830- Setting: `toolbar`
1831- Default:
1832
1833```json
1834{
1835 "terminal": {
1836 "toolbar": {
1837 "title": true
1838 }
1839 }
1840}
1841```
1842
1843**Options**
1844
1845At the moment, only the `title` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`. If the title is hidden, the terminal toolbar is not displayed.
1846
1847### Terminal: Button
1848
1849- Description: Control to show or hide the terminal button in the status bar
1850- Setting: `button`
1851- Default: `true`
1852
1853**Options**
1854
1855`boolean` values
1856
1857```json
1858{
1859 "terminal": {
1860 "button": false
1861 }
1862}
1863```
1864
1865### Terminal: Working Directory
1866
1867- Description: What working directory to use when launching the terminal.
1868- Setting: `working_directory`
1869- Default: `"current_project_directory"`
1870
1871**Options**
1872
18731. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
1874
1875```json
1876{
1877 "terminal": {
1878 "working_directory": "current_project_directory"
1879 }
1880}
1881```
1882
18832. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
1884
1885```json
1886{
1887 "terminal": {
1888 "working_directory": "first_project_directory"
1889 }
1890}
1891```
1892
18933. Always use this platform's home directory (if we can find it)
1894
1895```json
1896{
1897 "terminal": {
1898 "working_directory": "always_home"
1899 }
1900}
1901```
1902
19034. 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.
1904
1905```json
1906{
1907 "terminal": {
1908 "working_directory": {
1909 "always": {
1910 "directory": "~/zed/projects/"
1911 }
1912 }
1913 }
1914}
1915```
1916
1917## Theme
1918
1919- 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.
1920- Setting: `theme`
1921- Default: `One Dark`
1922
1923### Theme Object
1924
1925- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
1926- Setting: `theme`
1927- Default:
1928
1929```json
1930"theme": {
1931 "mode": "system",
1932 "dark": "One Dark",
1933 "light": "One Light"
1934},
1935```
1936
1937### Mode
1938
1939- Description: Specify theme mode.
1940- Setting: `mode`
1941- Default: `system`
1942
1943**Options**
1944
19451. Set the theme to dark mode
1946
1947```json
1948{
1949 "mode": "dark"
1950}
1951```
1952
19532. Set the theme to light mode
1954
1955```json
1956{
1957 "mode": "light"
1958}
1959```
1960
19613. Set the theme to system mode
1962
1963```json
1964{
1965 "mode": "system"
1966}
1967```
1968
1969### Dark
1970
1971- Description: The name of the dark Zed theme to use for the UI.
1972- Setting: `dark`
1973- Default: `One Dark`
1974
1975**Options**
1976
1977Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
1978
1979### Light
1980
1981- Description: The name of the light Zed theme to use for the UI.
1982- Setting: `light`
1983- Default: `One Light`
1984
1985**Options**
1986
1987Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
1988
1989## Vim
1990
1991- Description: Whether or not to enable vim mode (work in progress).
1992- Setting: `vim_mode`
1993- Default: `false`
1994
1995## Project Panel
1996
1997- Description: Customize project panel
1998- Setting: `project_panel`
1999- Default:
2000
2001```json
2002{
2003 "project_panel": {
2004 "button": true,
2005 "default_width": 240,
2006 "dock": "left",
2007 "file_icons": true,
2008 "folder_icons": true,
2009 "git_status": true,
2010 "indent_size": 20,
2011 "auto_reveal_entries": true,
2012 "auto_fold_dirs": true,
2013 "scrollbar": {
2014 "show": null
2015 }
2016 }
2017}
2018```
2019
2020### Dock
2021
2022- Description: Control the position of the dock
2023- Setting: `dock`
2024- Default: `left`
2025
2026**Options**
2027
20281. Default dock position to left
2029
2030```json
2031{
2032 "dock": "left"
2033}
2034```
2035
20362. Default dock position to right
2037
2038```json
2039{
2040 "dock": "right"
2041}
2042```
2043
2044### Git Status
2045
2046- Description: Indicates newly created and updated files
2047- Setting: `git_status`
2048- Default: `true`
2049
2050**Options**
2051
20521. Default enable git status
2053
2054```json
2055{
2056 "git_status": true
2057}
2058```
2059
20602. Default disable git status
2061
2062```json
2063{
2064 "git_status": false
2065}
2066```
2067
2068### Default Width
2069
2070- Description: Customize default width taken by project panel
2071- Setting: `default_width`
2072- Default: N/A width in pixels (eg: 420)
2073
2074**Options**
2075
2076`boolean` values
2077
2078### Auto Reveal Entries
2079
2080- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
2081- Setting: `auto_reveal_entries`
2082- Default: `true`
2083
2084**Options**
2085
20861. Enable auto reveal entries
2087
2088```json
2089{
2090 "auto_reveal_entries": true
2091}
2092```
2093
20942. Disable auto reveal entries
2095
2096```json
2097{
2098 "auto_reveal_entries": false
2099}
2100```
2101
2102### Auto Fold Dirs
2103
2104- Description: Whether to fold directories automatically when directory has only one directory inside.
2105- Setting: `auto_fold_dirs`
2106- Default: `true`
2107
2108**Options**
2109
21101. Enable auto fold dirs
2111
2112```json
2113{
2114 "auto_fold_dirs": true
2115}
2116```
2117
21182. Disable auto fold dirs
2119
2120```json
2121{
2122 "auto_fold_dirs": false
2123}
2124```
2125
2126### Indent Size
2127
2128- Description: Amount of indentation (in pixels) for nested items.
2129- Setting: `indent_size`
2130- Default: `20`
2131
2132### Scrollbar
2133
2134- Description: Scrollbar related settings. Possible values: null, "auto", "system", "always", "never". Inherits editor settings when absent, see its description for more details.
2135- Setting: `scrollbar`
2136- Default:
2137
2138```json
2139"scrollbar": {
2140 "show": null
2141}
2142```
2143
2144**Options**
2145
21461. Show scrollbar in project panel
2147
2148```json
2149{
2150 "scrollbar": {
2151 "show": "always"
2152 }
2153}
2154```
2155
21562. Hide scrollbar in project panel
2157
2158```json
2159{
2160 "scrollbar": {
2161 "show": "never"
2162 }
2163}
2164```
2165
2166## Assistant Panel
2167
2168- Description: Customize assistant panel
2169- Setting: `assistant`
2170- Default:
2171
2172```json
2173"assistant": {
2174 "enabled": true,
2175 "button": true,
2176 "dock": "right",
2177 "default_width": 640,
2178 "default_height": 320,
2179 "provider": "openai",
2180 "version": "1",
2181},
2182```
2183
2184## Outline Panel
2185
2186- Description: Customize outline Panel
2187- Setting: `outline_panel`
2188- Default:
2189
2190```json
2191"outline_panel": {
2192 "button": true,
2193 "default_width": 240,
2194 "dock": "left",
2195 "file_icons": true,
2196 "folder_icons": true,
2197 "git_status": true,
2198 "indent_size": 20,
2199 "auto_reveal_entries": true,
2200 "auto_fold_dirs": true,
2201}
2202```
2203
2204## Calls
2205
2206- Description: Customize behavior when participating in a call
2207- Setting: `calls`
2208- Default:
2209
2210```json
2211"calls": {
2212 // Join calls with the microphone live by default
2213 "mute_on_join": false,
2214 // Share your project when you are the first to join a channel
2215 "share_on_join": false
2216},
2217```
2218
2219## Unnecessary Code Fade
2220
2221- Description: How much to fade out unused code.
2222- Setting: `unnecessary_code_fade`
2223- Default: `0.3`
2224
2225**Options**
2226
2227Float values between `0.0` and `0.9`, where:
2228
2229- `0.0` means no fading (unused code looks the same as used code)
2230- `0.9` means maximum fading (unused code is very faint but still visible)
2231
2232**Example**
2233
2234```json
2235{
2236 "unnecessary_code_fade": 0.5
2237}
2238```
2239
2240## UI Font Family
2241
2242- Description: The name of the font to use for text in the UI.
2243- Setting: `ui_font_family`
2244- Default: `Zed Plex Sans`
2245
2246**Options**
2247
2248The name of any font family installed on the system.
2249
2250## UI Font Features
2251
2252- Description: The OpenType features to enable for text in the UI.
2253- Setting: `ui_font_features`
2254- Default: `null`
2255- Platform: macOS and Windows.
2256
2257**Options**
2258
2259Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
2260
2261For example, to disable font ligatures, add the following to your settings:
2262
2263```json
2264{
2265 "ui_font_features": {
2266 "calt": false
2267 }
2268}
2269```
2270
2271You can also set other OpenType features, like setting `cv01` to `7`:
2272
2273```json
2274{
2275 "ui_font_features": {
2276 "cv01": 7
2277 }
2278}
2279```
2280
2281## UI Font Fallbacks
2282
2283- Description: The font fallbacks to use for text in the UI.
2284- Setting: `ui_font_fallbacks`
2285- Default: `null`
2286- Platform: macOS and Windows.
2287
2288**Options**
2289
2290For example, to use `Nerd Font` as a fallback, add the following to your settings:
2291
2292```json
2293{
2294 "ui_font_fallbacks": ["Nerd Font"]
2295}
2296```
2297
2298## UI Font Size
2299
2300- Description: The default font size for text in the UI.
2301- Setting: `ui_font_size`
2302- Default: `16`
2303
2304**Options**
2305
2306`integer` values from `6` to `100` pixels (inclusive)
2307
2308## UI Font Weight
2309
2310- Description: The default font weight for text in the UI.
2311- Setting: `ui_font_weight`
2312- Default: `400`
2313
2314**Options**
2315
2316`integer` values between `100` and `900`
2317
2318## An example configuration:
2319
2320```json
2321// ~/.config/zed/settings.json
2322{
2323 "theme": "cave-light",
2324 "tab_size": 2,
2325 "preferred_line_length": 80,
2326 "soft_wrap": "none",
2327
2328 "buffer_font_size": 18,
2329 "buffer_font_family": "Zed Plex Mono",
2330
2331 "autosave": "on_focus_change",
2332 "format_on_save": "off",
2333 "vim_mode": false,
2334 "projects_online_by_default": true,
2335 "terminal": {
2336 "font_family": "FiraCode Nerd Font Mono",
2337 "blinking": "off"
2338 },
2339 "languages": {
2340 "C": {
2341 "format_on_save": "language_server",
2342 "preferred_line_length": 64,
2343 "soft_wrap": "preferred_line_length"
2344 }
2345 }
2346}
2347```