configuring-zed.md

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