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