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