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