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