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