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