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 Editor
8
9You can browse through many of the supported settings via the Settings Editor, which can be opened with the {#kb zed::OpenSettings} keybinding, or through the `zed: open settings` action in the command palette. Through it, you can customize your local, user settings as well as project settings.
10
11> Note that not all settings that Zed supports are available through the Settings Editor yet.
12> Some more intricate ones, such as language formatters, can only be changed through the JSON settings file {#kb zed::OpenSettingsFile}.
13
14## User Settings File
15
16<!--
17TBD: Settings files. Rewrite with "remote settings" in mind (e.g. `local settings` on the remote host).
18Consider renaming `zed: Open Local Settings` to `zed: Open Project Settings`.
19
20TBD: 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.
21-->
22
23Your settings JSON file can be opened with {#kb zed::OpenSettingsFile}.
24By 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.
25
26Whatever you have added to your user settings file gets merged with any local configuration inside your projects.
27
28### Default Settings
29
30In the Settings Editor, the values you see set are the default ones.
31You can also verify them in JSON by running {#action zed::OpenDefaultSettings} from the command palette.
32
33Extensions that provide language servers may also provide default settings for those language servers.
34
35## Project Settings File
36
37Similarly to user files, you can open your project settings file by running {#action zed::OpenProjectSettings} from the command palette.
38This will create a `.zed` directory containing`.zed/settings.json`.
39
40Although most projects will only need one settings file at the root, you can add more local settings files for subdirectories as needed.
41Not all settings can be set in local files, just those that impact the behavior of the editor and language tooling.
42For example you can set `tab_size`, `formatter` etc. but not `theme`, `vim_mode` and similar.
43
44The syntax for configuration files is a super-set of JSON that allows `//` comments.
45
46## Per-release Channel Overrides
47
48Zed reads the same `settings.json` across all release channels (Stable, Preview or Nightly).
49However, you can scope overrides to a specific channel by adding top-level `stable`, `preview`, `nightly` or `dev` objects.
50They are merged into the base configuration with settings from these keys taking precedence upon launching the specified build. For example:
51
52```json [settings]
53{
54 "theme": "sunset",
55 "vim_mode": false,
56 "nightly": {
57 "theme": "cave-light",
58 "vim_mode": true
59 },
60 "preview": {
61 "theme": "zed-dark"
62 }
63}
64```
65
66With this configuration, Stable keeps all base preferences, Preview switches to `zed-dark`, and Nightly enables Vim mode with a different theme.
67
68Changing settings in the Settings Editorwill always apply the change across all channels.
69
70# Settings
71
72Find below an extensive run-through of many supported settings by Zed.
73
74## Active Pane Modifiers
75
76- Description: Styling settings applied to the active pane.
77- Setting: `active_pane_modifiers`
78- Default:
79
80```json [settings]
81{
82 "active_pane_modifiers": {
83 "border_size": 0.0,
84 "inactive_opacity": 1.0
85 }
86}
87```
88
89### Border size
90
91- 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.
92- Setting: `border_size`
93- Default: `0.0`
94
95**Options**
96
97Non-negative `float` values
98
99### Inactive Opacity
100
101- 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.
102- Setting: `inactive_opacity`
103- Default: `1.0`
104
105**Options**
106
107`float` values
108
109## Bottom Dock Layout
110
111- Description: Control the layout of the bottom dock, relative to the left and right docks.
112- Setting: `bottom_dock_layout`
113- Default: `"contained"`
114
115**Options**
116
1171. Contain the bottom dock, giving the full height of the window to the left and right docks.
118
119```json [settings]
120{
121 "bottom_dock_layout": "contained"
122}
123```
124
1252. Give the bottom dock the full width of the window, truncating the left and right docks.
126
127```json [settings]
128{
129 "bottom_dock_layout": "full"
130}
131```
132
1333. Left align the bottom dock, truncating the left dock and giving the right dock the full height of the window.
134
135```json [settings]
136{
137 "bottom_dock_layout": "left_aligned"
138}
139```
140
1414. Right align the bottom dock, giving the left dock the full height of the window and truncating the right dock.
142
143```json [settings]
144{
145 "bottom_dock_layout": "right_aligned"
146}
147```
148
149## Agent Font Size
150
151- Description: The font size for text in the agent panel. Inherits the UI font size if unset.
152- Setting: `agent_font_size`
153- Default: `null`
154
155**Options**
156
157`integer` values from `6` to `100` pixels (inclusive)
158
159## Allow Rewrap
160
161- Description: Controls where the {#action editor::Rewrap} action is allowed in the current language scope
162- Setting: `allow_rewrap`
163- Default: `"in_comments"`
164
165**Options**
166
1671. Allow rewrap in comments only:
168
169```json [settings]
170{
171 "allow_rewrap": "in_comments"
172}
173```
174
1752. Allow rewrap in selections only:
176
177```json [settings]
178{
179 "allow_rewrap": "in_selections"
180}
181```
182
1833. Allow rewrap anywhere:
184
185```json [settings]
186{
187 "allow_rewrap": "anywhere"
188}
189```
190
191Note: This setting has no effect in Vim mode, as rewrap is already allowed everywhere.
192
193## Auto Indent
194
195- Description: Whether indentation should be adjusted based on the context whilst typing. This can be specified on a per-language basis.
196- Setting: `auto_indent`
197- Default: `true`
198
199**Options**
200
201`boolean` values
202
203## Auto Indent On Paste
204
205- Description: Whether indentation of pasted content should be adjusted based on the context
206- Setting: `auto_indent_on_paste`
207- Default: `true`
208
209**Options**
210
211`boolean` values
212
213## Auto Install extensions
214
215- Description: Define extensions to be autoinstalled or never be installed.
216- Setting: `auto_install_extensions`
217- Default: `{ "html": true }`
218
219**Options**
220
221You can find the names of your currently installed extensions by listing the subfolders under the [extension installation location](./extensions/installing-extensions.md#installation-location):
222
223On macOS:
224
225```sh
226ls ~/Library/Application\ Support/Zed/extensions/installed/
227```
228
229On Linux:
230
231```sh
232ls ~/.local/share/zed/extensions/installed
233```
234
235Define extensions which should be installed (`true`) or never installed (`false`).
236
237```json [settings]
238{
239 "auto_install_extensions": {
240 "html": true,
241 "dockerfile": true,
242 "docker-compose": false
243 }
244}
245```
246
247## Autosave
248
249- Description: When to automatically save edited buffers.
250- Setting: `autosave`
251- Default: `off`
252
253**Options**
254
2551. To disable autosave, set it to `off`:
256
257```json [settings]
258{
259 "autosave": "off"
260}
261```
262
2632. To autosave when focus changes, use `on_focus_change`:
264
265```json [settings]
266{
267 "autosave": "on_focus_change"
268}
269```
270
2713. To autosave when the active window changes, use `on_window_change`:
272
273```json [settings]
274{
275 "autosave": "on_window_change"
276}
277```
278
2794. To autosave after an inactivity period, use `after_delay`:
280
281```json [settings]
282{
283 "autosave": {
284 "after_delay": {
285 "milliseconds": 1000
286 }
287 }
288}
289```
290
291Note that a save will be triggered when an unsaved tab is closed, even if this is earlier than the configured inactivity period.
292
293## Autoscroll on Clicks
294
295- Description: Whether to scroll when clicking near the edge of the visible text area.
296- Setting: `autoscroll_on_clicks`
297- Default: `false`
298
299**Options**
300
301`boolean` values
302
303## Auto Signature Help
304
305- Description: Show method signatures in the editor, when inside parentheses
306- Setting: `auto_signature_help`
307- Default: `false`
308
309**Options**
310
311`boolean` values
312
313### Show Signature Help After Edits
314
315- Description: Whether to show the signature help after completion or a bracket pair inserted. If `auto_signature_help` is enabled, this setting will be treated as enabled also.
316- Setting: `show_signature_help_after_edits`
317- Default: `false`
318
319**Options**
320
321`boolean` values
322
323## Auto Update
324
325- Description: Whether or not to automatically check for updates.
326- Setting: `auto_update`
327- Default: `true`
328
329**Options**
330
331`boolean` values
332
333## Base Keymap
334
335- Description: Base key bindings scheme. Base keymaps can be overridden with user keymaps.
336- Setting: `base_keymap`
337- Default: `VSCode`
338
339**Options**
340
3411. VS Code
342
343```json [settings]
344{
345 "base_keymap": "VSCode"
346}
347```
348
3492. Atom
350
351```json [settings]
352{
353 "base_keymap": "Atom"
354}
355```
356
3573. JetBrains
358
359```json [settings]
360{
361 "base_keymap": "JetBrains"
362}
363```
364
3654. None
366
367```json [settings]
368{
369 "base_keymap": "None"
370}
371```
372
3735. Sublime Text
374
375```json [settings]
376{
377 "base_keymap": "SublimeText"
378}
379```
380
3816. TextMate
382
383```json [settings]
384{
385 "base_keymap": "TextMate"
386}
387```
388
389## Buffer Font Family
390
391- Description: The name of a font to use for rendering text in the editor.
392- Setting: `buffer_font_family`
393- Default: `.ZedMono`. This currently aliases to [Lilex](https://lilex.myrt.co).
394
395**Options**
396
397The name of any font family installed on the user's system, or `".ZedMono"`.
398
399## Buffer Font Features
400
401- Description: The OpenType features to enable for text in the editor.
402- Setting: `buffer_font_features`
403- Default: `null`
404- Platform: macOS and Windows.
405
406**Options**
407
408Zed 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.
409
410For example, to disable font ligatures, add the following to your settings:
411
412```json [settings]
413{
414 "buffer_font_features": {
415 "calt": false
416 }
417}
418```
419
420You can also set other OpenType features, like setting `cv01` to `7`:
421
422```json [settings]
423{
424 "buffer_font_features": {
425 "cv01": 7
426 }
427}
428```
429
430## Buffer Font Fallbacks
431
432- Description: Set the buffer text's font fallbacks, this will be merged with the platform's default fallbacks.
433- Setting: `buffer_font_fallbacks`
434- Default: `null`
435- Platform: macOS and Windows.
436
437**Options**
438
439For example, to use `Nerd Font` as a fallback, add the following to your settings:
440
441```json [settings]
442{
443 "buffer_font_fallbacks": ["Nerd Font"]
444}
445```
446
447## Buffer Font Size
448
449- Description: The default font size for text in the editor.
450- Setting: `buffer_font_size`
451- Default: `15`
452
453**Options**
454
455A font size from `6` to `100` pixels (inclusive)
456
457## Buffer Font Weight
458
459- Description: The default font weight for text in the editor.
460- Setting: `buffer_font_weight`
461- Default: `400`
462
463**Options**
464
465`integer` values between `100` and `900`
466
467## Buffer Line Height
468
469- Description: The default line height for text in the editor.
470- Setting: `buffer_line_height`
471- Default: `"comfortable"`
472
473**Options**
474
475`"standard"`, `"comfortable"` or `{ "custom": float }` (`1` is compact, `2` is loose)
476
477## Centered Layout
478
479- Description: Configuration for the centered layout mode.
480- Setting: `centered_layout`
481- Default:
482
483```json [settings]
484"centered_layout": {
485 "left_padding": 0.2,
486 "right_padding": 0.2,
487}
488```
489
490**Options**
491
492The `left_padding` and `right_padding` options define the relative width of the
493left 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`.
494
495## Close on File Delete
496
497- Description: Whether to automatically close editor tabs when their corresponding files are deleted from disk.
498- Setting: `close_on_file_delete`
499- Default: `false`
500
501**Options**
502
503`boolean` values
504
505When enabled, this setting will automatically close tabs for files that have been deleted from the file system. This is particularly useful for workflows involving temporary or scratch files that are frequently created and deleted. When disabled (default), deleted files remain open with a strikethrough through their tab title.
506
507Note: Dirty files (files with unsaved changes) will not be automatically closed even when this setting is enabled, ensuring you don't lose unsaved work.
508
509## Confirm Quit
510
511- Description: Whether or not to prompt the user to confirm before closing the application.
512- Setting: `confirm_quit`
513- Default: `false`
514
515**Options**
516
517`boolean` values
518
519## Diagnostics Max Severity
520
521- Description: Which level to use to filter out diagnostics displayed in the editor
522- Setting: `diagnostics_max_severity`
523- Default: `null`
524
525**Options**
526
5271. Allow all diagnostics (default):
528
529```json [settings]
530{
531 "diagnostics_max_severity": "all"
532}
533```
534
5352. Show only errors:
536
537```json [settings]
538{
539 "diagnostics_max_severity": "error"
540}
541```
542
5433. Show errors and warnings:
544
545```json [settings]
546{
547 "diagnostics_max_severity": "warning"
548}
549```
550
5514. Show errors, warnings, and information:
552
553```json [settings]
554{
555 "diagnostics_max_severity": "info"
556}
557```
558
5595. Show all including hints:
560
561```json [settings]
562{
563 "diagnostics_max_severity": "hint"
564}
565```
566
567## Disable AI
568
569- Description: Whether to disable all AI features in Zed
570- Setting: `disable_ai`
571- Default: `false`
572
573**Options**
574
575`boolean` values
576
577## Direnv Integration
578
579- Description: Settings for [direnv](https://direnv.net/) integration. Requires `direnv` to be installed.
580 `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.
581 It also allows for those environment variables to be used in tasks.
582- Setting: `load_direnv`
583- Default: `"direct"`
584
585**Options**
586
587There are three options to choose from:
588
5891. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
5902. `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.
5913. `disabled`: No shell environment will be loaded automatically; direnv must be invoked manually (e.g. with `direnv exec`) to be used.
592
593## Double Click In Multibuffer
594
595- Description: What to do when multibuffer is double clicked in some of its excerpts (parts of singleton buffers)
596- Setting: `double_click_in_multibuffer`
597- Default: `"select"`
598
599**Options**
600
6011. Behave as a regular buffer and select the whole word (default):
602
603```json [settings]
604{
605 "double_click_in_multibuffer": "select"
606}
607```
608
6092. Open the excerpt clicked as a new buffer in the new tab:
610
611```json [settings]
612{
613 "double_click_in_multibuffer": "open"
614}
615```
616
617For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
618
619## Drop Target Size
620
621- Description: Relative size of the drop target in the editor that will open dropped file as a split pane (0-0.5). For example, 0.25 means if you drop onto the top/bottom quarter of the pane a new vertical split will be used, if you drop onto the left/right quarter of the pane a new horizontal split will be used.
622- Setting: `drop_target_size`
623- Default: `0.2`
624
625**Options**
626
627`float` values between `0` and `0.5`
628
629## Edit Predictions
630
631- Description: Settings for edit predictions.
632- Setting: `edit_predictions`
633- Default:
634
635```json [settings]
636 "edit_predictions": {
637 "disabled_globs": [
638 "**/.env*",
639 "**/*.pem",
640 "**/*.key",
641 "**/*.cert",
642 "**/*.crt",
643 "**/.dev.vars",
644 "**/secrets.yml"
645 ]
646 }
647```
648
649**Options**
650
651### Disabled Globs
652
653- Description: A list of globs for which edit predictions should be disabled for. This list adds to a pre-existing, sensible default set of globs. Any additional ones you add are combined with them.
654- Setting: `disabled_globs`
655- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/.dev.vars", "**/secrets.yml"]`
656
657**Options**
658
659List of `string` values.
660
661## Edit Predictions Disabled in
662
663- Description: A list of language scopes in which edit predictions should be disabled.
664- Setting: `edit_predictions_disabled_in`
665- Default: `[]`
666
667**Options**
668
669List of `string` values
670
6711. Don't show edit predictions in comments:
672
673```json [settings]
674"disabled_in": ["comment"]
675```
676
6772. Don't show edit predictions in strings and comments:
678
679```json [settings]
680"disabled_in": ["comment", "string"]
681```
682
6833. Only in Go, don't show edit predictions in strings and comments:
684
685```json [settings]
686{
687 "languages": {
688 "Go": {
689 "edit_predictions_disabled_in": ["comment", "string"]
690 }
691 }
692}
693```
694
695## Current Line Highlight
696
697- Description: How to highlight the current line in the editor.
698- Setting: `current_line_highlight`
699- Default: `all`
700
701**Options**
702
7031. Don't highlight the current line:
704
705```json [settings]
706"current_line_highlight": "none"
707```
708
7092. Highlight the gutter area:
710
711```json [settings]
712"current_line_highlight": "gutter"
713```
714
7153. Highlight the editor area:
716
717```json [settings]
718"current_line_highlight": "line"
719```
720
7214. Highlight the full line:
722
723```json [settings]
724"current_line_highlight": "all"
725```
726
727## Selection Highlight
728
729- Description: Whether to highlight all occurrences of the selected text in an editor.
730- Setting: `selection_highlight`
731- Default: `true`
732
733## Rounded Selection
734
735- Description: Whether the text selection should have rounded corners.
736- Setting: `rounded_selection`
737- Default: `true`
738
739## Cursor Blink
740
741- Description: Whether or not the cursor blinks.
742- Setting: `cursor_blink`
743- Default: `true`
744
745**Options**
746
747`boolean` values
748
749## Cursor Shape
750
751- Description: Cursor shape for the default editor.
752- Setting: `cursor_shape`
753- Default: `bar`
754
755**Options**
756
7571. A vertical bar:
758
759```json [settings]
760"cursor_shape": "bar"
761```
762
7632. A block that surrounds the following character:
764
765```json [settings]
766"cursor_shape": "block"
767```
768
7693. An underline / underscore that runs along the following character:
770
771```json [settings]
772"cursor_shape": "underline"
773```
774
7754. An box drawn around the following character:
776
777```json [settings]
778"cursor_shape": "hollow"
779```
780
781## Gutter
782
783- Description: Settings for the editor gutter
784- Setting: `gutter`
785- Default:
786
787```json [settings]
788{
789 "gutter": {
790 "line_numbers": true,
791 "runnables": true,
792 "breakpoints": true,
793 "folds": true,
794 "min_line_number_digits": 4
795 }
796}
797```
798
799**Options**
800
801- `line_numbers`: Whether to show line numbers in the gutter
802- `runnables`: Whether to show runnable buttons in the gutter
803- `breakpoints`: Whether to show breakpoints in the gutter
804- `folds`: Whether to show fold buttons in the gutter
805- `min_line_number_digits`: Minimum number of characters to reserve space for in the gutter
806
807## Hide Mouse
808
809- Description: Determines when the mouse cursor should be hidden in an editor or input box.
810- Setting: `hide_mouse`
811- Default: `on_typing_and_movement`
812
813**Options**
814
8151. Never hide the mouse cursor:
816
817```json [settings]
818"hide_mouse": "never"
819```
820
8212. Hide only when typing:
822
823```json [settings]
824"hide_mouse": "on_typing"
825```
826
8273. Hide on both typing and cursor movement:
828
829```json [settings]
830"hide_mouse": "on_typing_and_movement"
831```
832
833## Snippet Sort Order
834
835- Description: Determines how snippets are sorted relative to other completion items.
836- Setting: `snippet_sort_order`
837- Default: `inline`
838
839**Options**
840
8411. Place snippets at the top of the completion list:
842
843```json [settings]
844"snippet_sort_order": "top"
845```
846
8472. Place snippets normally without any preference:
848
849```json [settings]
850"snippet_sort_order": "inline"
851```
852
8533. Place snippets at the bottom of the completion list:
854
855```json [settings]
856"snippet_sort_order": "bottom"
857```
858
8594. Do not show snippets in the completion list at all:
860
861```json [settings]
862"snippet_sort_order": "none"
863```
864
865## Editor Scrollbar
866
867- Description: Whether or not to show the editor scrollbar and various elements in it.
868- Setting: `scrollbar`
869- Default:
870
871```json [settings]
872"scrollbar": {
873 "show": "auto",
874 "cursors": true,
875 "git_diff": true,
876 "search_results": true,
877 "selected_text": true,
878 "selected_symbol": true,
879 "diagnostics": "all",
880 "axes": {
881 "horizontal": true,
882 "vertical": true,
883 },
884},
885```
886
887### Show Mode
888
889- Description: When to show the editor scrollbar.
890- Setting: `show`
891- Default: `auto`
892
893**Options**
894
8951. Show the scrollbar if there's important information or follow the system's configured behavior:
896
897```json [settings]
898"scrollbar": {
899 "show": "auto"
900}
901```
902
9032. Match the system's configured behavior:
904
905```json [settings]
906"scrollbar": {
907 "show": "system"
908}
909```
910
9113. Always show the scrollbar:
912
913```json [settings]
914"scrollbar": {
915 "show": "always"
916}
917```
918
9194. Never show the scrollbar:
920
921```json [settings]
922"scrollbar": {
923 "show": "never"
924}
925```
926
927### Cursor Indicators
928
929- Description: Whether to show cursor positions in the scrollbar.
930- Setting: `cursors`
931- Default: `true`
932
933Cursor indicators appear as small marks on the scrollbar showing where other collaborators' cursors are positioned in the file.
934
935**Options**
936
937`boolean` values
938
939### Git Diff Indicators
940
941- Description: Whether to show git diff indicators in the scrollbar.
942- Setting: `git_diff`
943- Default: `true`
944
945Git diff indicators appear as colored marks showing lines that have been added, modified, or deleted compared to the git HEAD.
946
947**Options**
948
949`boolean` values
950
951### Search Results Indicators
952
953- Description: Whether to show buffer search results in the scrollbar.
954- Setting: `search_results`
955- Default: `true`
956
957Search result indicators appear as marks showing all locations in the file where your current search query matches.
958
959**Options**
960
961`boolean` values
962
963### Selected Text Indicators
964
965- Description: Whether to show selected text occurrences in the scrollbar.
966- Setting: `selected_text`
967- Default: `true`
968
969Selected text indicators appear as marks showing all occurrences of the currently selected text throughout the file.
970
971**Options**
972
973`boolean` values
974
975### Selected Symbols Indicators
976
977- Description: Whether to show selected symbol occurrences in the scrollbar.
978- Setting: `selected_symbol`
979- Default: `true`
980
981Selected symbol indicators appear as marks showing all occurrences of the currently selected symbol (like a function or variable name) throughout the file.
982
983**Options**
984
985`boolean` values
986
987### Diagnostics
988
989- Description: Which diagnostic indicators to show in the scrollbar.
990- Setting: `diagnostics`
991- Default: `all`
992
993Diagnostic indicators appear as colored marks showing errors, warnings, and other language server diagnostics at their corresponding line positions in the file.
994
995**Options**
996
9971. Show all diagnostics:
998
999```json [settings]
1000{
1001 "show_diagnostics": "all"
1002}
1003```
1004
10052. Do not show any diagnostics:
1006
1007```json [settings]
1008{
1009 "show_diagnostics": "off"
1010}
1011```
1012
10133. Show only errors:
1014
1015```json [settings]
1016{
1017 "show_diagnostics": "error"
1018}
1019```
1020
10214. Show only errors and warnings:
1022
1023```json [settings]
1024{
1025 "show_diagnostics": "warning"
1026}
1027```
1028
10295. Show only errors, warnings, and information:
1030
1031```json [settings]
1032{
1033 "show_diagnostics": "info"
1034}
1035```
1036
1037### Axes
1038
1039- Description: Forcefully enable or disable the scrollbar for each axis
1040- Setting: `axes`
1041- Default:
1042
1043```json [settings]
1044"scrollbar": {
1045 "axes": {
1046 "horizontal": true,
1047 "vertical": true,
1048 },
1049}
1050```
1051
1052#### Horizontal
1053
1054- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
1055- Setting: `horizontal`
1056- Default: `true`
1057
1058**Options**
1059
1060`boolean` values
1061
1062#### Vertical
1063
1064- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
1065- Setting: `vertical`
1066- Default: `true`
1067
1068**Options**
1069
1070`boolean` values
1071
1072## Minimap
1073
1074- Description: Settings related to the editor's minimap, which provides an overview of your document.
1075- Setting: `minimap`
1076- Default:
1077
1078```json [settings]
1079{
1080 "minimap": {
1081 "show": "never",
1082 "thumb": "always",
1083 "thumb_border": "left_open",
1084 "current_line_highlight": null
1085 }
1086}
1087```
1088
1089### Show Mode
1090
1091- Description: When to show the minimap in the editor.
1092- Setting: `show`
1093- Default: `never`
1094
1095**Options**
1096
10971. Always show the minimap:
1098
1099```json [settings]
1100{
1101 "show": "always"
1102}
1103```
1104
11052. Show the minimap if the editor's scrollbars are visible:
1106
1107```json [settings]
1108{
1109 "show": "auto"
1110}
1111```
1112
11133. Never show the minimap:
1114
1115```json [settings]
1116{
1117 "show": "never"
1118}
1119```
1120
1121### Thumb Display
1122
1123- Description: When to show the minimap thumb (the visible editor area) in the minimap.
1124- Setting: `thumb`
1125- Default: `always`
1126
1127**Options**
1128
11291. Show the minimap thumb when hovering over the minimap:
1130
1131```json [settings]
1132{
1133 "thumb": "hover"
1134}
1135```
1136
11372. Always show the minimap thumb:
1138
1139```json [settings]
1140{
1141 "thumb": "always"
1142}
1143```
1144
1145### Thumb Border
1146
1147- Description: How the minimap thumb border should look.
1148- Setting: `thumb_border`
1149- Default: `left_open`
1150
1151**Options**
1152
11531. Display a border on all sides of the thumb:
1154
1155```json [settings]
1156{
1157 "thumb_border": "full"
1158}
1159```
1160
11612. Display a border on all sides except the left side:
1162
1163```json [settings]
1164{
1165 "thumb_border": "left_open"
1166}
1167```
1168
11693. Display a border on all sides except the right side:
1170
1171```json [settings]
1172{
1173 "thumb_border": "right_open"
1174}
1175```
1176
11774. Display a border only on the left side:
1178
1179```json [settings]
1180{
1181 "thumb_border": "left_only"
1182}
1183```
1184
11855. Display the thumb without any border:
1186
1187```json [settings]
1188{
1189 "thumb_border": "none"
1190}
1191```
1192
1193### Current Line Highlight
1194
1195- Description: How to highlight the current line in the minimap.
1196- Setting: `current_line_highlight`
1197- Default: `null`
1198
1199**Options**
1200
12011. Inherit the editor's current line highlight setting:
1202
1203```json [settings]
1204{
1205 "minimap": {
1206 "current_line_highlight": null
1207 }
1208}
1209```
1210
12112. Highlight the current line in the minimap:
1212
1213```json [settings]
1214{
1215 "minimap": {
1216 "current_line_highlight": "line"
1217 }
1218}
1219```
1220
1221or
1222
1223```json [settings]
1224{
1225 "minimap": {
1226 "current_line_highlight": "all"
1227 }
1228}
1229```
1230
12313. Do not highlight the current line in the minimap:
1232
1233```json [settings]
1234{
1235 "minimap": {
1236 "current_line_highlight": "gutter"
1237 }
1238}
1239```
1240
1241or
1242
1243```json [settings]
1244{
1245 "minimap": {
1246 "current_line_highlight": "none"
1247 }
1248}
1249```
1250
1251## Editor Tab Bar
1252
1253- Description: Settings related to the editor's tab bar.
1254- Settings: `tab_bar`
1255- Default:
1256
1257```json [settings]
1258"tab_bar": {
1259 "show": true,
1260 "show_nav_history_buttons": true,
1261 "show_tab_bar_buttons": true
1262}
1263```
1264
1265### Show
1266
1267- Description: Whether or not to show the tab bar in the editor.
1268- Setting: `show`
1269- Default: `true`
1270
1271**Options**
1272
1273`boolean` values
1274
1275### Navigation History Buttons
1276
1277- Description: Whether or not to show the navigation history buttons.
1278- Setting: `show_nav_history_buttons`
1279- Default: `true`
1280
1281**Options**
1282
1283`boolean` values
1284
1285### Tab Bar Buttons
1286
1287- Description: Whether or not to show the tab bar buttons.
1288- Setting: `show_tab_bar_buttons`
1289- Default: `true`
1290
1291**Options**
1292
1293`boolean` values
1294
1295## Editor Tabs
1296
1297- Description: Configuration for the editor tabs.
1298- Setting: `tabs`
1299- Default:
1300
1301```json [settings]
1302"tabs": {
1303 "close_position": "right",
1304 "file_icons": false,
1305 "git_status": false,
1306 "activate_on_close": "history",
1307 "show_close_button": "hover",
1308 "show_diagnostics": "off"
1309},
1310```
1311
1312### Close Position
1313
1314- Description: Where to display close button within a tab.
1315- Setting: `close_position`
1316- Default: `right`
1317
1318**Options**
1319
13201. Display the close button on the right:
1321
1322```json [settings]
1323{
1324 "close_position": "right"
1325}
1326```
1327
13282. Display the close button on the left:
1329
1330```json [settings]
1331{
1332 "close_position": "left"
1333}
1334```
1335
1336### File Icons
1337
1338- Description: Whether to show the file icon for a tab.
1339- Setting: `file_icons`
1340- Default: `false`
1341
1342### Git Status
1343
1344- Description: Whether or not to show Git file status in tab.
1345- Setting: `git_status`
1346- Default: `false`
1347
1348### Activate on close
1349
1350- Description: What to do after closing the current tab.
1351- Setting: `activate_on_close`
1352- Default: `history`
1353
1354**Options**
1355
13561. Activate the tab that was open previously:
1357
1358```json [settings]
1359{
1360 "activate_on_close": "history"
1361}
1362```
1363
13642. Activate the right neighbour tab if present:
1365
1366```json [settings]
1367{
1368 "activate_on_close": "neighbour"
1369}
1370```
1371
13723. Activate the left neighbour tab if present:
1373
1374```json [settings]
1375{
1376 "activate_on_close": "left_neighbour"
1377}
1378```
1379
1380### Show close button
1381
1382- Description: Controls the appearance behavior of the tab's close button.
1383- Setting: `show_close_button`
1384- Default: `hover`
1385
1386**Options**
1387
13881. Show it just upon hovering the tab:
1389
1390```json [settings]
1391{
1392 "show_close_button": "hover"
1393}
1394```
1395
13962. Show it persistently:
1397
1398```json [settings]
1399{
1400 "show_close_button": "always"
1401}
1402```
1403
14043. Never show it, even if hovering it:
1405
1406```json [settings]
1407{
1408 "show_close_button": "hidden"
1409}
1410```
1411
1412### Show Diagnostics
1413
1414- Description: Whether to show diagnostics indicators in tabs. This setting only works when file icons are active and controls which files with diagnostic issues to mark.
1415- Setting: `show_diagnostics`
1416- Default: `off`
1417
1418**Options**
1419
14201. Do not mark any files:
1421
1422```json [settings]
1423{
1424 "show_diagnostics": "off"
1425}
1426```
1427
14282. Only mark files with errors:
1429
1430```json [settings]
1431{
1432 "show_diagnostics": "errors"
1433}
1434```
1435
14363. Mark files with errors and warnings:
1437
1438```json [settings]
1439{
1440 "show_diagnostics": "all"
1441}
1442```
1443
1444### Show Inline Code Actions
1445
1446- Description: Whether to show code action button at start of buffer line.
1447- Setting: `inline_code_actions`
1448- Default: `true`
1449
1450**Options**
1451
1452`boolean` values
1453
1454### Drag And Drop Selection
1455
1456- Description: Whether to allow drag and drop text selection in buffer. `delay` is the milliseconds that must elapse before drag and drop is allowed. Otherwise, a new text selection is created.
1457- Setting: `drag_and_drop_selection`
1458- Default:
1459
1460```json [settings]
1461"drag_and_drop_selection": {
1462 "enabled": true,
1463 "delay": 300
1464}
1465```
1466
1467## Editor Toolbar
1468
1469- Description: Whether or not to show various elements in the editor toolbar.
1470- Setting: `toolbar`
1471- Default:
1472
1473```json [settings]
1474"toolbar": {
1475 "breadcrumbs": true,
1476 "quick_actions": true,
1477 "selections_menu": true,
1478 "agent_review": true,
1479 "code_actions": false
1480},
1481```
1482
1483**Options**
1484
1485Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
1486
1487## Use System Tabs
1488
1489- Description: Whether to allow windows to tab together based on the user’s tabbing preference (macOS only).
1490- Setting: `use_system_window_tabs`
1491- Default: `false`
1492
1493**Options**
1494
1495This setting enables integration with macOS’s native window tabbing feature. When set to `true`, Zed windows can be grouped together as tabs in a single macOS window, following the system-wide tabbing preferences set by the user (such as "Always", "In Full Screen", or "Never"). This setting is only available on macOS.
1496
1497## Enable Language Server
1498
1499- Description: Whether or not to use language servers to provide code intelligence.
1500- Setting: `enable_language_server`
1501- Default: `true`
1502
1503**Options**
1504
1505`boolean` values
1506
1507## Ensure Final Newline On Save
1508
1509- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
1510- Setting: `ensure_final_newline_on_save`
1511- Default: `true`
1512
1513**Options**
1514
1515`boolean` values
1516
1517## Expand Excerpt Lines
1518
1519- Description: The default number of lines to expand excerpts in the multibuffer by
1520- Setting: `expand_excerpt_lines`
1521- Default: `5`
1522
1523**Options**
1524
1525Positive `integer` values
1526
1527## Excerpt Context Lines
1528
1529- Description: The number of lines of context to provide when showing excerpts in the multibuffer.
1530- Setting: `excerpt_context_lines`
1531- Default: `2`
1532
1533**Options**
1534
1535Positive `integer` value between 1 and 32. Values outside of this range will be clamped to this range.
1536
1537## Extend Comment On Newline
1538
1539- Description: Whether to start a new line with a comment when a previous line is a comment as well.
1540- Setting: `extend_comment_on_newline`
1541- Default: `true`
1542
1543**Options**
1544
1545`boolean` values
1546
1547## Status Bar
1548
1549- Description: Control various elements in the status bar. Note that some items in the status bar have their own settings set elsewhere.
1550- Setting: `status_bar`
1551- Default:
1552
1553```json [settings]
1554"status_bar": {
1555 "active_language_button": true,
1556 "cursor_position_button": true,
1557 "line_endings_button": false
1558},
1559```
1560
1561There is an experimental setting that completely hides the status bar. This causes major usability problems (you will be unable to use many of Zed's features), but is provided for those who value screen real-estate above all else.
1562
1563```json
1564"status_bar": {
1565 "experimental.show": false
1566}
1567```
1568
1569## LSP
1570
1571- Description: Configuration for language servers.
1572- Setting: `lsp`
1573- Default: `null`
1574
1575**Options**
1576
1577The following settings can be overridden for specific language servers:
1578
1579- `initialization_options`
1580- `settings`
1581
1582To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1583
1584Some 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.
1585
1586For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1587
1588```json [settings]
1589"lsp": {
1590 "rust-analyzer": {
1591 "initialization_options": {
1592 "check": {
1593 "command": "clippy" // rust-analyzer.check.command (default: "check")
1594 }
1595 }
1596 }
1597}
1598```
1599
1600While other options may be changed at a runtime and should be placed under `settings`:
1601
1602```json [settings]
1603"lsp": {
1604 "yaml-language-server": {
1605 "settings": {
1606 "yaml": {
1607 "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1608 }
1609 }
1610 }
1611}
1612```
1613
1614## Global LSP Settings
1615
1616- Description: Configuration for global LSP settings that apply to all language servers
1617- Setting: `global_lsp_settings`
1618- Default:
1619
1620```json [settings]
1621{
1622 "global_lsp_settings": {
1623 "button": true
1624 }
1625}
1626```
1627
1628**Options**
1629
1630- `button`: Whether to show the LSP status button in the status bar
1631
1632## LSP Highlight Debounce
1633
1634- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1635- Setting: `lsp_highlight_debounce`
1636- Default: `75`
1637
1638**Options**
1639
1640`integer` values representing milliseconds
1641
1642## Features
1643
1644- Description: Features that can be globally enabled or disabled
1645- Setting: `features`
1646- Default:
1647
1648```json [settings]
1649{
1650 "features": {
1651 "edit_prediction_provider": "zed"
1652 }
1653}
1654```
1655
1656### Edit Prediction Provider
1657
1658- Description: Which edit prediction provider to use
1659- Setting: `edit_prediction_provider`
1660- Default: `"zed"`
1661
1662**Options**
1663
16641. Use Zeta as the edit prediction provider:
1665
1666```json [settings]
1667{
1668 "features": {
1669 "edit_prediction_provider": "zed"
1670 }
1671}
1672```
1673
16742. Use Copilot as the edit prediction provider:
1675
1676```json [settings]
1677{
1678 "features": {
1679 "edit_prediction_provider": "copilot"
1680 }
1681}
1682```
1683
16843. Use Supermaven as the edit prediction provider:
1685
1686```json [settings]
1687{
1688 "features": {
1689 "edit_prediction_provider": "supermaven"
1690 }
1691}
1692```
1693
16944. Turn off edit predictions across all providers
1695
1696```json [settings]
1697{
1698 "features": {
1699 "edit_prediction_provider": "none"
1700 }
1701}
1702```
1703
1704## Format On Save
1705
1706- Description: Whether or not to perform a buffer format before saving.
1707- Setting: `format_on_save`
1708- Default: `on`
1709
1710**Options**
1711
17121. `on`, enables format on save obeying `formatter` setting:
1713
1714```json [settings]
1715{
1716 "format_on_save": "on"
1717}
1718```
1719
17202. `off`, disables format on save:
1721
1722```json [settings]
1723{
1724 "format_on_save": "off"
1725}
1726```
1727
1728## Formatter
1729
1730- Description: How to perform a buffer format.
1731- Setting: `formatter`
1732- Default: `auto`
1733
1734**Options**
1735
17361. To use the current language server, use `"language_server"`:
1737
1738```json [settings]
1739{
1740 "formatter": "language_server"
1741}
1742```
1743
17442. 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):
1745
1746```json [settings]
1747{
1748 "formatter": {
1749 "external": {
1750 "command": "sed",
1751 "arguments": ["-e", "s/ *$//"]
1752 }
1753 }
1754}
1755```
1756
17573. 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.
1758
1759WARNING: `{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.
1760
1761```json [settings]
1762 "formatter": {
1763 "external": {
1764 "command": "prettier",
1765 "arguments": ["--stdin-filepath", "{buffer_path}"]
1766 }
1767 }
1768```
1769
17704. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1771
1772```json [settings]
1773{
1774 "formatter": [
1775 // Use ESLint's --fix:
1776 { "code_action": "source.fixAll.eslint" },
1777 // Organize imports on save:
1778 { "code_action": "source.organizeImports" }
1779 ]
1780}
1781```
1782
17835. Or to use multiple formatters consecutively, use an array of formatters:
1784
1785```json [settings]
1786{
1787 "formatter": [
1788 { "language_server": { "name": "rust-analyzer" } },
1789 {
1790 "external": {
1791 "command": "sed",
1792 "arguments": ["-e", "s/ *$//"]
1793 }
1794 }
1795 ]
1796}
1797```
1798
1799Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1800If any of the formatters fails, the subsequent ones will still be executed.
1801
1802## Auto close
1803
1804- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1805- Setting: `use_autoclose`
1806- Default: `true`
1807
1808**Options**
1809
1810`boolean` values
1811
1812## Always Treat Brackets As Autoclosed
1813
1814- Description: Controls how the editor handles the autoclosed characters.
1815- Setting: `always_treat_brackets_as_autoclosed`
1816- Default: `false`
1817
1818**Options**
1819
1820`boolean` values
1821
1822**Example**
1823
1824If the setting is set to `true`:
1825
18261. Enter in the editor: `)))`
18272. Move the cursor to the start: `^)))`
18283. Enter again: `)))`
1829
1830The result is still `)))` and not `))))))`, which is what it would be by default.
1831
1832## File Scan Exclusions
1833
1834- Setting: `file_scan_exclusions`
1835- Description: Files or globs of files that will be excluded by Zed entirely. They will be skipped during file scans, file searches, and not be displayed in the project file tree. Overrides `file_scan_inclusions`.
1836- Default:
1837
1838```json [settings]
1839"file_scan_exclusions": [
1840 "**/.git",
1841 "**/.svn",
1842 "**/.hg",
1843 "**/.jj",
1844 "**/CVS",
1845 "**/.DS_Store",
1846 "**/Thumbs.db",
1847 "**/.classpath",
1848 "**/.settings"
1849],
1850```
1851
1852Note, 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.
1853
1854## File Scan Inclusions
1855
1856- Setting: `file_scan_inclusions`
1857- Description: Files or globs of files that will be included by Zed, even when ignored by git. This is useful for files that are not tracked by git, but are still important to your project. Note that globs that are overly broad can slow down Zed's file scanning. `file_scan_exclusions` takes precedence over these inclusions.
1858- Default:
1859
1860```json [settings]
1861"file_scan_inclusions": [".env*"],
1862```
1863
1864## File Types
1865
1866- Setting: `file_types`
1867- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1868- Default:
1869
1870```json [settings]
1871"file_types": {
1872 "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1873 "Shell Script": [".env.*"]
1874}
1875```
1876
1877**Examples**
1878
1879To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1880
1881```json [settings]
1882{
1883 "file_types": {
1884 "C++": ["c"],
1885 "TOML": ["MyLockFile"],
1886 "Dockerfile": ["Dockerfile*"]
1887 }
1888}
1889```
1890
1891## Diagnostics
1892
1893- Description: Configuration for diagnostics-related features.
1894- Setting: `diagnostics`
1895- Default:
1896
1897```json [settings]
1898{
1899 "diagnostics": {
1900 "include_warnings": true,
1901 "inline": {
1902 "enabled": false
1903 },
1904 "update_with_cursor": false,
1905 "primary_only": false,
1906 "use_rendered": false
1907 }
1908}
1909```
1910
1911### Inline Diagnostics
1912
1913- Description: Whether or not to show diagnostics information inline.
1914- Setting: `inline`
1915- Default:
1916
1917```json [settings]
1918{
1919 "diagnostics": {
1920 "inline": {
1921 "enabled": false,
1922 "update_debounce_ms": 150,
1923 "padding": 4,
1924 "min_column": 0,
1925 "max_severity": null
1926 }
1927 }
1928}
1929```
1930
1931**Options**
1932
19331. Enable inline diagnostics.
1934
1935```json [settings]
1936{
1937 "diagnostics": {
1938 "inline": {
1939 "enabled": true
1940 }
1941 }
1942}
1943```
1944
19452. Delay diagnostic updates until some time after the last diagnostic update.
1946
1947```json [settings]
1948{
1949 "diagnostics": {
1950 "inline": {
1951 "enabled": true,
1952 "update_debounce_ms": 150
1953 }
1954 }
1955}
1956```
1957
19583. Set padding between the end of the source line and the start of the diagnostic.
1959
1960```json [settings]
1961{
1962 "diagnostics": {
1963 "inline": {
1964 "enabled": true,
1965 "padding": 4
1966 }
1967 }
1968}
1969```
1970
19714. Horizontally align inline diagnostics at the given column.
1972
1973```json [settings]
1974{
1975 "diagnostics": {
1976 "inline": {
1977 "enabled": true,
1978 "min_column": 80
1979 }
1980 }
1981}
1982```
1983
19845. Show only warning and error diagnostics.
1985
1986```json [settings]
1987{
1988 "diagnostics": {
1989 "inline": {
1990 "enabled": true,
1991 "max_severity": "warning"
1992 }
1993 }
1994}
1995```
1996
1997## Git
1998
1999- Description: Configuration for git-related features.
2000- Setting: `git`
2001- Default:
2002
2003```json [settings]
2004{
2005 "git": {
2006 "git_gutter": "tracked_files",
2007 "inline_blame": {
2008 "enabled": true
2009 },
2010 "branch_picker": {
2011 "show_author_name": true
2012 },
2013 "hunk_style": "staged_hollow"
2014 }
2015}
2016```
2017
2018### Git Gutter
2019
2020- Description: Whether or not to show the git gutter.
2021- Setting: `git_gutter`
2022- Default: `tracked_files`
2023
2024**Options**
2025
20261. Show git gutter in tracked files
2027
2028```json [settings]
2029{
2030 "git": {
2031 "git_gutter": "tracked_files"
2032 }
2033}
2034```
2035
20362. Hide git gutter
2037
2038```json [settings]
2039{
2040 "git": {
2041 "git_gutter": "hide"
2042 }
2043}
2044```
2045
2046### Gutter Debounce
2047
2048- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2049- Setting: `gutter_debounce`
2050- Default: `null`
2051
2052**Options**
2053
2054`integer` values representing milliseconds
2055
2056Example:
2057
2058```json [settings]
2059{
2060 "git": {
2061 "gutter_debounce": 100
2062 }
2063}
2064```
2065
2066### Inline Git Blame
2067
2068- Description: Whether or not to show git blame information inline, on the currently focused line.
2069- Setting: `inline_blame`
2070- Default:
2071
2072```json [settings]
2073{
2074 "git": {
2075 "inline_blame": {
2076 "enabled": true
2077 }
2078 }
2079}
2080```
2081
2082**Options**
2083
20841. Disable inline git blame:
2085
2086```json [settings]
2087{
2088 "git": {
2089 "inline_blame": {
2090 "enabled": false
2091 }
2092 }
2093}
2094```
2095
20962. Only show inline git blame after a delay (that starts after cursor stops moving):
2097
2098```json [settings]
2099{
2100 "git": {
2101 "inline_blame": {
2102 "delay_ms": 500
2103 }
2104 }
2105}
2106```
2107
21083. Show a commit summary next to the commit date and author:
2109
2110```json [settings]
2111{
2112 "git": {
2113 "inline_blame": {
2114 "show_commit_summary": true
2115 }
2116 }
2117}
2118```
2119
21204. Use this as the minimum column at which to display inline blame information:
2121
2122```json [settings]
2123{
2124 "git": {
2125 "inline_blame": {
2126 "min_column": 80
2127 }
2128 }
2129}
2130```
2131
21325. Set the padding between the end of the line and the inline blame hint, in ems:
2133
2134```json [settings]
2135{
2136 "git": {
2137 "inline_blame": {
2138 "padding": 10
2139 }
2140 }
2141}
2142```
2143
2144### Branch Picker
2145
2146- Description: Configuration related to the branch picker.
2147- Setting: `branch_picker`
2148- Default:
2149
2150```json [settings]
2151{
2152 "git": {
2153 "branch_picker": {
2154 "show_author_name": false
2155 }
2156 }
2157}
2158```
2159
2160**Options**
2161
21621. Show the author name in the branch picker:
2163
2164```json [settings]
2165{
2166 "git": {
2167 "branch_picker": {
2168 "show_author_name": true
2169 }
2170 }
2171}
2172```
2173
2174### Hunk Style
2175
2176- Description: What styling we should use for the diff hunks.
2177- Setting: `hunk_style`
2178- Default:
2179
2180```json [settings]
2181{
2182 "git": {
2183 "hunk_style": "staged_hollow"
2184 }
2185}
2186```
2187
2188**Options**
2189
21901. Show the staged hunks faded out and with a border:
2191
2192```json [settings]
2193{
2194 "git": {
2195 "hunk_style": "staged_hollow"
2196 }
2197}
2198```
2199
22002. Show unstaged hunks faded out and with a border:
2201
2202```json [settings]
2203{
2204 "git": {
2205 "hunk_style": "unstaged_hollow"
2206 }
2207}
2208```
2209
2210## Go to Definition Fallback
2211
2212- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2213- Setting: `go_to_definition_fallback`
2214- Default: `"find_all_references"`
2215
2216**Options**
2217
22181. Do nothing:
2219
2220```json [settings]
2221{
2222 "go_to_definition_fallback": "none"
2223}
2224```
2225
22262. Find references for the same symbol (default):
2227
2228```json [settings]
2229{
2230 "go_to_definition_fallback": "find_all_references"
2231}
2232```
2233
2234## Hard Tabs
2235
2236- Description: Whether to indent lines using tab characters or multiple spaces.
2237- Setting: `hard_tabs`
2238- Default: `false`
2239
2240**Options**
2241
2242`boolean` values
2243
2244## Helix Mode
2245
2246- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2247- Setting: `helix_mode`
2248- Default: `false`
2249
2250**Options**
2251
2252`boolean` values
2253
2254## Indent Guides
2255
2256- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2257- Setting: `indent_guides`
2258- Default:
2259
2260```json [settings]
2261{
2262 "indent_guides": {
2263 "enabled": true,
2264 "line_width": 1,
2265 "active_line_width": 1,
2266 "coloring": "fixed",
2267 "background_coloring": "disabled"
2268 }
2269}
2270```
2271
2272**Options**
2273
22741. Disable indent guides
2275
2276```json [settings]
2277{
2278 "indent_guides": {
2279 "enabled": false
2280 }
2281}
2282```
2283
22842. Enable indent guides for a specific language.
2285
2286```json [settings]
2287{
2288 "languages": {
2289 "Python": {
2290 "indent_guides": {
2291 "enabled": true
2292 }
2293 }
2294 }
2295}
2296```
2297
22983. Enable indent aware coloring ("rainbow indentation").
2299 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.
2300
2301```json [settings]
2302{
2303 "indent_guides": {
2304 "enabled": true,
2305 "coloring": "indent_aware"
2306 }
2307}
2308```
2309
23104. Enable indent aware background coloring ("rainbow indentation").
2311 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.
2312
2313```json [settings]
2314{
2315 "indent_guides": {
2316 "enabled": true,
2317 "coloring": "indent_aware",
2318 "background_coloring": "indent_aware"
2319 }
2320}
2321```
2322
2323## Hover Popover Enabled
2324
2325- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2326- Setting: `hover_popover_enabled`
2327- Default: `true`
2328
2329**Options**
2330
2331`boolean` values
2332
2333## Hover Popover Delay
2334
2335- Description: Time to wait in milliseconds before showing the informational hover box.
2336- Setting: `hover_popover_delay`
2337- Default: `300`
2338
2339**Options**
2340
2341`integer` values representing milliseconds
2342
2343## Icon Theme
2344
2345- Description: The icon theme setting can be specified in two forms - either as the name of an icon theme or as an object containing the `mode`, `dark`, and `light` icon themes for files/folders inside Zed.
2346- Setting: `icon_theme`
2347- Default: `Zed (Default)`
2348
2349### Icon Theme Object
2350
2351- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2352- Setting: `icon_theme`
2353- Default:
2354
2355```json [settings]
2356"icon_theme": {
2357 "mode": "system",
2358 "dark": "Zed (Default)",
2359 "light": "Zed (Default)"
2360},
2361```
2362
2363### Mode
2364
2365- Description: Specify the icon theme mode.
2366- Setting: `mode`
2367- Default: `system`
2368
2369**Options**
2370
23711. Set the icon theme to dark mode
2372
2373```json [settings]
2374{
2375 "mode": "dark"
2376}
2377```
2378
23792. Set the icon theme to light mode
2380
2381```json [settings]
2382{
2383 "mode": "light"
2384}
2385```
2386
23873. Set the icon theme to system mode
2388
2389```json [settings]
2390{
2391 "mode": "system"
2392}
2393```
2394
2395### Dark
2396
2397- Description: The name of the dark icon theme.
2398- Setting: `dark`
2399- Default: `Zed (Default)`
2400
2401**Options**
2402
2403Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2404
2405### Light
2406
2407- Description: The name of the light icon theme.
2408- Setting: `light`
2409- Default: `Zed (Default)`
2410
2411**Options**
2412
2413Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2414
2415## Image Viewer
2416
2417- Description: Settings for image viewer functionality
2418- Setting: `image_viewer`
2419- Default:
2420
2421```json [settings]
2422{
2423 "image_viewer": {
2424 "unit": "binary"
2425 }
2426}
2427```
2428
2429**Options**
2430
2431### Unit
2432
2433- Description: The unit for image file sizes
2434- Setting: `unit`
2435- Default: `"binary"`
2436
2437**Options**
2438
24391. Use binary units (KiB, MiB):
2440
2441```json [settings]
2442{
2443 "image_viewer": {
2444 "unit": "binary"
2445 }
2446}
2447```
2448
24492. Use decimal units (KB, MB):
2450
2451```json [settings]
2452{
2453 "image_viewer": {
2454 "unit": "decimal"
2455 }
2456}
2457```
2458
2459## Inlay hints
2460
2461- Description: Configuration for displaying extra text with hints in the editor.
2462- Setting: `inlay_hints`
2463- Default:
2464
2465```json [settings]
2466"inlay_hints": {
2467 "enabled": false,
2468 "show_type_hints": true,
2469 "show_parameter_hints": true,
2470 "show_other_hints": true,
2471 "show_background": false,
2472 "edit_debounce_ms": 700,
2473 "scroll_debounce_ms": 50,
2474 "toggle_on_modifiers_press": null
2475}
2476```
2477
2478**Options**
2479
2480Inlay hints querying consists of two parts: editor (client) and LSP server.
2481With 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.
2482At 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.
2483
2484The following languages have inlay hints preconfigured by Zed:
2485
2486- [Go](https://docs.zed.dev/languages/go)
2487- [Rust](https://docs.zed.dev/languages/rust)
2488- [Svelte](https://docs.zed.dev/languages/svelte)
2489- [TypeScript](https://docs.zed.dev/languages/typescript)
2490
2491Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2492
2493Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2494Settings-related hint updates are not debounced.
2495
2496All possible config values for `toggle_on_modifiers_press` are:
2497
2498```json [settings]
2499"inlay_hints": {
2500 "toggle_on_modifiers_press": {
2501 "control": true,
2502 "shift": true,
2503 "alt": true,
2504 "platform": true,
2505 "function": true
2506 }
2507}
2508```
2509
2510Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2511
2512## Journal
2513
2514- Description: Configuration for the journal.
2515- Setting: `journal`
2516- Default:
2517
2518```json [settings]
2519"journal": {
2520 "path": "~",
2521 "hour_format": "hour12"
2522}
2523
2524```
2525
2526### Path
2527
2528- Description: The path of the directory where journal entries are stored. If an invalid path is specified, the journal will fall back to using `~` (the home directory).
2529- Setting: `path`
2530- Default: `~`
2531
2532**Options**
2533
2534`string` values
2535
2536### Hour Format
2537
2538- Description: The format to use for displaying hours in the journal.
2539- Setting: `hour_format`
2540- Default: `hour12`
2541
2542**Options**
2543
25441. 12-hour format:
2545
2546```json [settings]
2547{
2548 "hour_format": "hour12"
2549}
2550```
2551
25522. 24-hour format:
2553
2554```json [settings]
2555{
2556 "hour_format": "hour24"
2557}
2558```
2559
2560## JSX Tag Auto Close
2561
2562- Description: Whether to automatically close JSX tags
2563- Setting: `jsx_tag_auto_close`
2564- Default:
2565
2566```json [settings]
2567{
2568 "jsx_tag_auto_close": {
2569 "enabled": true
2570 }
2571}
2572```
2573
2574**Options**
2575
2576- `enabled`: Whether to enable automatic JSX tag closing
2577
2578## Languages
2579
2580- Description: Configuration for specific languages.
2581- Setting: `languages`
2582- Default: `null`
2583
2584**Options**
2585
2586To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2587
2588```json [settings]
2589"languages": {
2590 "C": {
2591 "format_on_save": "off",
2592 "preferred_line_length": 64,
2593 "soft_wrap": "preferred_line_length"
2594 },
2595 "JSON": {
2596 "tab_size": 4
2597 }
2598}
2599```
2600
2601The following settings can be overridden for each specific language:
2602
2603- [`enable_language_server`](#enable-language-server)
2604- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2605- [`format_on_save`](#format-on-save)
2606- [`formatter`](#formatter)
2607- [`hard_tabs`](#hard-tabs)
2608- [`preferred_line_length`](#preferred-line-length)
2609- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2610- [`show_edit_predictions`](#show-edit-predictions)
2611- [`show_whitespaces`](#show-whitespaces)
2612- [`whitespace_map`](#whitespace-map)
2613- [`soft_wrap`](#soft-wrap)
2614- [`tab_size`](#tab-size)
2615- [`use_autoclose`](#use-autoclose)
2616- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2617
2618These values take in the same options as the root-level settings with the same name.
2619
2620## Language Models
2621
2622- Description: Configuration for language model providers
2623- Setting: `language_models`
2624- Default:
2625
2626```json [settings]
2627{
2628 "language_models": {
2629 "google": {
2630 "api_url": "https://generativelanguage.googleapis.com"
2631 },
2632 "ollama": {
2633 "api_url": "http://localhost:11434"
2634 },
2635 "openai": {
2636 "api_url": "https://api.openai.com/v1"
2637 }
2638 }
2639}
2640```
2641
2642**Options**
2643
2644Configuration for various AI model providers including API URLs and authentication settings.
2645
2646## Line Indicator Format
2647
2648- Description: Format for line indicator in the status bar
2649- Setting: `line_indicator_format`
2650- Default: `"short"`
2651
2652**Options**
2653
26541. Short format:
2655
2656```json [settings]
2657{
2658 "line_indicator_format": "short"
2659}
2660```
2661
26622. Long format:
2663
2664```json [settings]
2665{
2666 "line_indicator_format": "long"
2667}
2668```
2669
2670## Linked Edits
2671
2672- Description: Whether to perform linked edits of associated ranges, if the language server supports it. For example, when editing opening `<html>` tag, the contents of the closing `</html>` tag will be edited as well.
2673- Setting: `linked_edits`
2674- Default: `true`
2675
2676**Options**
2677
2678`boolean` values
2679
2680## LSP Document Colors
2681
2682- Description: Whether to show document color information from the language server
2683- Setting: `lsp_document_colors`
2684- Default: `true`
2685
2686**Options**
2687
2688`boolean` values
2689
2690## Max Tabs
2691
2692- Description: Maximum number of tabs to show in the tab bar
2693- Setting: `max_tabs`
2694- Default: `null`
2695
2696**Options**
2697
2698Positive `integer` values or `null` for unlimited tabs
2699
2700## Middle Click Paste (Linux only)
2701
2702- Description: Enable middle-click paste on Linux
2703- Setting: `middle_click_paste`
2704- Default: `true`
2705
2706**Options**
2707
2708`boolean` values
2709
2710## Multi Cursor Modifier
2711
2712- Description: Determines the modifier to be used to add multiple cursors with the mouse. The open hover link mouse gestures will adapt such that it do not conflict with the multicursor modifier.
2713- Setting: `multi_cursor_modifier`
2714- Default: `alt`
2715
2716**Options**
2717
27181. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2719
2720```json [settings]
2721{
2722 "multi_cursor_modifier": "alt"
2723}
2724```
2725
27262. Maps `Control` on Linux and Windows and to `Command` on macOS:
2727
2728```json [settings]
2729{
2730 "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2731}
2732```
2733
2734## Node
2735
2736- Description: Configuration for Node.js integration
2737- Setting: `node`
2738- Default:
2739
2740```json [settings]
2741{
2742 "node": {
2743 "ignore_system_version": false,
2744 "path": null,
2745 "npm_path": null
2746 }
2747}
2748```
2749
2750**Options**
2751
2752- `ignore_system_version`: Whether to ignore the system Node.js version
2753- `path`: Custom path to Node.js binary
2754- `npm_path`: Custom path to npm binary
2755
2756## Network Proxy
2757
2758- Description: Configure a network proxy for Zed.
2759- Setting: `proxy`
2760- Default: `null`
2761
2762**Options**
2763
2764The proxy setting must contain a URL to the proxy.
2765
2766The following URI schemes are supported:
2767
2768- `http`
2769- `https`
2770- `socks4` - SOCKS4 proxy with local DNS
2771- `socks4a` - SOCKS4 proxy with remote DNS
2772- `socks5` - SOCKS5 proxy with local DNS
2773- `socks5h` - SOCKS5 proxy with remote DNS
2774
2775`http` will be used when no scheme is specified.
2776
2777By 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`, `no_proxy` and `NO_PROXY`.
2778
2779For example, to set an `http` proxy, add the following to your settings:
2780
2781```json [settings]
2782{
2783 "proxy": "http://127.0.0.1:10809"
2784}
2785```
2786
2787Or to set a `socks5` proxy:
2788
2789```json [settings]
2790{
2791 "proxy": "socks5h://localhost:10808"
2792}
2793```
2794
2795If you wish to exclude certain hosts from using the proxy, set the `NO_PROXY` environment variable. This accepts a comma-separated list of hostnames, host suffixes, IPv4/IPv6 addresses or blocks that should not use the proxy. For example if your environment included `NO_PROXY="google.com, 192.168.1.0/24"` all hosts in `192.168.1.*`, `google.com` and `*.google.com` would bypass the proxy. See [reqwest NoProxy docs](https://docs.rs/reqwest/latest/reqwest/struct.NoProxy.html#method.from_string) for more.
2796
2797## On Last Window Closed
2798
2799- Description: What to do when the last window is closed
2800- Setting: `on_last_window_closed`
2801- Default: `"platform_default"`
2802
2803**Options**
2804
28051. Use platform default behavior:
2806
2807```json [settings]
2808{
2809 "on_last_window_closed": "platform_default"
2810}
2811```
2812
28132. Always quit the application:
2814
2815```json [settings]
2816{
2817 "on_last_window_closed": "quit_app"
2818}
2819```
2820
2821## Profiles
2822
2823- Description: Configuration profiles that can be applied on top of existing settings
2824- Setting: `profiles`
2825- Default: `{}`
2826
2827**Options**
2828
2829Configuration object for defining settings profiles. Example:
2830
2831```json [settings]
2832{
2833 "profiles": {
2834 "presentation": {
2835 "buffer_font_size": 20,
2836 "ui_font_size": 18,
2837 "theme": "One Light"
2838 }
2839 }
2840}
2841```
2842
2843## Preview tabs
2844
2845- Description:
2846 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. \
2847 There are several ways to convert a preview tab into a regular tab:
2848
2849 - Double-clicking on the file
2850 - Double-clicking on the tab header
2851 - Using the {#action project_panel::OpenPermanent} action
2852 - Editing the file
2853 - Dragging the file to a different pane
2854
2855- Setting: `preview_tabs`
2856- Default:
2857
2858```json [settings]
2859"preview_tabs": {
2860 "enabled": true,
2861 "enable_preview_from_project_panel": true,
2862 "enable_preview_from_file_finder": false,
2863 "enable_preview_from_multibuffer": true,
2864 "enable_preview_multibuffer_from_code_navigation": false,
2865 "enable_preview_file_from_code_navigation": true,
2866 "enable_keep_preview_on_code_navigation": false,
2867}
2868```
2869
2870### Enable preview from project panel
2871
2872- Description: Determines whether to open files in preview mode when opened from the project panel with a single click.
2873- Setting: `enable_preview_from_project_panel`
2874- Default: `true`
2875
2876**Options**
2877
2878`boolean` values
2879
2880### Enable preview from file finder
2881
2882- Description: Determines whether to open files in preview mode when selected from the file finder.
2883- Setting: `enable_preview_from_file_finder`
2884- Default: `false`
2885
2886**Options**
2887
2888`boolean` values
2889
2890### Enable preview from multibuffer
2891
2892- Description: Determines whether to open files in preview mode when opened from a multibuffer.
2893- Setting: `enable_preview_from_multibuffer`
2894- Default: `true`
2895
2896**Options**
2897
2898`boolean` values
2899
2900### Enable preview multibuffer from code navigation
2901
2902- Description: Determines whether to open tabs in preview mode when code navigation is used to open a multibuffer.
2903- Setting: `enable_preview_multibuffer_from_code_navigation`
2904- Default: `false`
2905
2906**Options**
2907
2908`boolean` values
2909
2910### Enable preview file from code navigation
2911
2912- Description: Determines whether to open tabs in preview mode when code navigation is used to open a single file.
2913- Setting: `enable_preview_file_from_code_navigation`
2914- Default: `true`
2915
2916**Options**
2917
2918`boolean` values
2919
2920### Enable keep preview on code navigation
2921
2922- Description: Determines whether to keep tabs in preview mode when code navigation is used to navigate away from them. If `enable_preview_file_from_code_navigation` or `enable_preview_multibuffer_from_code_navigation` is also true, the new tab may replace the existing one.
2923- Setting: `enable_keep_preview_on_code_navigation`
2924- Default: `false`
2925
2926**Options**
2927
2928`boolean` values
2929
2930## File Finder
2931
2932### File Icons
2933
2934- Description: Whether to show file icons in the file finder.
2935- Setting: `file_icons`
2936- Default: `true`
2937
2938### Modal Max Width
2939
2940- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2941- Setting: `modal_max_width`
2942- Default: `small`
2943
2944### Skip Focus For Active In Search
2945
2946- Description: Determines whether the file finder should skip focus for the active file in search results.
2947- Setting: `skip_focus_for_active_in_search`
2948- Default: `true`
2949
2950## Pane Split Direction Horizontal
2951
2952- Description: The direction that you want to split panes horizontally
2953- Setting: `pane_split_direction_horizontal`
2954- Default: `"up"`
2955
2956**Options**
2957
29581. Split upward:
2959
2960```json [settings]
2961{
2962 "pane_split_direction_horizontal": "up"
2963}
2964```
2965
29662. Split downward:
2967
2968```json [settings]
2969{
2970 "pane_split_direction_horizontal": "down"
2971}
2972```
2973
2974## Pane Split Direction Vertical
2975
2976- Description: The direction that you want to split panes vertically
2977- Setting: `pane_split_direction_vertical`
2978- Default: `"left"`
2979
2980**Options**
2981
29821. Split to the left:
2983
2984```json [settings]
2985{
2986 "pane_split_direction_vertical": "left"
2987}
2988```
2989
29902. Split to the right:
2991
2992```json [settings]
2993{
2994 "pane_split_direction_vertical": "right"
2995}
2996```
2997
2998## Preferred Line Length
2999
3000- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
3001- Setting: `preferred_line_length`
3002- Default: `80`
3003
3004**Options**
3005
3006`integer` values
3007
3008## Private Files
3009
3010- Description: Globs to match against file paths to determine if a file is private
3011- Setting: `private_files`
3012- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
3013
3014**Options**
3015
3016List of `string` glob patterns
3017
3018## Projects Online By Default
3019
3020- Description: Whether or not to show the online projects view by default.
3021- Setting: `projects_online_by_default`
3022- Default: `true`
3023
3024**Options**
3025
3026`boolean` values
3027
3028## Read SSH Config
3029
3030- Description: Whether to read SSH configuration files
3031- Setting: `read_ssh_config`
3032- Default: `true`
3033
3034**Options**
3035
3036`boolean` values
3037
3038## Redact Private Values
3039
3040- Description: Hide the values of variables from visual display in private files
3041- Setting: `redact_private_values`
3042- Default: `false`
3043
3044**Options**
3045
3046`boolean` values
3047
3048## Relative Line Numbers
3049
3050- Description: Whether to show relative line numbers in the gutter
3051- Setting: `relative_line_numbers`
3052- Default: `"disabled"`
3053
3054**Options**
3055
30561. Show relative line numbers in the gutter whilst counting wrapped lines as one line:
3057
3058```json [settings]
3059{
3060 "relative_line_numbers": "enabled"
3061}
3062```
3063
30642. Show relative line numbers in the gutter, including wrapped lines in the counting:
3065
3066```json [settings]
3067{
3068 "relative_line_numbers": "wrapped"
3069}
3070```
3071
30722. Do not use relative line numbers:
3073
3074```json [settings]
3075{
3076 "relative_line_numbers": "disabled"
3077}
3078```
3079
3080## Remove Trailing Whitespace On Save
3081
3082- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3083- Setting: `remove_trailing_whitespace_on_save`
3084- Default: `true`
3085
3086**Options**
3087
3088`boolean` values
3089
3090## Resize All Panels In Dock
3091
3092- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3093- Setting: `resize_all_panels_in_dock`
3094- Default: `["left"]`
3095
3096**Options**
3097
3098List of strings containing any combination of:
3099
3100- `"left"`: Resize left dock panels together
3101- `"right"`: Resize right dock panels together
3102- `"bottom"`: Resize bottom dock panels together
3103
3104## Restore on File Reopen
3105
3106- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3107- Setting: `restore_on_file_reopen`
3108- Default: `true`
3109
3110**Options**
3111
3112`boolean` values
3113
3114## Restore on Startup
3115
3116- Description: Controls session restoration on startup.
3117- Setting: `restore_on_startup`
3118- Default: `last_session`
3119
3120**Options**
3121
31221. Restore all workspaces that were open when quitting Zed:
3123
3124```json [settings]
3125{
3126 "restore_on_startup": "last_session"
3127}
3128```
3129
31302. Restore the workspace that was closed last:
3131
3132```json [settings]
3133{
3134 "restore_on_startup": "last_workspace"
3135}
3136```
3137
31383. Always start with an empty editor:
3139
3140```json [settings]
3141{
3142 "restore_on_startup": "none"
3143}
3144```
3145
3146## Scroll Beyond Last Line
3147
3148- Description: Whether the editor will scroll beyond the last line
3149- Setting: `scroll_beyond_last_line`
3150- Default: `"one_page"`
3151
3152**Options**
3153
31541. Scroll one page beyond the last line by one page:
3155
3156```json [settings]
3157{
3158 "scroll_beyond_last_line": "one_page"
3159}
3160```
3161
31622. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3163
3164```json [settings]
3165{
3166 "scroll_beyond_last_line": "vertical_scroll_margin"
3167}
3168```
3169
31703. The editor will not scroll beyond the last line:
3171
3172```json [settings]
3173{
3174 "scroll_beyond_last_line": "off"
3175}
3176```
3177
3178**Options**
3179
3180`boolean` values
3181
3182## Scroll Sensitivity
3183
3184- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3185- Setting: `scroll_sensitivity`
3186- Default: `1.0`
3187
3188**Options**
3189
3190Positive `float` values
3191
3192### Fast Scroll Sensitivity
3193
3194- Description: Scroll sensitivity multiplier for fast scrolling. This multiplier is applied to both the horizontal and vertical delta values while scrolling. Fast scrolling happens when a user holds the alt or option key while scrolling.
3195- Setting: `fast_scroll_sensitivity`
3196- Default: `4.0`
3197
3198**Options**
3199
3200Positive `float` values
3201
3202### Horizontal Scroll Margin
3203
3204- Description: The number of characters to keep on either side when scrolling with the mouse
3205- Setting: `horizontal_scroll_margin`
3206- Default: `5`
3207
3208**Options**
3209
3210Non-negative `integer` values
3211
3212### Vertical Scroll Margin
3213
3214- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3215- Setting: `vertical_scroll_margin`
3216- Default: `3`
3217
3218**Options**
3219
3220Non-negative `integer` values
3221
3222## Search
3223
3224- Description: Search options to enable by default when opening new project and buffer searches.
3225- Setting: `search`
3226- Default:
3227
3228```json [settings]
3229"search": {
3230 "button": true,
3231 "whole_word": false,
3232 "case_sensitive": false,
3233 "include_ignored": false,
3234 "regex": false,
3235 "center_on_match": false
3236},
3237```
3238
3239### Button
3240
3241- Description: Whether to show the project search button in the status bar.
3242- Setting: `button`
3243- Default: `true`
3244
3245### Whole Word
3246
3247- Description: Whether to only match on whole words.
3248- Setting: `whole_word`
3249- Default: `false`
3250
3251### Case Sensitive
3252
3253- Description: Whether to match case sensitively. This setting affects both
3254 searches and editor actions like "Select Next Occurrence", "Select Previous
3255 Occurrence", and "Select All Occurrences".
3256- Setting: `case_sensitive`
3257- Default: `false`
3258
3259### Include Ignore
3260
3261- Description: Whether to include gitignored files in search results.
3262- Setting: `include_ignored`
3263- Default: `false`
3264
3265### Regex
3266
3267- Description: Whether to interpret the search query as a regular expression.
3268- Setting: `regex`
3269- Default: `false`
3270
3271### Center On Match
3272
3273- Description: Whether to center the cursor on each search match when navigating.
3274- Setting: `center_on_match`
3275- Default: `false`
3276
3277## Search Wrap
3278
3279- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3280- Setting: `search_wrap`
3281- Default: `true`
3282
3283## Center on Match
3284
3285- Description: If `center_on_match` is enabled, the editor will center the cursor on the current match when searching.
3286- Setting: `center_on_match`
3287- Default: `false`
3288
3289## Seed Search Query From Cursor
3290
3291- Description: When to populate a new search's query based on the text under the cursor.
3292- Setting: `seed_search_query_from_cursor`
3293- Default: `always`
3294
3295**Options**
3296
32971. `always` always populate the search query with the word under the cursor
32982. `selection` only populate the search query when there is text selected
32993. `never` never populate the search query
3300
3301## Use Smartcase Search
3302
3303- Description: When enabled, automatically adjusts search case sensitivity based on your query. If your search query contains any uppercase letters, the search becomes case-sensitive; if it contains only lowercase letters, the search becomes case-insensitive. \
3304 This applies to both in-file searches and project-wide searches.
3305- Setting: `use_smartcase_search`
3306- Default: `false`
3307
3308**Options**
3309
3310`boolean` values
3311
3312Examples:
3313
3314- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3315- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3316
3317## Show Call Status Icon
3318
3319- Description: Whether or not to show the call status icon in the status bar.
3320- Setting: `show_call_status_icon`
3321- Default: `true`
3322
3323**Options**
3324
3325`boolean` values
3326
3327## Completions
3328
3329- Description: Controls how completions are processed for this language.
3330- Setting: `completions`
3331- Default:
3332
3333```json [settings]
3334{
3335 "completions": {
3336 "words": "fallback",
3337 "words_min_length": 3,
3338 "lsp": true,
3339 "lsp_fetch_timeout_ms": 0,
3340 "lsp_insert_mode": "replace_suffix"
3341 }
3342}
3343```
3344
3345### Words
3346
3347- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3348- Setting: `words`
3349- Default: `fallback`
3350
3351**Options**
3352
33531. `enabled` - Always fetch document's words for completions along with LSP completions
33542. `fallback` - Only if LSP response errors or times out, use document's words to show completions
33553. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3356
3357### Min Words Query Length
3358
3359- Description: Minimum number of characters required to automatically trigger word-based completions.
3360 Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3361- Setting: `words_min_length`
3362- Default: `3`
3363
3364**Options**
3365
3366Positive integer values
3367
3368### LSP
3369
3370- Description: Whether to fetch LSP completions or not.
3371- Setting: `lsp`
3372- Default: `true`
3373
3374**Options**
3375
3376`boolean` values
3377
3378### LSP Fetch Timeout (ms)
3379
3380- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3381- Setting: `lsp_fetch_timeout_ms`
3382- Default: `0`
3383
3384**Options**
3385
3386`integer` values representing milliseconds
3387
3388### LSP Insert Mode
3389
3390- Description: Controls what range to replace when accepting LSP completions.
3391- Setting: `lsp_insert_mode`
3392- Default: `replace_suffix`
3393
3394**Options**
3395
33961. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
33972. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
33983. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
33994. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3400
3401## Show Completions On Input
3402
3403- Description: Whether or not to show completions as you type.
3404- Setting: `show_completions_on_input`
3405- Default: `true`
3406
3407**Options**
3408
3409`boolean` values
3410
3411## Show Completion Documentation
3412
3413- Description: Whether to display inline and alongside documentation for items in the completions menu.
3414- Setting: `show_completion_documentation`
3415- Default: `true`
3416
3417**Options**
3418
3419`boolean` values
3420
3421## Show Edit Predictions
3422
3423- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3424- Setting: `show_edit_predictions`
3425- Default: `true`
3426
3427**Options**
3428
3429`boolean` values
3430
3431## Show Whitespaces
3432
3433- Description: Whether or not to render whitespace characters in the editor.
3434- Setting: `show_whitespaces`
3435- Default: `selection`
3436
3437**Options**
3438
34391. `all`
34402. `selection`
34413. `none`
34424. `boundary`
3443
3444## Whitespace Map
3445
3446- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3447- Setting: `whitespace_map`
3448- Default:
3449
3450```json [settings]
3451{
3452 "whitespace_map": {
3453 "space": "•",
3454 "tab": "→"
3455 }
3456}
3457```
3458
3459## Soft Wrap
3460
3461- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3462- Setting: `soft_wrap`
3463- Default: `none`
3464
3465**Options**
3466
34671. `none` to avoid wrapping generally, unless the line is too long
34682. `prefer_line` (deprecated, same as `none`)
34693. `editor_width` to wrap lines that overflow the editor width
34704. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
34715. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3472
3473## Show Wrap Guides
3474
3475- Description: Whether to show wrap guides (vertical rulers) in the editor. Setting this to true will show a guide at the 'preferred_line_length' value if 'soft_wrap' is set to 'preferred_line_length', and will show any additional guides as specified by the 'wrap_guides' setting.
3476- Setting: `show_wrap_guides`
3477- Default: `true`
3478
3479**Options**
3480
3481`boolean` values
3482
3483## Use On Type Format
3484
3485- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3486- Setting: `use_on_type_format`
3487- Default: `true`
3488
3489**Options**
3490
3491`boolean` values
3492
3493## Use Auto Surround
3494
3495- Description: Whether to automatically surround selected text when typing opening parenthesis, bracket, brace, single or double quote characters. For example, when you select text and type '(', Zed will surround the text with ().
3496- Setting: `use_auto_surround`
3497- Default: `true`
3498
3499**Options**
3500
3501`boolean` values
3502
3503## Use System Path Prompts
3504
3505- Description: Whether to use the system provided dialogs for Open and Save As. When set to false, Zed will use the built-in keyboard-first pickers.
3506- Setting: `use_system_path_prompts`
3507- Default: `true`
3508
3509**Options**
3510
3511`boolean` values
3512
3513## Use System Prompts
3514
3515- Description: Whether to use the system provided dialogs for prompts, such as confirmation prompts. When set to false, Zed will use its built-in prompts. Note that on Linux, this option is ignored and Zed will always use the built-in prompts.
3516- Setting: `use_system_prompts`
3517- Default: `true`
3518
3519**Options**
3520
3521`boolean` values
3522
3523## Wrap Guides (Vertical Rulers)
3524
3525- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3526- Setting: `wrap_guides`
3527- Default: []
3528
3529**Options**
3530
3531List of `integer` column numbers
3532
3533## Tab Size
3534
3535- Description: The number of spaces to use for each tab character.
3536- Setting: `tab_size`
3537- Default: `4`
3538
3539**Options**
3540
3541`integer` values
3542
3543## Tasks
3544
3545- Description: Configuration for tasks that can be run within Zed
3546- Setting: `tasks`
3547- Default:
3548
3549```json [settings]
3550{
3551 "tasks": {
3552 "variables": {},
3553 "enabled": true,
3554 "prefer_lsp": false
3555 }
3556}
3557```
3558
3559**Options**
3560
3561- `variables`: Custom variables for task configuration
3562- `enabled`: Whether tasks are enabled
3563- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3564
3565## Telemetry
3566
3567- Description: Control what info is collected by Zed.
3568- Setting: `telemetry`
3569- Default:
3570
3571```json [settings]
3572"telemetry": {
3573 "diagnostics": true,
3574 "metrics": true
3575},
3576```
3577
3578**Options**
3579
3580### Diagnostics
3581
3582- Description: Setting for sending debug-related data, such as crash reports.
3583- Setting: `diagnostics`
3584- Default: `true`
3585
3586**Options**
3587
3588`boolean` values
3589
3590### Metrics
3591
3592- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3593- Setting: `metrics`
3594- Default: `true`
3595
3596**Options**
3597
3598`boolean` values
3599
3600## Terminal
3601
3602- Description: Configuration for the terminal.
3603- Setting: `terminal`
3604- Default:
3605
3606```json [settings]
3607{
3608 "terminal": {
3609 "alternate_scroll": "off",
3610 "blinking": "terminal_controlled",
3611 "copy_on_select": false,
3612 "keep_selection_on_copy": true,
3613 "dock": "bottom",
3614 "default_width": 640,
3615 "default_height": 320,
3616 "detect_venv": {
3617 "on": {
3618 "directories": [".env", "env", ".venv", "venv"],
3619 "activate_script": "default"
3620 }
3621 },
3622 "env": {},
3623 "font_family": null,
3624 "font_features": null,
3625 "font_size": null,
3626 "line_height": "comfortable",
3627 "minimum_contrast": 45,
3628 "option_as_meta": false,
3629 "button": true,
3630 "shell": "system",
3631 "scroll_multiplier": 3.0,
3632 "toolbar": {
3633 "breadcrumbs": false
3634 },
3635 "working_directory": "current_project_directory",
3636 "scrollbar": {
3637 "show": null
3638 }
3639 }
3640}
3641```
3642
3643### Terminal: Dock
3644
3645- Description: Control the position of the dock
3646- Setting: `dock`
3647- Default: `bottom`
3648
3649**Options**
3650
3651`"bottom"`, `"left"` or `"right"`
3652
3653### Terminal: Alternate Scroll
3654
3655- 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.
3656- Setting: `alternate_scroll`
3657- Default: `off`
3658
3659**Options**
3660
36611. Default alternate scroll mode to off
3662
3663```json [settings]
3664{
3665 "terminal": {
3666 "alternate_scroll": "off"
3667 }
3668}
3669```
3670
36712. Default alternate scroll mode to on
3672
3673```json [settings]
3674{
3675 "terminal": {
3676 "alternate_scroll": "on"
3677 }
3678}
3679```
3680
3681### Terminal: Blinking
3682
3683- Description: Set the cursor blinking behavior in the terminal
3684- Setting: `blinking`
3685- Default: `terminal_controlled`
3686
3687**Options**
3688
36891. Never blink the cursor, ignore the terminal mode
3690
3691```json [settings]
3692{
3693 "terminal": {
3694 "blinking": "off"
3695 }
3696}
3697```
3698
36992. Default the cursor blink to off, but allow the terminal to turn blinking on
3700
3701```json [settings]
3702{
3703 "terminal": {
3704 "blinking": "terminal_controlled"
3705 }
3706}
3707```
3708
37093. Always blink the cursor, ignore the terminal mode
3710
3711```json [settings]
3712{
3713 "terminal": {
3714 "blinking": "on"
3715 }
3716}
3717```
3718
3719### Terminal: Copy On Select
3720
3721- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3722- Setting: `copy_on_select`
3723- Default: `false`
3724
3725**Options**
3726
3727`boolean` values
3728
3729**Example**
3730
3731```json [settings]
3732{
3733 "terminal": {
3734 "copy_on_select": true
3735 }
3736}
3737```
3738
3739### Terminal: Cursor Shape
3740
3741- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3742- Setting: `cursor_shape`
3743- Default: `null` (defaults to block)
3744
3745**Options**
3746
37471. A block that surrounds the following character
3748
3749```json [settings]
3750{
3751 "terminal": {
3752 "cursor_shape": "block"
3753 }
3754}
3755```
3756
37572. A vertical bar
3758
3759```json [settings]
3760{
3761 "terminal": {
3762 "cursor_shape": "bar"
3763 }
3764}
3765```
3766
37673. An underline / underscore that runs along the following character
3768
3769```json [settings]
3770{
3771 "terminal": {
3772 "cursor_shape": "underline"
3773 }
3774}
3775```
3776
37774. A box drawn around the following character
3778
3779```json [settings]
3780{
3781 "terminal": {
3782 "cursor_shape": "hollow"
3783 }
3784}
3785```
3786
3787### Terminal: Keep Selection On Copy
3788
3789- Description: Whether or not to keep the selection in the terminal after copying text.
3790- Setting: `keep_selection_on_copy`
3791- Default: `true`
3792
3793**Options**
3794
3795`boolean` values
3796
3797**Example**
3798
3799```json [settings]
3800{
3801 "terminal": {
3802 "keep_selection_on_copy": false
3803 }
3804}
3805```
3806
3807### Terminal: Env
3808
3809- 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
3810- Setting: `env`
3811- Default: `{}`
3812
3813**Example**
3814
3815```json [settings]
3816{
3817 "terminal": {
3818 "env": {
3819 "ZED": "1",
3820 "KEY": "value1:value2"
3821 }
3822 }
3823}
3824```
3825
3826### Terminal: Font Size
3827
3828- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3829- Setting: `font_size`
3830- Default: `null`
3831
3832**Options**
3833
3834`integer` values
3835
3836```json [settings]
3837{
3838 "terminal": {
3839 "font_size": 15
3840 }
3841}
3842```
3843
3844### Terminal: Font Family
3845
3846- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3847- Setting: `font_family`
3848- Default: `null`
3849
3850**Options**
3851
3852The name of any font family installed on the user's system
3853
3854```json [settings]
3855{
3856 "terminal": {
3857 "font_family": "Berkeley Mono"
3858 }
3859}
3860```
3861
3862### Terminal: Font Features
3863
3864- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3865- Setting: `font_features`
3866- Default: `null`
3867- Platform: macOS and Windows.
3868
3869**Options**
3870
3871See Buffer Font Features
3872
3873```json [settings]
3874{
3875 "terminal": {
3876 "font_features": {
3877 "calt": false
3878 // See Buffer Font Features for more features
3879 }
3880 }
3881}
3882```
3883
3884### Terminal: Line Height
3885
3886- Description: Set the terminal's line height.
3887- Setting: `line_height`
3888- Default: `standard`
3889
3890**Options**
3891
38921. Use a line height that's `comfortable` for reading, 1.618.
3893
3894```json [settings]
3895{
3896 "terminal": {
3897 "line_height": "comfortable"
3898 }
3899}
3900```
3901
39022. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3903
3904```json [settings]
3905{
3906 "terminal": {
3907 "line_height": "standard"
3908 }
3909}
3910```
3911
39123. Use a custom line height.
3913
3914```json [settings]
3915{
3916 "terminal": {
3917 "line_height": {
3918 "custom": 2
3919 }
3920 }
3921}
3922```
3923
3924### Terminal: Minimum Contrast
3925
3926- Description: Controls the minimum contrast between foreground and background colors in the terminal. Uses the APCA (Accessible Perceptual Contrast Algorithm) for color adjustments. Set this to 0 to disable this feature.
3927- Setting: `minimum_contrast`
3928- Default: `45`
3929
3930**Options**
3931
3932`integer` values from 0 to 106. Common recommended values:
3933
3934- `0`: No contrast adjustment
3935- `45`: Minimum for large fluent text (default)
3936- `60`: Minimum for other content text
3937- `75`: Minimum for body text
3938- `90`: Preferred for body text
3939
3940```json [settings]
3941{
3942 "terminal": {
3943 "minimum_contrast": 45
3944 }
3945}
3946```
3947
3948### Terminal: Option As Meta
3949
3950- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
3951- Setting: `option_as_meta`
3952- Default: `false`
3953
3954**Options**
3955
3956`boolean` values
3957
3958```json [settings]
3959{
3960 "terminal": {
3961 "option_as_meta": true
3962 }
3963}
3964```
3965
3966### Terminal: Shell
3967
3968- Description: What shell to use when launching the terminal.
3969- Setting: `shell`
3970- Default: `system`
3971
3972**Options**
3973
39741. Use the system's default terminal configuration (usually the `/etc/passwd` file).
3975
3976```json [settings]
3977{
3978 "terminal": {
3979 "shell": "system"
3980 }
3981}
3982```
3983
39842. A program to launch:
3985
3986```json [settings]
3987{
3988 "terminal": {
3989 "shell": {
3990 "program": "sh"
3991 }
3992 }
3993}
3994```
3995
39963. A program with arguments:
3997
3998```json [settings]
3999{
4000 "terminal": {
4001 "shell": {
4002 "with_arguments": {
4003 "program": "/bin/bash",
4004 "args": ["--login"]
4005 }
4006 }
4007 }
4008}
4009```
4010
4011## Terminal: Detect Virtual Environments {#terminal-detect_venv}
4012
4013- 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.
4014- Setting: `detect_venv`
4015- Default:
4016
4017```json [settings]
4018{
4019 "terminal": {
4020 "detect_venv": {
4021 "on": {
4022 // Default directories to search for virtual environments, relative
4023 // to the current working directory. We recommend overriding this
4024 // in your project's settings, rather than globally.
4025 "directories": [".env", "env", ".venv", "venv"],
4026 // Can also be `csh`, `fish`, and `nushell`
4027 "activate_script": "default"
4028 }
4029 }
4030 }
4031}
4032```
4033
4034Disable with:
4035
4036```json [settings]
4037{
4038 "terminal": {
4039 "detect_venv": "off"
4040 }
4041}
4042```
4043
4044### Terminal: Scroll Multiplier
4045
4046- Description: The multiplier for scrolling speed in the terminal when using mouse wheel or trackpad.
4047- Setting: `scroll_multiplier`
4048- Default: `1.0`
4049
4050**Options**
4051
4052Positive floating point values. Values less than or equal to 0 will be clamped to a minimum of 0.01.
4053
4054**Example**
4055
4056```json
4057{
4058 "terminal": {
4059 "scroll_multiplier": 5.0
4060 }
4061}
4062```
4063
4064## Terminal: Toolbar
4065
4066- Description: Whether or not to show various elements in the terminal toolbar.
4067- Setting: `toolbar`
4068- Default:
4069
4070```json [settings]
4071{
4072 "terminal": {
4073 "toolbar": {
4074 "breadcrumbs": false
4075 }
4076 }
4077}
4078```
4079
4080**Options**
4081
4082At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
4083
4084If the terminal title is empty, the breadcrumbs won't be shown.
4085
4086The shell running in the terminal needs to be configured to emit the title.
4087
4088Example command to set the title: `echo -e "\e]2;New Title\007";`
4089
4090### Terminal: Button
4091
4092- Description: Control to show or hide the terminal button in the status bar
4093- Setting: `button`
4094- Default: `true`
4095
4096**Options**
4097
4098`boolean` values
4099
4100```json [settings]
4101{
4102 "terminal": {
4103 "button": false
4104 }
4105}
4106```
4107
4108### Terminal: Working Directory
4109
4110- Description: What working directory to use when launching the terminal.
4111- Setting: `working_directory`
4112- Default: `"current_project_directory"`
4113
4114**Options**
4115
41161. Use the current file's project directory. Fallback to the first project directory strategy if unsuccessful.
4117
4118```json [settings]
4119{
4120 "terminal": {
4121 "working_directory": "current_project_directory"
4122 }
4123}
4124```
4125
41262. Use the first project in this workspace's directory. Fallback to using this platform's home directory.
4127
4128```json [settings]
4129{
4130 "terminal": {
4131 "working_directory": "first_project_directory"
4132 }
4133}
4134```
4135
41363. Always use this platform's home directory if it can be found.
4137
4138```json [settings]
4139{
4140 "terminal": {
4141 "working_directory": "always_home"
4142 }
4143}
4144```
4145
41464. 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.
4147
4148```json [settings]
4149{
4150 "terminal": {
4151 "working_directory": {
4152 "always": {
4153 "directory": "~/zed/projects/"
4154 }
4155 }
4156 }
4157}
4158```
4159
4160### Terminal: Path Hyperlink Regexes
4161
4162- Description: Regexes used to identify path hyperlinks. The regexes can be specified in two forms - a single regex string, or an array of strings (which will be collected into a single multi-line regex string).
4163- Setting: `path_hyperlink_regexes`
4164- Default:
4165
4166```json [settings]
4167{
4168 "terminal": {
4169 "path_hyperlink_regexes": [
4170 // Python-style diagnostics
4171 "File \"(?<path>[^\"]+)\", line (?<line>[0-9]+)",
4172 // Common path syntax with optional line, column, description, trailing punctuation, or
4173 // surrounding symbols or quotes
4174 [
4175 "(?x)",
4176 "# optionally starts with 0-2 opening prefix symbols",
4177 "[({\\[<]{0,2}",
4178 "# which may be followed by an opening quote",
4179 "(?<quote>[\"'`])?",
4180 "# `path` is the shortest sequence of any non-space character",
4181 "(?<link>(?<path>[^ ]+?",
4182 " # which may end with a line and optionally a column,",
4183 " (?<line_column>:+[0-9]+(:[0-9]+)?|:?\\([0-9]+([,:][0-9]+)?\\))?",
4184 "))",
4185 "# which must be followed by a matching quote",
4186 "(?(<quote>)\\k<quote>)",
4187 "# and optionally a single closing symbol",
4188 "[)}\\]>]?",
4189 "# if line/column matched, may be followed by a description",
4190 "(?(<line_column>):[^ 0-9][^ ]*)?",
4191 "# which may be followed by trailing punctuation",
4192 "[.,:)}\\]>]*",
4193 "# and always includes trailing whitespace or end of line",
4194 "([ ]+|$)"
4195 ]
4196 ]
4197 }
4198}
4199```
4200
4201### Terminal: Path Hyperlink Timeout (ms)
4202
4203- Description: Maximum time to search for a path hyperlink. When set to 0, path hyperlinks are disabled.
4204- Setting: `path_hyperlink_timeout_ms`
4205- Default: `1`
4206
4207## REPL
4208
4209- Description: Repl settings.
4210- Setting: `repl`
4211- Default:
4212
4213```json [settings]
4214"repl": {
4215 // Maximum number of columns to keep in REPL's scrollback buffer.
4216 // Clamped with [20, 512] range.
4217 "max_columns": 128,
4218 // Maximum number of lines to keep in REPL's scrollback buffer.
4219 // Clamped with [4, 256] range.
4220 "max_lines": 32
4221},
4222```
4223
4224## Theme
4225
4226- 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.
4227- Setting: `theme`
4228- Default: `One Dark`
4229
4230### Theme Object
4231
4232- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4233- Setting: `theme`
4234- Default:
4235
4236```json [settings]
4237"theme": {
4238 "mode": "system",
4239 "dark": "One Dark",
4240 "light": "One Light"
4241},
4242```
4243
4244### Mode
4245
4246- Description: Specify theme mode.
4247- Setting: `mode`
4248- Default: `system`
4249
4250**Options**
4251
42521. Set the theme to dark mode
4253
4254```json [settings]
4255{
4256 "mode": "dark"
4257}
4258```
4259
42602. Set the theme to light mode
4261
4262```json [settings]
4263{
4264 "mode": "light"
4265}
4266```
4267
42683. Set the theme to system mode
4269
4270```json [settings]
4271{
4272 "mode": "system"
4273}
4274```
4275
4276### Dark
4277
4278- Description: The name of the dark Zed theme to use for the UI.
4279- Setting: `dark`
4280- Default: `One Dark`
4281
4282**Options**
4283
4284Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4285
4286### Light
4287
4288- Description: The name of the light Zed theme to use for the UI.
4289- Setting: `light`
4290- Default: `One Light`
4291
4292**Options**
4293
4294Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4295
4296## Title Bar
4297
4298- Description: Whether or not to show various elements in the title bar
4299- Setting: `title_bar`
4300- Default:
4301
4302```json [settings]
4303"title_bar": {
4304 "show_branch_icon": false,
4305 "show_branch_name": true,
4306 "show_project_items": true,
4307 "show_onboarding_banner": true,
4308 "show_user_picture": true,
4309 "show_user_menu": true,
4310 "show_sign_in": true,
4311 "show_menus": false
4312}
4313```
4314
4315**Options**
4316
4317- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4318- `show_branch_name`: Whether to show the branch name button in the titlebar
4319- `show_project_items`: Whether to show the project host and name in the titlebar
4320- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4321- `show_user_picture`: Whether to show user picture in the titlebar
4322- `show_user_menu`: Whether to show the user menu button in the titlebar (the one that displays your avatar by default and contains options like Settings, Keymap, Themes, etc.)
4323- `show_sign_in`: Whether to show the sign in button in the titlebar
4324- `show_menus`: Whether to show the menus in the titlebar
4325
4326## Vim
4327
4328- Description: Whether or not to enable vim mode.
4329- Setting: `vim_mode`
4330- Default: `false`
4331
4332## When Closing With No Tabs
4333
4334- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4335- Setting: `when_closing_with_no_tabs`
4336- Default: `"platform_default"`
4337
4338**Options**
4339
43401. Use platform default behavior:
4341
4342```json [settings]
4343{
4344 "when_closing_with_no_tabs": "platform_default"
4345}
4346```
4347
43482. Always close the window:
4349
4350```json [settings]
4351{
4352 "when_closing_with_no_tabs": "close_window"
4353}
4354```
4355
43563. Never close the window:
4357
4358```json [settings]
4359{
4360 "when_closing_with_no_tabs": "keep_window_open"
4361}
4362```
4363
4364## Project Panel
4365
4366- Description: Customize project panel
4367- Setting: `project_panel`
4368- Default:
4369
4370```json [settings]
4371{
4372 "project_panel": {
4373 "button": true,
4374 "default_width": 240,
4375 "dock": "left",
4376 "entry_spacing": "comfortable",
4377 "file_icons": true,
4378 "folder_icons": true,
4379 "git_status": true,
4380 "indent_size": 20,
4381 "auto_reveal_entries": true,
4382 "auto_fold_dirs": true,
4383 "drag_and_drop": true,
4384 "scrollbar": {
4385 "show": null
4386 },
4387 "sticky_scroll": true,
4388 "show_diagnostics": "all",
4389 "indent_guides": {
4390 "show": "always"
4391 },
4392 "sort_mode": "directories_first",
4393 "hide_root": false,
4394 "hide_hidden": false,
4395 "starts_open": true,
4396 "auto_open": {
4397 "on_create": true,
4398 "on_paste": true,
4399 "on_drop": true
4400 }
4401 }
4402}
4403```
4404
4405### Dock
4406
4407- Description: Control the position of the dock
4408- Setting: `dock`
4409- Default: `left`
4410
4411**Options**
4412
44131. Default dock position to left
4414
4415```json [settings]
4416{
4417 "dock": "left"
4418}
4419```
4420
44212. Default dock position to right
4422
4423```json [settings]
4424{
4425 "dock": "right"
4426}
4427```
4428
4429### Entry Spacing
4430
4431- Description: Spacing between worktree entries
4432- Setting: `entry_spacing`
4433- Default: `comfortable`
4434
4435**Options**
4436
44371. Comfortable entry spacing
4438
4439```json [settings]
4440{
4441 "entry_spacing": "comfortable"
4442}
4443```
4444
44452. Standard entry spacing
4446
4447```json [settings]
4448{
4449 "entry_spacing": "standard"
4450}
4451```
4452
4453### Git Status
4454
4455- Description: Indicates newly created and updated files
4456- Setting: `git_status`
4457- Default: `true`
4458
4459**Options**
4460
44611. Default enable git status
4462
4463```json [settings]
4464{
4465 "git_status": true
4466}
4467```
4468
44692. Default disable git status
4470
4471```json [settings]
4472{
4473 "git_status": false
4474}
4475```
4476
4477### Default Width
4478
4479- Description: Customize default width taken by project panel
4480- Setting: `default_width`
4481- Default: `240`
4482
4483**Options**
4484
4485`float` values
4486
4487### Auto Reveal Entries
4488
4489- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4490- Setting: `auto_reveal_entries`
4491- Default: `true`
4492
4493**Options**
4494
44951. Enable auto reveal entries
4496
4497```json [settings]
4498{
4499 "auto_reveal_entries": true
4500}
4501```
4502
45032. Disable auto reveal entries
4504
4505```json [settings]
4506{
4507 "auto_reveal_entries": false
4508}
4509```
4510
4511### Auto Fold Dirs
4512
4513- Description: Whether to fold directories automatically when directory has only one directory inside.
4514- Setting: `auto_fold_dirs`
4515- Default: `true`
4516
4517**Options**
4518
45191. Enable auto fold dirs
4520
4521```json [settings]
4522{
4523 "auto_fold_dirs": true
4524}
4525```
4526
45272. Disable auto fold dirs
4528
4529```json [settings]
4530{
4531 "auto_fold_dirs": false
4532}
4533```
4534
4535### Indent Size
4536
4537- Description: Amount of indentation (in pixels) for nested items.
4538- Setting: `indent_size`
4539- Default: `20`
4540
4541### Indent Guides: Show
4542
4543- Description: Whether to show indent guides in the project panel.
4544- Setting: `indent_guides`
4545- Default:
4546
4547```json [settings]
4548"indent_guides": {
4549 "show": "always"
4550}
4551```
4552
4553**Options**
4554
45551. Show indent guides in the project panel
4556
4557```json [settings]
4558{
4559 "indent_guides": {
4560 "show": "always"
4561 }
4562}
4563```
4564
45652. Hide indent guides in the project panel
4566
4567```json [settings]
4568{
4569 "indent_guides": {
4570 "show": "never"
4571 }
4572}
4573```
4574
4575### Scrollbar: Show
4576
4577- 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.
4578- Setting: `scrollbar`
4579- Default:
4580
4581```json [settings]
4582"scrollbar": {
4583 "show": null
4584}
4585```
4586
4587**Options**
4588
45891. Show scrollbar in the project panel
4590
4591```json [settings]
4592{
4593 "scrollbar": {
4594 "show": "always"
4595 }
4596}
4597```
4598
45992. Hide scrollbar in the project panel
4600
4601```json [settings]
4602{
4603 "scrollbar": {
4604 "show": "never"
4605 }
4606}
4607```
4608
4609### Sort Mode
4610
4611- Description: Sort order for entries in the project panel
4612- Setting: `sort_mode`
4613- Default: `directories_first`
4614
4615**Options**
4616
46171. Show directories first, then files
4618
4619```json [settings]
4620{
4621 "sort_mode": "directories_first"
4622}
4623```
4624
46252. Mix directories and files together
4626
4627```json [settings]
4628{
4629 "sort_mode": "mixed"
4630}
4631```
4632
46333. Show files first, then directories
4634
4635```json [settings]
4636{
4637 "sort_mode": "files_first"
4638}
4639```
4640
4641### Auto Open
4642
4643- Description: Control whether files are opened automatically after different creation flows in the project panel.
4644- Setting: `auto_open`
4645- Default:
4646
4647```json [settings]
4648"auto_open": {
4649 "on_create": true,
4650 "on_paste": true,
4651 "on_drop": true
4652}
4653```
4654
4655**Options**
4656
4657- `on_create`: Whether to automatically open newly created files in the editor.
4658- `on_paste`: Whether to automatically open files after pasting or duplicating them.
4659- `on_drop`: Whether to automatically open files dropped from external sources.
4660
4661## Agent
4662
4663Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4664
4665## Collaboration Panel
4666
4667- Description: Customizations for the collaboration panel.
4668- Setting: `collaboration_panel`
4669- Default:
4670
4671```json [settings]
4672{
4673 "collaboration_panel": {
4674 "button": true,
4675 "dock": "left",
4676 "default_width": 240
4677 }
4678}
4679```
4680
4681**Options**
4682
4683- `button`: Whether to show the collaboration panel button in the status bar
4684- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4685- `default_width`: Default width of the collaboration panel
4686
4687## Debugger
4688
4689- Description: Configuration for debugger panel and settings
4690- Setting: `debugger`
4691- Default:
4692
4693```json [settings]
4694{
4695 "debugger": {
4696 "stepping_granularity": "line",
4697 "save_breakpoints": true,
4698 "dock": "bottom",
4699 "button": true
4700 }
4701}
4702```
4703
4704See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4705
4706## Git Panel
4707
4708- Description: Setting to customize the behavior of the git panel.
4709- Setting: `git_panel`
4710- Default:
4711
4712```json [settings]
4713{
4714 "git_panel": {
4715 "button": true,
4716 "dock": "left",
4717 "default_width": 360,
4718 "status_style": "icon",
4719 "fallback_branch_name": "main",
4720 "sort_by_path": false,
4721 "collapse_untracked_diff": false,
4722 "scrollbar": {
4723 "show": null
4724 }
4725 }
4726}
4727```
4728
4729**Options**
4730
4731- `button`: Whether to show the git panel button in the status bar
4732- `dock`: Where to dock the git panel. Can be `left` or `right`
4733- `default_width`: Default width of the git panel
4734- `status_style`: How to display git status. Can be `label_color` or `icon`
4735- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4736- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4737- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4738- `scrollbar`: When to show the scrollbar in the git panel
4739
4740## Git Hosting Providers
4741
4742- Description: Register self-hosted GitHub, GitLab, or Bitbucket instances so commit hashes, issue references, and permalinks resolve to the right host.
4743- Setting: `git_hosting_providers`
4744- Default: `[]`
4745
4746**Options**
4747
4748Each entry accepts:
4749
4750- `provider`: One of `github`, `gitlab`, or `bitbucket`
4751- `name`: Display name for the instance
4752- `base_url`: Base URL, e.g. `https://git.example.corp`
4753
4754You can define these in user or project settings; project settings are merged on top of user settings.
4755
4756```json [settings]
4757{
4758 "git_hosting_providers": [
4759 {
4760 "provider": "github",
4761 "name": "BigCorp GitHub",
4762 "base_url": "https://git.example.corp"
4763 }
4764 ]
4765}
4766```
4767
4768## Outline Panel
4769
4770- Description: Customize outline Panel
4771- Setting: `outline_panel`
4772- Default:
4773
4774```json [settings]
4775"outline_panel": {
4776 "button": true,
4777 "default_width": 300,
4778 "dock": "left",
4779 "file_icons": true,
4780 "folder_icons": true,
4781 "git_status": true,
4782 "indent_size": 20,
4783 "auto_reveal_entries": true,
4784 "auto_fold_dirs": true,
4785 "indent_guides": {
4786 "show": "always"
4787 },
4788 "scrollbar": {
4789 "show": null
4790 }
4791}
4792```
4793
4794## Calls
4795
4796- Description: Customize behavior when participating in a call
4797- Setting: `calls`
4798- Default:
4799
4800```json [settings]
4801"calls": {
4802 // Join calls with the microphone live by default
4803 "mute_on_join": false,
4804 // Share your project when you are the first to join a channel
4805 "share_on_join": false
4806},
4807```
4808
4809## Colorize Brackets
4810
4811- Description: Whether to use tree-sitter bracket queries to detect and colorize the brackets in the editor (also known as "rainbow brackets").
4812- Setting: `colorize_brackets`
4813- Default: `false`
4814
4815**Options**
4816
4817`boolean` values
4818
4819The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
4820
4821## Unnecessary Code Fade
4822
4823- Description: How much to fade out unused code.
4824- Setting: `unnecessary_code_fade`
4825- Default: `0.3`
4826
4827**Options**
4828
4829Float values between `0.0` and `0.9`, where:
4830
4831- `0.0` means no fading (unused code looks the same as used code)
4832- `0.9` means maximum fading (unused code is very faint but still visible)
4833
4834**Example**
4835
4836```json [settings]
4837{
4838 "unnecessary_code_fade": 0.5
4839}
4840```
4841
4842## UI Font Family
4843
4844- Description: The name of the font to use for text in the UI.
4845- Setting: `ui_font_family`
4846- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4847
4848**Options**
4849
4850The name of any font family installed on the system, `".ZedSans"` to use the Zed-provided default, or `".SystemUIFont"` to use the system's default UI font (on macOS and Windows).
4851
4852## UI Font Features
4853
4854- Description: The OpenType features to enable for text in the UI.
4855- Setting: `ui_font_features`
4856- Default:
4857
4858```json [settings]
4859"ui_font_features": {
4860 "calt": false
4861}
4862```
4863
4864- Platform: macOS and Windows.
4865
4866**Options**
4867
4868Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4869
4870For example, to disable font ligatures, add the following to your settings:
4871
4872```json [settings]
4873{
4874 "ui_font_features": {
4875 "calt": false
4876 }
4877}
4878```
4879
4880You can also set other OpenType features, like setting `cv01` to `7`:
4881
4882```json [settings]
4883{
4884 "ui_font_features": {
4885 "cv01": 7
4886 }
4887}
4888```
4889
4890## UI Font Fallbacks
4891
4892- Description: The font fallbacks to use for text in the UI.
4893- Setting: `ui_font_fallbacks`
4894- Default: `null`
4895- Platform: macOS and Windows.
4896
4897**Options**
4898
4899For example, to use `Nerd Font` as a fallback, add the following to your settings:
4900
4901```json [settings]
4902{
4903 "ui_font_fallbacks": ["Nerd Font"]
4904}
4905```
4906
4907## UI Font Size
4908
4909- Description: The default font size for text in the UI.
4910- Setting: `ui_font_size`
4911- Default: `16`
4912
4913**Options**
4914
4915`integer` values from `6` to `100` pixels (inclusive)
4916
4917## UI Font Weight
4918
4919- Description: The default font weight for text in the UI.
4920- Setting: `ui_font_weight`
4921- Default: `400`
4922
4923**Options**
4924
4925`integer` values between `100` and `900`
4926
4927## Settings Profiles
4928
4929- Description: Configure any number of settings profiles that are temporarily applied on top of your existing user settings when selected from `settings profile selector: toggle`.
4930- Setting: `profiles`
4931- Default: `{}`
4932
4933In your `settings.json` file, add the `profiles` object.
4934Each key within this object is the name of a settings profile, and each value is an object that can include any of Zed's settings.
4935
4936Example:
4937
4938```json [settings]
4939"profiles": {
4940 "Presenting (Dark)": {
4941 "agent_buffer_font_size": 18.0,
4942 "buffer_font_size": 18.0,
4943 "theme": "One Dark",
4944 "ui_font_size": 18.0
4945 },
4946 "Presenting (Light)": {
4947 "agent_buffer_font_size": 18.0,
4948 "buffer_font_size": 18.0,
4949 "theme": "One Light",
4950 "ui_font_size": 18.0
4951 },
4952 "Writing": {
4953 "agent_buffer_font_size": 15.0,
4954 "buffer_font_size": 15.0,
4955 "theme": "Catppuccin Frappé - No Italics",
4956 "ui_font_size": 15.0,
4957 "tab_bar": { "show": false },
4958 "toolbar": { "breadcrumbs": false }
4959 }
4960}
4961```
4962
4963To preview and enable a settings profile, open the command palette via {#kb command_palette::Toggle} and search for `settings profile selector: toggle`.
4964
4965## An example configuration:
4966
4967```json [settings]
4968// ~/.config/zed/settings.json
4969{
4970 "theme": "cave-light",
4971 "tab_size": 2,
4972 "preferred_line_length": 80,
4973 "soft_wrap": "none",
4974
4975 "buffer_font_size": 18,
4976 "buffer_font_family": ".ZedMono",
4977
4978 "autosave": "on_focus_change",
4979 "format_on_save": "off",
4980 "vim_mode": false,
4981 "projects_online_by_default": true,
4982 "terminal": {
4983 "font_family": "FiraCode Nerd Font Mono",
4984 "blinking": "off"
4985 },
4986 "languages": {
4987 "C": {
4988 "format_on_save": "on",
4989 "formatter": "language_server",
4990 "preferred_line_length": 64,
4991 "soft_wrap": "preferred_line_length"
4992 }
4993 }
4994}
4995```