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_extension`
 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 two 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.
 591
 592## Double Click In Multibuffer
 593
 594- Description: What to do when multibuffer is double clicked in some of its excerpts (parts of singleton buffers)
 595- Setting: `double_click_in_multibuffer`
 596- Default: `"select"`
 597
 598**Options**
 599
 6001. Behave as a regular buffer and select the whole word (default):
 601
 602```json [settings]
 603{
 604  "double_click_in_multibuffer": "select"
 605}
 606```
 607
 6082. Open the excerpt clicked as a new buffer in the new tab:
 609
 610```json [settings]
 611{
 612  "double_click_in_multibuffer": "open"
 613}
 614```
 615
 616For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
 617
 618## Drop Target Size
 619
 620- 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.
 621- Setting: `drop_target_size`
 622- Default: `0.2`
 623
 624**Options**
 625
 626`float` values between `0` and `0.5`
 627
 628## Edit Predictions
 629
 630- Description: Settings for edit predictions.
 631- Setting: `edit_predictions`
 632- Default:
 633
 634```json [settings]
 635  "edit_predictions": {
 636    "disabled_globs": [
 637      "**/.env*",
 638      "**/*.pem",
 639      "**/*.key",
 640      "**/*.cert",
 641      "**/*.crt",
 642      "**/.dev.vars",
 643      "**/secrets.yml"
 644    ]
 645  }
 646```
 647
 648**Options**
 649
 650### Disabled Globs
 651
 652- 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.
 653- Setting: `disabled_globs`
 654- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/.dev.vars", "**/secrets.yml"]`
 655
 656**Options**
 657
 658List of `string` values.
 659
 660## Edit Predictions Disabled in
 661
 662- Description: A list of language scopes in which edit predictions should be disabled.
 663- Setting: `edit_predictions_disabled_in`
 664- Default: `[]`
 665
 666**Options**
 667
 668List of `string` values
 669
 6701. Don't show edit predictions in comments:
 671
 672```json [settings]
 673"disabled_in": ["comment"]
 674```
 675
 6762. Don't show edit predictions in strings and comments:
 677
 678```json [settings]
 679"disabled_in": ["comment", "string"]
 680```
 681
 6823. Only in Go, don't show edit predictions in strings and comments:
 683
 684```json [settings]
 685{
 686  "languages": {
 687    "Go": {
 688      "edit_predictions_disabled_in": ["comment", "string"]
 689    }
 690  }
 691}
 692```
 693
 694## Current Line Highlight
 695
 696- Description: How to highlight the current line in the editor.
 697- Setting: `current_line_highlight`
 698- Default: `all`
 699
 700**Options**
 701
 7021. Don't highlight the current line:
 703
 704```json [settings]
 705"current_line_highlight": "none"
 706```
 707
 7082. Highlight the gutter area:
 709
 710```json [settings]
 711"current_line_highlight": "gutter"
 712```
 713
 7143. Highlight the editor area:
 715
 716```json [settings]
 717"current_line_highlight": "line"
 718```
 719
 7204. Highlight the full line:
 721
 722```json [settings]
 723"current_line_highlight": "all"
 724```
 725
 726## Selection Highlight
 727
 728- Description: Whether to highlight all occurrences of the selected text in an editor.
 729- Setting: `selection_highlight`
 730- Default: `true`
 731
 732## Rounded Selection
 733
 734- Description: Whether the text selection should have rounded corners.
 735- Setting: `rounded_selection`
 736- Default: `true`
 737
 738## Cursor Blink
 739
 740- Description: Whether or not the cursor blinks.
 741- Setting: `cursor_blink`
 742- Default: `true`
 743
 744**Options**
 745
 746`boolean` values
 747
 748## Cursor Shape
 749
 750- Description: Cursor shape for the default editor.
 751- Setting: `cursor_shape`
 752- Default: `bar`
 753
 754**Options**
 755
 7561. A vertical bar:
 757
 758```json [settings]
 759"cursor_shape": "bar"
 760```
 761
 7622. A block that surrounds the following character:
 763
 764```json [settings]
 765"cursor_shape": "block"
 766```
 767
 7683. An underline / underscore that runs along the following character:
 769
 770```json [settings]
 771"cursor_shape": "underline"
 772```
 773
 7744. An box drawn around the following character:
 775
 776```json [settings]
 777"cursor_shape": "hollow"
 778```
 779
 780## Gutter
 781
 782- Description: Settings for the editor gutter
 783- Setting: `gutter`
 784- Default:
 785
 786```json [settings]
 787{
 788  "gutter": {
 789    "line_numbers": true,
 790    "runnables": true,
 791    "breakpoints": true,
 792    "folds": true,
 793    "min_line_number_digits": 4
 794  }
 795}
 796```
 797
 798**Options**
 799
 800- `line_numbers`: Whether to show line numbers in the gutter
 801- `runnables`: Whether to show runnable buttons in the gutter
 802- `breakpoints`: Whether to show breakpoints in the gutter
 803- `folds`: Whether to show fold buttons in the gutter
 804- `min_line_number_digits`: Minimum number of characters to reserve space for in the gutter
 805
 806## Hide Mouse
 807
 808- Description: Determines when the mouse cursor should be hidden in an editor or input box.
 809- Setting: `hide_mouse`
 810- Default: `on_typing_and_movement`
 811
 812**Options**
 813
 8141. Never hide the mouse cursor:
 815
 816```json [settings]
 817"hide_mouse": "never"
 818```
 819
 8202. Hide only when typing:
 821
 822```json [settings]
 823"hide_mouse": "on_typing"
 824```
 825
 8263. Hide on both typing and cursor movement:
 827
 828```json [settings]
 829"hide_mouse": "on_typing_and_movement"
 830```
 831
 832## Snippet Sort Order
 833
 834- Description: Determines how snippets are sorted relative to other completion items.
 835- Setting: `snippet_sort_order`
 836- Default: `inline`
 837
 838**Options**
 839
 8401. Place snippets at the top of the completion list:
 841
 842```json [settings]
 843"snippet_sort_order": "top"
 844```
 845
 8462. Place snippets normally without any preference:
 847
 848```json [settings]
 849"snippet_sort_order": "inline"
 850```
 851
 8523. Place snippets at the bottom of the completion list:
 853
 854```json [settings]
 855"snippet_sort_order": "bottom"
 856```
 857
 8584. Do not show snippets in the completion list at all:
 859
 860```json [settings]
 861"snippet_sort_order": "none"
 862```
 863
 864## Editor Scrollbar
 865
 866- Description: Whether or not to show the editor scrollbar and various elements in it.
 867- Setting: `scrollbar`
 868- Default:
 869
 870```json [settings]
 871"scrollbar": {
 872  "show": "auto",
 873  "cursors": true,
 874  "git_diff": true,
 875  "search_results": true,
 876  "selected_text": true,
 877  "selected_symbol": true,
 878  "diagnostics": "all",
 879  "axes": {
 880    "horizontal": true,
 881    "vertical": true,
 882  },
 883},
 884```
 885
 886### Show Mode
 887
 888- Description: When to show the editor scrollbar.
 889- Setting: `show`
 890- Default: `auto`
 891
 892**Options**
 893
 8941. Show the scrollbar if there's important information or follow the system's configured behavior:
 895
 896```json [settings]
 897"scrollbar": {
 898  "show": "auto"
 899}
 900```
 901
 9022. Match the system's configured behavior:
 903
 904```json [settings]
 905"scrollbar": {
 906  "show": "system"
 907}
 908```
 909
 9103. Always show the scrollbar:
 911
 912```json [settings]
 913"scrollbar": {
 914  "show": "always"
 915}
 916```
 917
 9184. Never show the scrollbar:
 919
 920```json [settings]
 921"scrollbar": {
 922  "show": "never"
 923}
 924```
 925
 926### Cursor Indicators
 927
 928- Description: Whether to show cursor positions in the scrollbar.
 929- Setting: `cursors`
 930- Default: `true`
 931
 932**Options**
 933
 934`boolean` values
 935
 936### Git Diff Indicators
 937
 938- Description: Whether to show git diff indicators in the scrollbar.
 939- Setting: `git_diff`
 940- Default: `true`
 941
 942**Options**
 943
 944`boolean` values
 945
 946### Search Results Indicators
 947
 948- Description: Whether to show buffer search results in the scrollbar.
 949- Setting: `search_results`
 950- Default: `true`
 951
 952**Options**
 953
 954`boolean` values
 955
 956### Selected Text Indicators
 957
 958- Description: Whether to show selected text occurrences in the scrollbar.
 959- Setting: `selected_text`
 960- Default: `true`
 961
 962**Options**
 963
 964`boolean` values
 965
 966### Selected Symbols Indicators
 967
 968- Description: Whether to show selected symbol occurrences in the scrollbar.
 969- Setting: `selected_symbol`
 970- Default: `true`
 971
 972**Options**
 973
 974`boolean` values
 975
 976### Diagnostics
 977
 978- Description: Which diagnostic indicators to show in the scrollbar.
 979- Setting: `diagnostics`
 980- Default: `all`
 981
 982**Options**
 983
 9841. Show all diagnostics:
 985
 986```json [settings]
 987{
 988  "show_diagnostics": "all"
 989}
 990```
 991
 9922. Do not show any diagnostics:
 993
 994```json [settings]
 995{
 996  "show_diagnostics": "off"
 997}
 998```
 999
10003. Show only errors:
1001
1002```json [settings]
1003{
1004  "show_diagnostics": "error"
1005}
1006```
1007
10084. Show only errors and warnings:
1009
1010```json [settings]
1011{
1012  "show_diagnostics": "warning"
1013}
1014```
1015
10165. Show only errors, warnings, and information:
1017
1018```json [settings]
1019{
1020  "show_diagnostics": "info"
1021}
1022```
1023
1024### Axes
1025
1026- Description: Forcefully enable or disable the scrollbar for each axis
1027- Setting: `axes`
1028- Default:
1029
1030```json [settings]
1031"scrollbar": {
1032  "axes": {
1033    "horizontal": true,
1034    "vertical": true,
1035  },
1036}
1037```
1038
1039#### Horizontal
1040
1041- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
1042- Setting: `horizontal`
1043- Default: `true`
1044
1045**Options**
1046
1047`boolean` values
1048
1049#### Vertical
1050
1051- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
1052- Setting: `vertical`
1053- Default: `true`
1054
1055**Options**
1056
1057`boolean` values
1058
1059## Minimap
1060
1061- Description: Settings related to the editor's minimap, which provides an overview of your document.
1062- Setting: `minimap`
1063- Default:
1064
1065```json [settings]
1066{
1067  "minimap": {
1068    "show": "never",
1069    "thumb": "always",
1070    "thumb_border": "left_open",
1071    "current_line_highlight": null
1072  }
1073}
1074```
1075
1076### Show Mode
1077
1078- Description: When to show the minimap in the editor.
1079- Setting: `show`
1080- Default: `never`
1081
1082**Options**
1083
10841. Always show the minimap:
1085
1086```json [settings]
1087{
1088  "show": "always"
1089}
1090```
1091
10922. Show the minimap if the editor's scrollbars are visible:
1093
1094```json [settings]
1095{
1096  "show": "auto"
1097}
1098```
1099
11003. Never show the minimap:
1101
1102```json [settings]
1103{
1104  "show": "never"
1105}
1106```
1107
1108### Thumb Display
1109
1110- Description: When to show the minimap thumb (the visible editor area) in the minimap.
1111- Setting: `thumb`
1112- Default: `always`
1113
1114**Options**
1115
11161. Show the minimap thumb when hovering over the minimap:
1117
1118```json [settings]
1119{
1120  "thumb": "hover"
1121}
1122```
1123
11242. Always show the minimap thumb:
1125
1126```json [settings]
1127{
1128  "thumb": "always"
1129}
1130```
1131
1132### Thumb Border
1133
1134- Description: How the minimap thumb border should look.
1135- Setting: `thumb_border`
1136- Default: `left_open`
1137
1138**Options**
1139
11401. Display a border on all sides of the thumb:
1141
1142```json [settings]
1143{
1144  "thumb_border": "full"
1145}
1146```
1147
11482. Display a border on all sides except the left side:
1149
1150```json [settings]
1151{
1152  "thumb_border": "left_open"
1153}
1154```
1155
11563. Display a border on all sides except the right side:
1157
1158```json [settings]
1159{
1160  "thumb_border": "right_open"
1161}
1162```
1163
11644. Display a border only on the left side:
1165
1166```json [settings]
1167{
1168  "thumb_border": "left_only"
1169}
1170```
1171
11725. Display the thumb without any border:
1173
1174```json [settings]
1175{
1176  "thumb_border": "none"
1177}
1178```
1179
1180### Current Line Highlight
1181
1182- Description: How to highlight the current line in the minimap.
1183- Setting: `current_line_highlight`
1184- Default: `null`
1185
1186**Options**
1187
11881. Inherit the editor's current line highlight setting:
1189
1190```json [settings]
1191{
1192  "minimap": {
1193    "current_line_highlight": null
1194  }
1195}
1196```
1197
11982. Highlight the current line in the minimap:
1199
1200```json [settings]
1201{
1202  "minimap": {
1203    "current_line_highlight": "line"
1204  }
1205}
1206```
1207
1208or
1209
1210```json [settings]
1211{
1212  "minimap": {
1213    "current_line_highlight": "all"
1214  }
1215}
1216```
1217
12183. Do not highlight the current line in the minimap:
1219
1220```json [settings]
1221{
1222  "minimap": {
1223    "current_line_highlight": "gutter"
1224  }
1225}
1226```
1227
1228or
1229
1230```json [settings]
1231{
1232  "minimap": {
1233    "current_line_highlight": "none"
1234  }
1235}
1236```
1237
1238## Editor Tab Bar
1239
1240- Description: Settings related to the editor's tab bar.
1241- Settings: `tab_bar`
1242- Default:
1243
1244```json [settings]
1245"tab_bar": {
1246  "show": true,
1247  "show_nav_history_buttons": true,
1248  "show_tab_bar_buttons": true
1249}
1250```
1251
1252### Show
1253
1254- Description: Whether or not to show the tab bar in the editor.
1255- Setting: `show`
1256- Default: `true`
1257
1258**Options**
1259
1260`boolean` values
1261
1262### Navigation History Buttons
1263
1264- Description: Whether or not to show the navigation history buttons.
1265- Setting: `show_nav_history_buttons`
1266- Default: `true`
1267
1268**Options**
1269
1270`boolean` values
1271
1272### Tab Bar Buttons
1273
1274- Description: Whether or not to show the tab bar buttons.
1275- Setting: `show_tab_bar_buttons`
1276- Default: `true`
1277
1278**Options**
1279
1280`boolean` values
1281
1282## Editor Tabs
1283
1284- Description: Configuration for the editor tabs.
1285- Setting: `tabs`
1286- Default:
1287
1288```json [settings]
1289"tabs": {
1290  "close_position": "right",
1291  "file_icons": false,
1292  "git_status": false,
1293  "activate_on_close": "history",
1294  "show_close_button": "hover",
1295  "show_diagnostics": "off"
1296},
1297```
1298
1299### Close Position
1300
1301- Description: Where to display close button within a tab.
1302- Setting: `close_position`
1303- Default: `right`
1304
1305**Options**
1306
13071. Display the close button on the right:
1308
1309```json [settings]
1310{
1311  "close_position": "right"
1312}
1313```
1314
13152. Display the close button on the left:
1316
1317```json [settings]
1318{
1319  "close_position": "left"
1320}
1321```
1322
1323### File Icons
1324
1325- Description: Whether to show the file icon for a tab.
1326- Setting: `file_icons`
1327- Default: `false`
1328
1329### Git Status
1330
1331- Description: Whether or not to show Git file status in tab.
1332- Setting: `git_status`
1333- Default: `false`
1334
1335### Activate on close
1336
1337- Description: What to do after closing the current tab.
1338- Setting: `activate_on_close`
1339- Default: `history`
1340
1341**Options**
1342
13431.  Activate the tab that was open previously:
1344
1345```json [settings]
1346{
1347  "activate_on_close": "history"
1348}
1349```
1350
13512. Activate the right neighbour tab if present:
1352
1353```json [settings]
1354{
1355  "activate_on_close": "neighbour"
1356}
1357```
1358
13593. Activate the left neighbour tab if present:
1360
1361```json [settings]
1362{
1363  "activate_on_close": "left_neighbour"
1364}
1365```
1366
1367### Show close button
1368
1369- Description: Controls the appearance behavior of the tab's close button.
1370- Setting: `show_close_button`
1371- Default: `hover`
1372
1373**Options**
1374
13751.  Show it just upon hovering the tab:
1376
1377```json [settings]
1378{
1379  "show_close_button": "hover"
1380}
1381```
1382
13832. Show it persistently:
1384
1385```json [settings]
1386{
1387  "show_close_button": "always"
1388}
1389```
1390
13913. Never show it, even if hovering it:
1392
1393```json [settings]
1394{
1395  "show_close_button": "hidden"
1396}
1397```
1398
1399### Show Diagnostics
1400
1401- 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.
1402- Setting: `show_diagnostics`
1403- Default: `off`
1404
1405**Options**
1406
14071. Do not mark any files:
1408
1409```json [settings]
1410{
1411  "show_diagnostics": "off"
1412}
1413```
1414
14152. Only mark files with errors:
1416
1417```json [settings]
1418{
1419  "show_diagnostics": "errors"
1420}
1421```
1422
14233. Mark files with errors and warnings:
1424
1425```json [settings]
1426{
1427  "show_diagnostics": "all"
1428}
1429```
1430
1431### Show Inline Code Actions
1432
1433- Description: Whether to show code action button at start of buffer line.
1434- Setting: `inline_code_actions`
1435- Default: `true`
1436
1437**Options**
1438
1439`boolean` values
1440
1441### Drag And Drop Selection
1442
1443- 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.
1444- Setting: `drag_and_drop_selection`
1445- Default:
1446
1447```json [settings]
1448"drag_and_drop_selection": {
1449  "enabled": true,
1450  "delay": 300
1451}
1452```
1453
1454## Editor Toolbar
1455
1456- Description: Whether or not to show various elements in the editor toolbar.
1457- Setting: `toolbar`
1458- Default:
1459
1460```json [settings]
1461"toolbar": {
1462  "breadcrumbs": true,
1463  "quick_actions": true,
1464  "selections_menu": true,
1465  "agent_review": true,
1466  "code_actions": false
1467},
1468```
1469
1470**Options**
1471
1472Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
1473
1474## Use System Tabs
1475
1476- Description: Whether to allow windows to tab together based on the user’s tabbing preference (macOS only).
1477- Setting: `use_system_window_tabs`
1478- Default: `false`
1479
1480**Options**
1481
1482This 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.
1483
1484## Enable Language Server
1485
1486- Description: Whether or not to use language servers to provide code intelligence.
1487- Setting: `enable_language_server`
1488- Default: `true`
1489
1490**Options**
1491
1492`boolean` values
1493
1494## Ensure Final Newline On Save
1495
1496- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
1497- Setting: `ensure_final_newline_on_save`
1498- Default: `true`
1499
1500**Options**
1501
1502`boolean` values
1503
1504## Expand Excerpt Lines
1505
1506- Description: The default number of lines to expand excerpts in the multibuffer by
1507- Setting: `expand_excerpt_lines`
1508- Default: `5`
1509
1510**Options**
1511
1512Positive `integer` values
1513
1514## Excerpt Context Lines
1515
1516- Description: The number of lines of context to provide when showing excerpts in the multibuffer.
1517- Setting: `excerpt_context_lines`
1518- Default: `2`
1519
1520**Options**
1521
1522Positive `integer` value between 1 and 32. Values outside of this range will be clamped to this range.
1523
1524## Extend Comment On Newline
1525
1526- Description: Whether to start a new line with a comment when a previous line is a comment as well.
1527- Setting: `extend_comment_on_newline`
1528- Default: `true`
1529
1530**Options**
1531
1532`boolean` values
1533
1534## Status Bar
1535
1536- Description: Control various elements in the status bar. Note that some items in the status bar have their own settings set elsewhere.
1537- Setting: `status_bar`
1538- Default:
1539
1540```json [settings]
1541"status_bar": {
1542  "active_language_button": true,
1543  "cursor_position_button": true,
1544  "line_endings_button": false
1545},
1546```
1547
1548There 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.
1549
1550```json
1551"status_bar": {
1552  "experimental.show": false
1553}
1554```
1555
1556## LSP
1557
1558- Description: Configuration for language servers.
1559- Setting: `lsp`
1560- Default: `null`
1561
1562**Options**
1563
1564The following settings can be overridden for specific language servers:
1565
1566- `initialization_options`
1567- `settings`
1568
1569To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1570
1571Some 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.
1572
1573For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1574
1575```json [settings]
1576"lsp": {
1577  "rust-analyzer": {
1578    "initialization_options": {
1579      "check": {
1580        "command": "clippy" // rust-analyzer.check.command (default: "check")
1581      }
1582    }
1583  }
1584}
1585```
1586
1587While other options may be changed at a runtime and should be placed under `settings`:
1588
1589```json [settings]
1590"lsp": {
1591  "yaml-language-server": {
1592    "settings": {
1593      "yaml": {
1594        "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1595      }
1596    }
1597  }
1598}
1599```
1600
1601## Global LSP Settings
1602
1603- Description: Configuration for global LSP settings that apply to all language servers
1604- Setting: `global_lsp_settings`
1605- Default:
1606
1607```json [settings]
1608{
1609  "global_lsp_settings": {
1610    "button": true
1611  }
1612}
1613```
1614
1615**Options**
1616
1617- `button`: Whether to show the LSP status button in the status bar
1618
1619## LSP Highlight Debounce
1620
1621- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1622- Setting: `lsp_highlight_debounce`
1623- Default: `75`
1624
1625**Options**
1626
1627`integer` values representing milliseconds
1628
1629## Features
1630
1631- Description: Features that can be globally enabled or disabled
1632- Setting: `features`
1633- Default:
1634
1635```json [settings]
1636{
1637  "features": {
1638    "edit_prediction_provider": "zed"
1639  }
1640}
1641```
1642
1643### Edit Prediction Provider
1644
1645- Description: Which edit prediction provider to use
1646- Setting: `edit_prediction_provider`
1647- Default: `"zed"`
1648
1649**Options**
1650
16511. Use Zeta as the edit prediction provider:
1652
1653```json [settings]
1654{
1655  "features": {
1656    "edit_prediction_provider": "zed"
1657  }
1658}
1659```
1660
16612. Use Copilot as the edit prediction provider:
1662
1663```json [settings]
1664{
1665  "features": {
1666    "edit_prediction_provider": "copilot"
1667  }
1668}
1669```
1670
16713. Use Supermaven as the edit prediction provider:
1672
1673```json [settings]
1674{
1675  "features": {
1676    "edit_prediction_provider": "supermaven"
1677  }
1678}
1679```
1680
16814. Turn off edit predictions across all providers
1682
1683```json [settings]
1684{
1685  "features": {
1686    "edit_prediction_provider": "none"
1687  }
1688}
1689```
1690
1691## Format On Save
1692
1693- Description: Whether or not to perform a buffer format before saving.
1694- Setting: `format_on_save`
1695- Default: `on`
1696
1697**Options**
1698
16991. `on`, enables format on save obeying `formatter` setting:
1700
1701```json [settings]
1702{
1703  "format_on_save": "on"
1704}
1705```
1706
17072. `off`, disables format on save:
1708
1709```json [settings]
1710{
1711  "format_on_save": "off"
1712}
1713```
1714
1715## Formatter
1716
1717- Description: How to perform a buffer format.
1718- Setting: `formatter`
1719- Default: `auto`
1720
1721**Options**
1722
17231. To use the current language server, use `"language_server"`:
1724
1725```json [settings]
1726{
1727  "formatter": "language_server"
1728}
1729```
1730
17312. 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):
1732
1733```json [settings]
1734{
1735  "formatter": {
1736    "external": {
1737      "command": "sed",
1738      "arguments": ["-e", "s/ *$//"]
1739    }
1740  }
1741}
1742```
1743
17443. 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.
1745
1746WARNING: `{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.
1747
1748```json [settings]
1749  "formatter": {
1750    "external": {
1751      "command": "prettier",
1752      "arguments": ["--stdin-filepath", "{buffer_path}"]
1753    }
1754  }
1755```
1756
17574. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1758
1759```json [settings]
1760{
1761  "formatter": [
1762    // Use ESLint's --fix:
1763    { "code_action": "source.fixAll.eslint" },
1764    // Organize imports on save:
1765    { "code_action": "source.organizeImports" }
1766  ]
1767}
1768```
1769
17705. Or to use multiple formatters consecutively, use an array of formatters:
1771
1772```json [settings]
1773{
1774  "formatter": [
1775    { "language_server": { "name": "rust-analyzer" } },
1776    {
1777      "external": {
1778        "command": "sed",
1779        "arguments": ["-e", "s/ *$//"]
1780      }
1781    }
1782  ]
1783}
1784```
1785
1786Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1787If any of the formatters fails, the subsequent ones will still be executed.
1788
1789## Auto close
1790
1791- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1792- Setting: `use_autoclose`
1793- Default: `true`
1794
1795**Options**
1796
1797`boolean` values
1798
1799## Always Treat Brackets As Autoclosed
1800
1801- Description: Controls how the editor handles the autoclosed characters.
1802- Setting: `always_treat_brackets_as_autoclosed`
1803- Default: `false`
1804
1805**Options**
1806
1807`boolean` values
1808
1809**Example**
1810
1811If the setting is set to `true`:
1812
18131. Enter in the editor: `)))`
18142. Move the cursor to the start: `^)))`
18153. Enter again: `)))`
1816
1817The result is still `)))` and not `))))))`, which is what it would be by default.
1818
1819## File Scan Exclusions
1820
1821- Setting: `file_scan_exclusions`
1822- 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`.
1823- Default:
1824
1825```json [settings]
1826"file_scan_exclusions": [
1827  "**/.git",
1828  "**/.svn",
1829  "**/.hg",
1830  "**/.jj",
1831  "**/CVS",
1832  "**/.DS_Store",
1833  "**/Thumbs.db",
1834  "**/.classpath",
1835  "**/.settings"
1836],
1837```
1838
1839Note, 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.
1840
1841## File Scan Inclusions
1842
1843- Setting: `file_scan_inclusions`
1844- 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.
1845- Default:
1846
1847```json [settings]
1848"file_scan_inclusions": [".env*"],
1849```
1850
1851## File Types
1852
1853- Setting: `file_types`
1854- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1855- Default:
1856
1857```json [settings]
1858"file_types": {
1859  "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1860  "Shell Script": [".env.*"]
1861}
1862```
1863
1864**Examples**
1865
1866To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1867
1868```json [settings]
1869{
1870  "file_types": {
1871    "C++": ["c"],
1872    "TOML": ["MyLockFile"],
1873    "Dockerfile": ["Dockerfile*"]
1874  }
1875}
1876```
1877
1878## Diagnostics
1879
1880- Description: Configuration for diagnostics-related features.
1881- Setting: `diagnostics`
1882- Default:
1883
1884```json [settings]
1885{
1886  "diagnostics": {
1887    "include_warnings": true,
1888    "inline": {
1889      "enabled": false
1890    },
1891    "update_with_cursor": false,
1892    "primary_only": false,
1893    "use_rendered": false
1894  }
1895}
1896```
1897
1898### Inline Diagnostics
1899
1900- Description: Whether or not to show diagnostics information inline.
1901- Setting: `inline`
1902- Default:
1903
1904```json [settings]
1905{
1906  "diagnostics": {
1907    "inline": {
1908      "enabled": false,
1909      "update_debounce_ms": 150,
1910      "padding": 4,
1911      "min_column": 0,
1912      "max_severity": null
1913    }
1914  }
1915}
1916```
1917
1918**Options**
1919
19201. Enable inline diagnostics.
1921
1922```json [settings]
1923{
1924  "diagnostics": {
1925    "inline": {
1926      "enabled": true
1927    }
1928  }
1929}
1930```
1931
19322. Delay diagnostic updates until some time after the last diagnostic update.
1933
1934```json [settings]
1935{
1936  "diagnostics": {
1937    "inline": {
1938      "enabled": true,
1939      "update_debounce_ms": 150
1940    }
1941  }
1942}
1943```
1944
19453. Set padding between the end of the source line and the start of the diagnostic.
1946
1947```json [settings]
1948{
1949  "diagnostics": {
1950    "inline": {
1951      "enabled": true,
1952      "padding": 4
1953    }
1954  }
1955}
1956```
1957
19584. Horizontally align inline diagnostics at the given column.
1959
1960```json [settings]
1961{
1962  "diagnostics": {
1963    "inline": {
1964      "enabled": true,
1965      "min_column": 80
1966    }
1967  }
1968}
1969```
1970
19715. Show only warning and error diagnostics.
1972
1973```json [settings]
1974{
1975  "diagnostics": {
1976    "inline": {
1977      "enabled": true,
1978      "max_severity": "warning"
1979    }
1980  }
1981}
1982```
1983
1984## Git
1985
1986- Description: Configuration for git-related features.
1987- Setting: `git`
1988- Default:
1989
1990```json [settings]
1991{
1992  "git": {
1993    "git_gutter": "tracked_files",
1994    "inline_blame": {
1995      "enabled": true
1996    },
1997    "branch_picker": {
1998      "show_author_name": true
1999    },
2000    "hunk_style": "staged_hollow"
2001  }
2002}
2003```
2004
2005### Git Gutter
2006
2007- Description: Whether or not to show the git gutter.
2008- Setting: `git_gutter`
2009- Default: `tracked_files`
2010
2011**Options**
2012
20131. Show git gutter in tracked files
2014
2015```json [settings]
2016{
2017  "git": {
2018    "git_gutter": "tracked_files"
2019  }
2020}
2021```
2022
20232. Hide git gutter
2024
2025```json [settings]
2026{
2027  "git": {
2028    "git_gutter": "hide"
2029  }
2030}
2031```
2032
2033### Gutter Debounce
2034
2035- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2036- Setting: `gutter_debounce`
2037- Default: `null`
2038
2039**Options**
2040
2041`integer` values representing milliseconds
2042
2043Example:
2044
2045```json [settings]
2046{
2047  "git": {
2048    "gutter_debounce": 100
2049  }
2050}
2051```
2052
2053### Inline Git Blame
2054
2055- Description: Whether or not to show git blame information inline, on the currently focused line.
2056- Setting: `inline_blame`
2057- Default:
2058
2059```json [settings]
2060{
2061  "git": {
2062    "inline_blame": {
2063      "enabled": true
2064    }
2065  }
2066}
2067```
2068
2069**Options**
2070
20711. Disable inline git blame:
2072
2073```json [settings]
2074{
2075  "git": {
2076    "inline_blame": {
2077      "enabled": false
2078    }
2079  }
2080}
2081```
2082
20832. Only show inline git blame after a delay (that starts after cursor stops moving):
2084
2085```json [settings]
2086{
2087  "git": {
2088    "inline_blame": {
2089      "delay_ms": 500
2090    }
2091  }
2092}
2093```
2094
20953. Show a commit summary next to the commit date and author:
2096
2097```json [settings]
2098{
2099  "git": {
2100    "inline_blame": {
2101      "show_commit_summary": true
2102    }
2103  }
2104}
2105```
2106
21074. Use this as the minimum column at which to display inline blame information:
2108
2109```json [settings]
2110{
2111  "git": {
2112    "inline_blame": {
2113      "min_column": 80
2114    }
2115  }
2116}
2117```
2118
21195. Set the padding between the end of the line and the inline blame hint, in ems:
2120
2121```json [settings]
2122{
2123  "git": {
2124    "inline_blame": {
2125      "padding": 10
2126    }
2127  }
2128}
2129```
2130
2131### Branch Picker
2132
2133- Description: Configuration related to the branch picker.
2134- Setting: `branch_picker`
2135- Default:
2136
2137```json [settings]
2138{
2139  "git": {
2140    "branch_picker": {
2141      "show_author_name": false
2142    }
2143  }
2144}
2145```
2146
2147**Options**
2148
21491. Show the author name in the branch picker:
2150
2151```json [settings]
2152{
2153  "git": {
2154    "branch_picker": {
2155      "show_author_name": true
2156    }
2157  }
2158}
2159```
2160
2161### Hunk Style
2162
2163- Description: What styling we should use for the diff hunks.
2164- Setting: `hunk_style`
2165- Default:
2166
2167```json [settings]
2168{
2169  "git": {
2170    "hunk_style": "staged_hollow"
2171  }
2172}
2173```
2174
2175**Options**
2176
21771. Show the staged hunks faded out and with a border:
2178
2179```json [settings]
2180{
2181  "git": {
2182    "hunk_style": "staged_hollow"
2183  }
2184}
2185```
2186
21872. Show unstaged hunks faded out and with a border:
2188
2189```json [settings]
2190{
2191  "git": {
2192    "hunk_style": "unstaged_hollow"
2193  }
2194}
2195```
2196
2197## Go to Definition Fallback
2198
2199- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2200- Setting: `go_to_definition_fallback`
2201- Default: `"find_all_references"`
2202
2203**Options**
2204
22051. Do nothing:
2206
2207```json [settings]
2208{
2209  "go_to_definition_fallback": "none"
2210}
2211```
2212
22132. Find references for the same symbol (default):
2214
2215```json [settings]
2216{
2217  "go_to_definition_fallback": "find_all_references"
2218}
2219```
2220
2221## Hard Tabs
2222
2223- Description: Whether to indent lines using tab characters or multiple spaces.
2224- Setting: `hard_tabs`
2225- Default: `false`
2226
2227**Options**
2228
2229`boolean` values
2230
2231## Helix Mode
2232
2233- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2234- Setting: `helix_mode`
2235- Default: `false`
2236
2237**Options**
2238
2239`boolean` values
2240
2241## Indent Guides
2242
2243- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2244- Setting: `indent_guides`
2245- Default:
2246
2247```json [settings]
2248{
2249  "indent_guides": {
2250    "enabled": true,
2251    "line_width": 1,
2252    "active_line_width": 1,
2253    "coloring": "fixed",
2254    "background_coloring": "disabled"
2255  }
2256}
2257```
2258
2259**Options**
2260
22611. Disable indent guides
2262
2263```json [settings]
2264{
2265  "indent_guides": {
2266    "enabled": false
2267  }
2268}
2269```
2270
22712. Enable indent guides for a specific language.
2272
2273```json [settings]
2274{
2275  "languages": {
2276    "Python": {
2277      "indent_guides": {
2278        "enabled": true
2279      }
2280    }
2281  }
2282}
2283```
2284
22853. Enable indent aware coloring ("rainbow indentation").
2286   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.
2287
2288```json [settings]
2289{
2290  "indent_guides": {
2291    "enabled": true,
2292    "coloring": "indent_aware"
2293  }
2294}
2295```
2296
22974. Enable indent aware background coloring ("rainbow indentation").
2298   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.
2299
2300```json [settings]
2301{
2302  "indent_guides": {
2303    "enabled": true,
2304    "coloring": "indent_aware",
2305    "background_coloring": "indent_aware"
2306  }
2307}
2308```
2309
2310## Hover Popover Enabled
2311
2312- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2313- Setting: `hover_popover_enabled`
2314- Default: `true`
2315
2316**Options**
2317
2318`boolean` values
2319
2320## Hover Popover Delay
2321
2322- Description: Time to wait in milliseconds before showing the informational hover box.
2323- Setting: `hover_popover_delay`
2324- Default: `300`
2325
2326**Options**
2327
2328`integer` values representing milliseconds
2329
2330## Icon Theme
2331
2332- 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.
2333- Setting: `icon_theme`
2334- Default: `Zed (Default)`
2335
2336### Icon Theme Object
2337
2338- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2339- Setting: `icon_theme`
2340- Default:
2341
2342```json [settings]
2343"icon_theme": {
2344  "mode": "system",
2345  "dark": "Zed (Default)",
2346  "light": "Zed (Default)"
2347},
2348```
2349
2350### Mode
2351
2352- Description: Specify the icon theme mode.
2353- Setting: `mode`
2354- Default: `system`
2355
2356**Options**
2357
23581. Set the icon theme to dark mode
2359
2360```json [settings]
2361{
2362  "mode": "dark"
2363}
2364```
2365
23662. Set the icon theme to light mode
2367
2368```json [settings]
2369{
2370  "mode": "light"
2371}
2372```
2373
23743. Set the icon theme to system mode
2375
2376```json [settings]
2377{
2378  "mode": "system"
2379}
2380```
2381
2382### Dark
2383
2384- Description: The name of the dark icon theme.
2385- Setting: `dark`
2386- Default: `Zed (Default)`
2387
2388**Options**
2389
2390Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2391
2392### Light
2393
2394- Description: The name of the light icon theme.
2395- Setting: `light`
2396- Default: `Zed (Default)`
2397
2398**Options**
2399
2400Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2401
2402## Image Viewer
2403
2404- Description: Settings for image viewer functionality
2405- Setting: `image_viewer`
2406- Default:
2407
2408```json [settings]
2409{
2410  "image_viewer": {
2411    "unit": "binary"
2412  }
2413}
2414```
2415
2416**Options**
2417
2418### Unit
2419
2420- Description: The unit for image file sizes
2421- Setting: `unit`
2422- Default: `"binary"`
2423
2424**Options**
2425
24261. Use binary units (KiB, MiB):
2427
2428```json [settings]
2429{
2430  "image_viewer": {
2431    "unit": "binary"
2432  }
2433}
2434```
2435
24362. Use decimal units (KB, MB):
2437
2438```json [settings]
2439{
2440  "image_viewer": {
2441    "unit": "decimal"
2442  }
2443}
2444```
2445
2446## Inlay hints
2447
2448- Description: Configuration for displaying extra text with hints in the editor.
2449- Setting: `inlay_hints`
2450- Default:
2451
2452```json [settings]
2453"inlay_hints": {
2454  "enabled": false,
2455  "show_type_hints": true,
2456  "show_parameter_hints": true,
2457  "show_other_hints": true,
2458  "show_background": false,
2459  "edit_debounce_ms": 700,
2460  "scroll_debounce_ms": 50,
2461  "toggle_on_modifiers_press": null
2462}
2463```
2464
2465**Options**
2466
2467Inlay hints querying consists of two parts: editor (client) and LSP server.
2468With 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.
2469At 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.
2470
2471The following languages have inlay hints preconfigured by Zed:
2472
2473- [Go](https://docs.zed.dev/languages/go)
2474- [Rust](https://docs.zed.dev/languages/rust)
2475- [Svelte](https://docs.zed.dev/languages/svelte)
2476- [TypeScript](https://docs.zed.dev/languages/typescript)
2477
2478Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2479
2480Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2481Settings-related hint updates are not debounced.
2482
2483All possible config values for `toggle_on_modifiers_press` are:
2484
2485```json [settings]
2486"inlay_hints": {
2487  "toggle_on_modifiers_press": {
2488    "control": true,
2489    "shift": true,
2490    "alt": true,
2491    "platform": true,
2492    "function": true
2493  }
2494}
2495```
2496
2497Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2498
2499## Journal
2500
2501- Description: Configuration for the journal.
2502- Setting: `journal`
2503- Default:
2504
2505```json [settings]
2506"journal": {
2507  "path": "~",
2508  "hour_format": "hour12"
2509}
2510```
2511
2512### Path
2513
2514- Description: The path of the directory where journal entries are stored.
2515- Setting: `path`
2516- Default: `~`
2517
2518**Options**
2519
2520`string` values
2521
2522### Hour Format
2523
2524- Description: The format to use for displaying hours in the journal.
2525- Setting: `hour_format`
2526- Default: `hour12`
2527
2528**Options**
2529
25301. 12-hour format:
2531
2532```json [settings]
2533{
2534  "hour_format": "hour12"
2535}
2536```
2537
25382. 24-hour format:
2539
2540```json [settings]
2541{
2542  "hour_format": "hour24"
2543}
2544```
2545
2546## JSX Tag Auto Close
2547
2548- Description: Whether to automatically close JSX tags
2549- Setting: `jsx_tag_auto_close`
2550- Default:
2551
2552```json [settings]
2553{
2554  "jsx_tag_auto_close": {
2555    "enabled": true
2556  }
2557}
2558```
2559
2560**Options**
2561
2562- `enabled`: Whether to enable automatic JSX tag closing
2563
2564## Languages
2565
2566- Description: Configuration for specific languages.
2567- Setting: `languages`
2568- Default: `null`
2569
2570**Options**
2571
2572To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2573
2574```json [settings]
2575"languages": {
2576  "C": {
2577    "format_on_save": "off",
2578    "preferred_line_length": 64,
2579    "soft_wrap": "preferred_line_length"
2580  },
2581  "JSON": {
2582    "tab_size": 4
2583  }
2584}
2585```
2586
2587The following settings can be overridden for each specific language:
2588
2589- [`enable_language_server`](#enable-language-server)
2590- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2591- [`format_on_save`](#format-on-save)
2592- [`formatter`](#formatter)
2593- [`hard_tabs`](#hard-tabs)
2594- [`preferred_line_length`](#preferred-line-length)
2595- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2596- [`show_edit_predictions`](#show-edit-predictions)
2597- [`show_whitespaces`](#show-whitespaces)
2598- [`whitespace_map`](#whitespace-map)
2599- [`soft_wrap`](#soft-wrap)
2600- [`tab_size`](#tab-size)
2601- [`use_autoclose`](#use-autoclose)
2602- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2603
2604These values take in the same options as the root-level settings with the same name.
2605
2606## Language Models
2607
2608- Description: Configuration for language model providers
2609- Setting: `language_models`
2610- Default:
2611
2612```json [settings]
2613{
2614  "language_models": {
2615    "anthropic": {
2616      "api_url": "https://api.anthropic.com"
2617    },
2618    "google": {
2619      "api_url": "https://generativelanguage.googleapis.com"
2620    },
2621    "ollama": {
2622      "api_url": "http://localhost:11434"
2623    },
2624    "openai": {
2625      "api_url": "https://api.openai.com/v1"
2626    }
2627  }
2628}
2629```
2630
2631**Options**
2632
2633Configuration for various AI model providers including API URLs and authentication settings.
2634
2635## Line Indicator Format
2636
2637- Description: Format for line indicator in the status bar
2638- Setting: `line_indicator_format`
2639- Default: `"short"`
2640
2641**Options**
2642
26431. Short format:
2644
2645```json [settings]
2646{
2647  "line_indicator_format": "short"
2648}
2649```
2650
26512. Long format:
2652
2653```json [settings]
2654{
2655  "line_indicator_format": "long"
2656}
2657```
2658
2659## Linked Edits
2660
2661- 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.
2662- Setting: `linked_edits`
2663- Default: `true`
2664
2665**Options**
2666
2667`boolean` values
2668
2669## LSP Document Colors
2670
2671- Description: Whether to show document color information from the language server
2672- Setting: `lsp_document_colors`
2673- Default: `true`
2674
2675**Options**
2676
2677`boolean` values
2678
2679## Max Tabs
2680
2681- Description: Maximum number of tabs to show in the tab bar
2682- Setting: `max_tabs`
2683- Default: `null`
2684
2685**Options**
2686
2687Positive `integer` values or `null` for unlimited tabs
2688
2689## Middle Click Paste (Linux only)
2690
2691- Description: Enable middle-click paste on Linux
2692- Setting: `middle_click_paste`
2693- Default: `true`
2694
2695**Options**
2696
2697`boolean` values
2698
2699## Multi Cursor Modifier
2700
2701- 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.
2702- Setting: `multi_cursor_modifier`
2703- Default: `alt`
2704
2705**Options**
2706
27071. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2708
2709```json [settings]
2710{
2711  "multi_cursor_modifier": "alt"
2712}
2713```
2714
27152. Maps `Control` on Linux and Windows and to `Command` on macOS:
2716
2717```json [settings]
2718{
2719  "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2720}
2721```
2722
2723## Node
2724
2725- Description: Configuration for Node.js integration
2726- Setting: `node`
2727- Default:
2728
2729```json [settings]
2730{
2731  "node": {
2732    "ignore_system_version": false,
2733    "path": null,
2734    "npm_path": null
2735  }
2736}
2737```
2738
2739**Options**
2740
2741- `ignore_system_version`: Whether to ignore the system Node.js version
2742- `path`: Custom path to Node.js binary
2743- `npm_path`: Custom path to npm binary
2744
2745## Network Proxy
2746
2747- Description: Configure a network proxy for Zed.
2748- Setting: `proxy`
2749- Default: `null`
2750
2751**Options**
2752
2753The proxy setting must contain a URL to the proxy.
2754
2755The following URI schemes are supported:
2756
2757- `http`
2758- `https`
2759- `socks4` - SOCKS4 proxy with local DNS
2760- `socks4a` - SOCKS4 proxy with remote DNS
2761- `socks5` - SOCKS5 proxy with local DNS
2762- `socks5h` - SOCKS5 proxy with remote DNS
2763
2764`http` will be used when no scheme is specified.
2765
2766By 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`.
2767
2768For example, to set an `http` proxy, add the following to your settings:
2769
2770```json [settings]
2771{
2772  "proxy": "http://127.0.0.1:10809"
2773}
2774```
2775
2776Or to set a `socks5` proxy:
2777
2778```json [settings]
2779{
2780  "proxy": "socks5h://localhost:10808"
2781}
2782```
2783
2784If 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.
2785
2786## On Last Window Closed
2787
2788- Description: What to do when the last window is closed
2789- Setting: `on_last_window_closed`
2790- Default: `"platform_default"`
2791
2792**Options**
2793
27941. Use platform default behavior:
2795
2796```json [settings]
2797{
2798  "on_last_window_closed": "platform_default"
2799}
2800```
2801
28022. Always quit the application:
2803
2804```json [settings]
2805{
2806  "on_last_window_closed": "quit_app"
2807}
2808```
2809
2810## Profiles
2811
2812- Description: Configuration profiles that can be applied on top of existing settings
2813- Setting: `profiles`
2814- Default: `{}`
2815
2816**Options**
2817
2818Configuration object for defining settings profiles. Example:
2819
2820```json [settings]
2821{
2822  "profiles": {
2823    "presentation": {
2824      "buffer_font_size": 20,
2825      "ui_font_size": 18,
2826      "theme": "One Light"
2827    }
2828  }
2829}
2830```
2831
2832## Preview tabs
2833
2834- Description:
2835  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. \
2836   There are several ways to convert a preview tab into a regular tab:
2837
2838  - Double-clicking on the file
2839  - Double-clicking on the tab header
2840  - Using the {#action project_panel::OpenPermanent} action
2841  - Editing the file
2842  - Dragging the file to a different pane
2843
2844- Setting: `preview_tabs`
2845- Default:
2846
2847```json [settings]
2848"preview_tabs": {
2849  "enabled": true,
2850  "enable_preview_from_file_finder": false,
2851  "enable_preview_from_code_navigation": false,
2852}
2853```
2854
2855### Enable preview from file finder
2856
2857- Description: Determines whether to open files in preview mode when selected from the file finder.
2858- Setting: `enable_preview_from_file_finder`
2859- Default: `false`
2860
2861**Options**
2862
2863`boolean` values
2864
2865### Enable preview from code navigation
2866
2867- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
2868- Setting: `enable_preview_from_code_navigation`
2869- Default: `false`
2870
2871**Options**
2872
2873`boolean` values
2874
2875## File Finder
2876
2877### File Icons
2878
2879- Description: Whether to show file icons in the file finder.
2880- Setting: `file_icons`
2881- Default: `true`
2882
2883### Modal Max Width
2884
2885- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2886- Setting: `modal_max_width`
2887- Default: `small`
2888
2889### Skip Focus For Active In Search
2890
2891- Description: Determines whether the file finder should skip focus for the active file in search results.
2892- Setting: `skip_focus_for_active_in_search`
2893- Default: `true`
2894
2895## Pane Split Direction Horizontal
2896
2897- Description: The direction that you want to split panes horizontally
2898- Setting: `pane_split_direction_horizontal`
2899- Default: `"up"`
2900
2901**Options**
2902
29031. Split upward:
2904
2905```json [settings]
2906{
2907  "pane_split_direction_horizontal": "up"
2908}
2909```
2910
29112. Split downward:
2912
2913```json [settings]
2914{
2915  "pane_split_direction_horizontal": "down"
2916}
2917```
2918
2919## Pane Split Direction Vertical
2920
2921- Description: The direction that you want to split panes vertically
2922- Setting: `pane_split_direction_vertical`
2923- Default: `"left"`
2924
2925**Options**
2926
29271. Split to the left:
2928
2929```json [settings]
2930{
2931  "pane_split_direction_vertical": "left"
2932}
2933```
2934
29352. Split to the right:
2936
2937```json [settings]
2938{
2939  "pane_split_direction_vertical": "right"
2940}
2941```
2942
2943## Preferred Line Length
2944
2945- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
2946- Setting: `preferred_line_length`
2947- Default: `80`
2948
2949**Options**
2950
2951`integer` values
2952
2953## Private Files
2954
2955- Description: Globs to match against file paths to determine if a file is private
2956- Setting: `private_files`
2957- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
2958
2959**Options**
2960
2961List of `string` glob patterns
2962
2963## Projects Online By Default
2964
2965- Description: Whether or not to show the online projects view by default.
2966- Setting: `projects_online_by_default`
2967- Default: `true`
2968
2969**Options**
2970
2971`boolean` values
2972
2973## Read SSH Config
2974
2975- Description: Whether to read SSH configuration files
2976- Setting: `read_ssh_config`
2977- Default: `true`
2978
2979**Options**
2980
2981`boolean` values
2982
2983## Redact Private Values
2984
2985- Description: Hide the values of variables from visual display in private files
2986- Setting: `redact_private_values`
2987- Default: `false`
2988
2989**Options**
2990
2991`boolean` values
2992
2993## Relative Line Numbers
2994
2995- Description: Whether to show relative line numbers in the gutter
2996- Setting: `relative_line_numbers`
2997- Default: `"disabled"`
2998
2999**Options**
3000
30011. Show relative line numbers in the gutter whilst counting wrapped lines as one line:
3002
3003```json [settings]
3004{
3005  "relative_line_numbers": "enabled"
3006}
3007```
3008
30092. Show relative line numbers in the gutter, including wrapped lines in the counting:
3010
3011```json [settings]
3012{
3013  "relative_line_numbers": "wrapped"
3014}
3015```
3016
30172. Do not use relative line numbers:
3018
3019```json [settings]
3020{
3021  "relative_line_numbers": "disabled"
3022}
3023```
3024
3025## Remove Trailing Whitespace On Save
3026
3027- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3028- Setting: `remove_trailing_whitespace_on_save`
3029- Default: `true`
3030
3031**Options**
3032
3033`boolean` values
3034
3035## Resize All Panels In Dock
3036
3037- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3038- Setting: `resize_all_panels_in_dock`
3039- Default: `["left"]`
3040
3041**Options**
3042
3043List of strings containing any combination of:
3044
3045- `"left"`: Resize left dock panels together
3046- `"right"`: Resize right dock panels together
3047- `"bottom"`: Resize bottom dock panels together
3048
3049## Restore on File Reopen
3050
3051- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3052- Setting: `restore_on_file_reopen`
3053- Default: `true`
3054
3055**Options**
3056
3057`boolean` values
3058
3059## Restore on Startup
3060
3061- Description: Controls session restoration on startup.
3062- Setting: `restore_on_startup`
3063- Default: `last_session`
3064
3065**Options**
3066
30671. Restore all workspaces that were open when quitting Zed:
3068
3069```json [settings]
3070{
3071  "restore_on_startup": "last_session"
3072}
3073```
3074
30752. Restore the workspace that was closed last:
3076
3077```json [settings]
3078{
3079  "restore_on_startup": "last_workspace"
3080}
3081```
3082
30833. Always start with an empty editor:
3084
3085```json [settings]
3086{
3087  "restore_on_startup": "none"
3088}
3089```
3090
3091## Scroll Beyond Last Line
3092
3093- Description: Whether the editor will scroll beyond the last line
3094- Setting: `scroll_beyond_last_line`
3095- Default: `"one_page"`
3096
3097**Options**
3098
30991. Scroll one page beyond the last line by one page:
3100
3101```json [settings]
3102{
3103  "scroll_beyond_last_line": "one_page"
3104}
3105```
3106
31072. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3108
3109```json [settings]
3110{
3111  "scroll_beyond_last_line": "vertical_scroll_margin"
3112}
3113```
3114
31153. The editor will not scroll beyond the last line:
3116
3117```json [settings]
3118{
3119  "scroll_beyond_last_line": "off"
3120}
3121```
3122
3123**Options**
3124
3125`boolean` values
3126
3127## Scroll Sensitivity
3128
3129- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3130- Setting: `scroll_sensitivity`
3131- Default: `1.0`
3132
3133**Options**
3134
3135Positive `float` values
3136
3137### Fast Scroll Sensitivity
3138
3139- 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.
3140- Setting: `fast_scroll_sensitivity`
3141- Default: `4.0`
3142
3143**Options**
3144
3145Positive `float` values
3146
3147### Horizontal Scroll Margin
3148
3149- Description: The number of characters to keep on either side when scrolling with the mouse
3150- Setting: `horizontal_scroll_margin`
3151- Default: `5`
3152
3153**Options**
3154
3155Non-negative `integer` values
3156
3157### Vertical Scroll Margin
3158
3159- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3160- Setting: `vertical_scroll_margin`
3161- Default: `3`
3162
3163**Options**
3164
3165Non-negative `integer` values
3166
3167## Search
3168
3169- Description: Search options to enable by default when opening new project and buffer searches.
3170- Setting: `search`
3171- Default:
3172
3173```json [settings]
3174"search": {
3175  "whole_word": false,
3176  "case_sensitive": false,
3177  "include_ignored": false,
3178  "regex": false
3179},
3180```
3181
3182## Search Wrap
3183
3184- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3185- Setting: `search_wrap`
3186- Default: `true`
3187
3188## Center on Match
3189
3190- Description: If `center_on_match` is enabled, the editor will center the cursor on the current match when searching.
3191- Setting: `center_on_match`
3192- Default: `false`
3193
3194## Seed Search Query From Cursor
3195
3196- Description: When to populate a new search's query based on the text under the cursor.
3197- Setting: `seed_search_query_from_cursor`
3198- Default: `always`
3199
3200**Options**
3201
32021. `always` always populate the search query with the word under the cursor
32032. `selection` only populate the search query when there is text selected
32043. `never` never populate the search query
3205
3206## Use Smartcase Search
3207
3208- 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. \
3209  This applies to both in-file searches and project-wide searches.
3210- Setting: `use_smartcase_search`
3211- Default: `false`
3212
3213**Options**
3214
3215`boolean` values
3216
3217Examples:
3218
3219- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3220- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3221
3222## Show Call Status Icon
3223
3224- Description: Whether or not to show the call status icon in the status bar.
3225- Setting: `show_call_status_icon`
3226- Default: `true`
3227
3228**Options**
3229
3230`boolean` values
3231
3232## Completions
3233
3234- Description: Controls how completions are processed for this language.
3235- Setting: `completions`
3236- Default:
3237
3238```json [settings]
3239{
3240  "completions": {
3241    "words": "fallback",
3242    "words_min_length": 3,
3243    "lsp": true,
3244    "lsp_fetch_timeout_ms": 0,
3245    "lsp_insert_mode": "replace_suffix"
3246  }
3247}
3248```
3249
3250### Words
3251
3252- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3253- Setting: `words`
3254- Default: `fallback`
3255
3256**Options**
3257
32581. `enabled` - Always fetch document's words for completions along with LSP completions
32592. `fallback` - Only if LSP response errors or times out, use document's words to show completions
32603. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3261
3262### Min Words Query Length
3263
3264- Description: Minimum number of characters required to automatically trigger word-based completions.
3265  Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3266- Setting: `words_min_length`
3267- Default: `3`
3268
3269**Options**
3270
3271Positive integer values
3272
3273### LSP
3274
3275- Description: Whether to fetch LSP completions or not.
3276- Setting: `lsp`
3277- Default: `true`
3278
3279**Options**
3280
3281`boolean` values
3282
3283### LSP Fetch Timeout (ms)
3284
3285- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3286- Setting: `lsp_fetch_timeout_ms`
3287- Default: `0`
3288
3289**Options**
3290
3291`integer` values representing milliseconds
3292
3293### LSP Insert Mode
3294
3295- Description: Controls what range to replace when accepting LSP completions.
3296- Setting: `lsp_insert_mode`
3297- Default: `replace_suffix`
3298
3299**Options**
3300
33011. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
33022. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
33033. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
33044. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3305
3306## Show Completions On Input
3307
3308- Description: Whether or not to show completions as you type.
3309- Setting: `show_completions_on_input`
3310- Default: `true`
3311
3312**Options**
3313
3314`boolean` values
3315
3316## Show Completion Documentation
3317
3318- Description: Whether to display inline and alongside documentation for items in the completions menu.
3319- Setting: `show_completion_documentation`
3320- Default: `true`
3321
3322**Options**
3323
3324`boolean` values
3325
3326## Show Edit Predictions
3327
3328- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3329- Setting: `show_edit_predictions`
3330- Default: `true`
3331
3332**Options**
3333
3334`boolean` values
3335
3336## Show Whitespaces
3337
3338- Description: Whether or not to render whitespace characters in the editor.
3339- Setting: `show_whitespaces`
3340- Default: `selection`
3341
3342**Options**
3343
33441. `all`
33452. `selection`
33463. `none`
33474. `boundary`
3348
3349## Whitespace Map
3350
3351- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3352- Setting: `whitespace_map`
3353- Default:
3354
3355```json [settings]
3356{
3357  "whitespace_map": {
3358    "space": "•",
3359    "tab": "→"
3360  }
3361}
3362```
3363
3364## Soft Wrap
3365
3366- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3367- Setting: `soft_wrap`
3368- Default: `none`
3369
3370**Options**
3371
33721. `none` to avoid wrapping generally, unless the line is too long
33732. `prefer_line` (deprecated, same as `none`)
33743. `editor_width` to wrap lines that overflow the editor width
33754. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
33765. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3377
3378## Show Wrap Guides
3379
3380- 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.
3381- Setting: `show_wrap_guides`
3382- Default: `true`
3383
3384**Options**
3385
3386`boolean` values
3387
3388## Use On Type Format
3389
3390- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3391- Setting: `use_on_type_format`
3392- Default: `true`
3393
3394**Options**
3395
3396`boolean` values
3397
3398## Use Auto Surround
3399
3400- 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 ().
3401- Setting: `use_auto_surround`
3402- Default: `true`
3403
3404**Options**
3405
3406`boolean` values
3407
3408## Use System Path Prompts
3409
3410- 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.
3411- Setting: `use_system_path_prompts`
3412- Default: `true`
3413
3414**Options**
3415
3416`boolean` values
3417
3418## Use System Prompts
3419
3420- 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.
3421- Setting: `use_system_prompts`
3422- Default: `true`
3423
3424**Options**
3425
3426`boolean` values
3427
3428## Wrap Guides (Vertical Rulers)
3429
3430- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3431- Setting: `wrap_guides`
3432- Default: []
3433
3434**Options**
3435
3436List of `integer` column numbers
3437
3438## Tab Size
3439
3440- Description: The number of spaces to use for each tab character.
3441- Setting: `tab_size`
3442- Default: `4`
3443
3444**Options**
3445
3446`integer` values
3447
3448## Tasks
3449
3450- Description: Configuration for tasks that can be run within Zed
3451- Setting: `tasks`
3452- Default:
3453
3454```json [settings]
3455{
3456  "tasks": {
3457    "variables": {},
3458    "enabled": true,
3459    "prefer_lsp": false
3460  }
3461}
3462```
3463
3464**Options**
3465
3466- `variables`: Custom variables for task configuration
3467- `enabled`: Whether tasks are enabled
3468- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3469
3470## Telemetry
3471
3472- Description: Control what info is collected by Zed.
3473- Setting: `telemetry`
3474- Default:
3475
3476```json [settings]
3477"telemetry": {
3478  "diagnostics": true,
3479  "metrics": true
3480},
3481```
3482
3483**Options**
3484
3485### Diagnostics
3486
3487- Description: Setting for sending debug-related data, such as crash reports.
3488- Setting: `diagnostics`
3489- Default: `true`
3490
3491**Options**
3492
3493`boolean` values
3494
3495### Metrics
3496
3497- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3498- Setting: `metrics`
3499- Default: `true`
3500
3501**Options**
3502
3503`boolean` values
3504
3505## Terminal
3506
3507- Description: Configuration for the terminal.
3508- Setting: `terminal`
3509- Default:
3510
3511```json [settings]
3512{
3513  "terminal": {
3514    "alternate_scroll": "off",
3515    "blinking": "terminal_controlled",
3516    "copy_on_select": false,
3517    "keep_selection_on_copy": true,
3518    "dock": "bottom",
3519    "default_width": 640,
3520    "default_height": 320,
3521    "detect_venv": {
3522      "on": {
3523        "directories": [".env", "env", ".venv", "venv"],
3524        "activate_script": "default"
3525      }
3526    },
3527    "env": {},
3528    "font_family": null,
3529    "font_features": null,
3530    "font_size": null,
3531    "line_height": "comfortable",
3532    "minimum_contrast": 45,
3533    "option_as_meta": false,
3534    "button": true,
3535    "shell": "system",
3536    "toolbar": {
3537      "breadcrumbs": false
3538    },
3539    "working_directory": "current_project_directory",
3540    "scrollbar": {
3541      "show": null
3542    }
3543  }
3544}
3545```
3546
3547### Terminal: Dock
3548
3549- Description: Control the position of the dock
3550- Setting: `dock`
3551- Default: `bottom`
3552
3553**Options**
3554
3555`"bottom"`, `"left"` or `"right"`
3556
3557### Terminal: Alternate Scroll
3558
3559- 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.
3560- Setting: `alternate_scroll`
3561- Default: `off`
3562
3563**Options**
3564
35651. Default alternate scroll mode to off
3566
3567```json [settings]
3568{
3569  "terminal": {
3570    "alternate_scroll": "off"
3571  }
3572}
3573```
3574
35752. Default alternate scroll mode to on
3576
3577```json [settings]
3578{
3579  "terminal": {
3580    "alternate_scroll": "on"
3581  }
3582}
3583```
3584
3585### Terminal: Blinking
3586
3587- Description: Set the cursor blinking behavior in the terminal
3588- Setting: `blinking`
3589- Default: `terminal_controlled`
3590
3591**Options**
3592
35931. Never blink the cursor, ignore the terminal mode
3594
3595```json [settings]
3596{
3597  "terminal": {
3598    "blinking": "off"
3599  }
3600}
3601```
3602
36032. Default the cursor blink to off, but allow the terminal to turn blinking on
3604
3605```json [settings]
3606{
3607  "terminal": {
3608    "blinking": "terminal_controlled"
3609  }
3610}
3611```
3612
36133. Always blink the cursor, ignore the terminal mode
3614
3615```json [settings]
3616{
3617  "terminal": {
3618    "blinking": "on"
3619  }
3620}
3621```
3622
3623### Terminal: Copy On Select
3624
3625- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3626- Setting: `copy_on_select`
3627- Default: `false`
3628
3629**Options**
3630
3631`boolean` values
3632
3633**Example**
3634
3635```json [settings]
3636{
3637  "terminal": {
3638    "copy_on_select": true
3639  }
3640}
3641```
3642
3643### Terminal: Cursor Shape
3644
3645- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3646- Setting: `cursor_shape`
3647- Default: `null` (defaults to block)
3648
3649**Options**
3650
36511. A block that surrounds the following character
3652
3653```json [settings]
3654{
3655  "terminal": {
3656    "cursor_shape": "block"
3657  }
3658}
3659```
3660
36612. A vertical bar
3662
3663```json [settings]
3664{
3665  "terminal": {
3666    "cursor_shape": "bar"
3667  }
3668}
3669```
3670
36713. An underline / underscore that runs along the following character
3672
3673```json [settings]
3674{
3675  "terminal": {
3676    "cursor_shape": "underline"
3677  }
3678}
3679```
3680
36814. A box drawn around the following character
3682
3683```json [settings]
3684{
3685  "terminal": {
3686    "cursor_shape": "hollow"
3687  }
3688}
3689```
3690
3691### Terminal: Keep Selection On Copy
3692
3693- Description: Whether or not to keep the selection in the terminal after copying text.
3694- Setting: `keep_selection_on_copy`
3695- Default: `true`
3696
3697**Options**
3698
3699`boolean` values
3700
3701**Example**
3702
3703```json [settings]
3704{
3705  "terminal": {
3706    "keep_selection_on_copy": false
3707  }
3708}
3709```
3710
3711### Terminal: Env
3712
3713- 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
3714- Setting: `env`
3715- Default: `{}`
3716
3717**Example**
3718
3719```json [settings]
3720{
3721  "terminal": {
3722    "env": {
3723      "ZED": "1",
3724      "KEY": "value1:value2"
3725    }
3726  }
3727}
3728```
3729
3730### Terminal: Font Size
3731
3732- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3733- Setting: `font_size`
3734- Default: `null`
3735
3736**Options**
3737
3738`integer` values
3739
3740```json [settings]
3741{
3742  "terminal": {
3743    "font_size": 15
3744  }
3745}
3746```
3747
3748### Terminal: Font Family
3749
3750- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3751- Setting: `font_family`
3752- Default: `null`
3753
3754**Options**
3755
3756The name of any font family installed on the user's system
3757
3758```json [settings]
3759{
3760  "terminal": {
3761    "font_family": "Berkeley Mono"
3762  }
3763}
3764```
3765
3766### Terminal: Font Features
3767
3768- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3769- Setting: `font_features`
3770- Default: `null`
3771- Platform: macOS and Windows.
3772
3773**Options**
3774
3775See Buffer Font Features
3776
3777```json [settings]
3778{
3779  "terminal": {
3780    "font_features": {
3781      "calt": false
3782      // See Buffer Font Features for more features
3783    }
3784  }
3785}
3786```
3787
3788### Terminal: Line Height
3789
3790- Description: Set the terminal's line height.
3791- Setting: `line_height`
3792- Default: `standard`
3793
3794**Options**
3795
37961. Use a line height that's `comfortable` for reading, 1.618.
3797
3798```json [settings]
3799{
3800  "terminal": {
3801    "line_height": "comfortable"
3802  }
3803}
3804```
3805
38062. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3807
3808```json [settings]
3809{
3810  "terminal": {
3811    "line_height": "standard"
3812  }
3813}
3814```
3815
38163.  Use a custom line height.
3817
3818```json [settings]
3819{
3820  "terminal": {
3821    "line_height": {
3822      "custom": 2
3823    }
3824  }
3825}
3826```
3827
3828### Terminal: Minimum Contrast
3829
3830- 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.
3831- Setting: `minimum_contrast`
3832- Default: `45`
3833
3834**Options**
3835
3836`integer` values from 0 to 106. Common recommended values:
3837
3838- `0`: No contrast adjustment
3839- `45`: Minimum for large fluent text (default)
3840- `60`: Minimum for other content text
3841- `75`: Minimum for body text
3842- `90`: Preferred for body text
3843
3844```json [settings]
3845{
3846  "terminal": {
3847    "minimum_contrast": 45
3848  }
3849}
3850```
3851
3852### Terminal: Option As Meta
3853
3854- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
3855- Setting: `option_as_meta`
3856- Default: `false`
3857
3858**Options**
3859
3860`boolean` values
3861
3862```json [settings]
3863{
3864  "terminal": {
3865    "option_as_meta": true
3866  }
3867}
3868```
3869
3870### Terminal: Shell
3871
3872- Description: What shell to use when launching the terminal.
3873- Setting: `shell`
3874- Default: `system`
3875
3876**Options**
3877
38781. Use the system's default terminal configuration (usually the `/etc/passwd` file).
3879
3880```json [settings]
3881{
3882  "terminal": {
3883    "shell": "system"
3884  }
3885}
3886```
3887
38882. A program to launch:
3889
3890```json [settings]
3891{
3892  "terminal": {
3893    "shell": {
3894      "program": "sh"
3895    }
3896  }
3897}
3898```
3899
39003. A program with arguments:
3901
3902```json [settings]
3903{
3904  "terminal": {
3905    "shell": {
3906      "with_arguments": {
3907        "program": "/bin/bash",
3908        "args": ["--login"]
3909      }
3910    }
3911  }
3912}
3913```
3914
3915## Terminal: Detect Virtual Environments {#terminal-detect_venv}
3916
3917- 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.
3918- Setting: `detect_venv`
3919- Default:
3920
3921```json [settings]
3922{
3923  "terminal": {
3924    "detect_venv": {
3925      "on": {
3926        // Default directories to search for virtual environments, relative
3927        // to the current working directory. We recommend overriding this
3928        // in your project's settings, rather than globally.
3929        "directories": [".env", "env", ".venv", "venv"],
3930        // Can also be `csh`, `fish`, and `nushell`
3931        "activate_script": "default"
3932      }
3933    }
3934  }
3935}
3936```
3937
3938Disable with:
3939
3940```json [settings]
3941{
3942  "terminal": {
3943    "detect_venv": "off"
3944  }
3945}
3946```
3947
3948## Terminal: Toolbar
3949
3950- Description: Whether or not to show various elements in the terminal toolbar.
3951- Setting: `toolbar`
3952- Default:
3953
3954```json [settings]
3955{
3956  "terminal": {
3957    "toolbar": {
3958      "breadcrumbs": false
3959    }
3960  }
3961}
3962```
3963
3964**Options**
3965
3966At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
3967
3968If the terminal title is empty, the breadcrumbs won't be shown.
3969
3970The shell running in the terminal needs to be configured to emit the title.
3971
3972Example command to set the title: `echo -e "\e]2;New Title\007";`
3973
3974### Terminal: Button
3975
3976- Description: Control to show or hide the terminal button in the status bar
3977- Setting: `button`
3978- Default: `true`
3979
3980**Options**
3981
3982`boolean` values
3983
3984```json [settings]
3985{
3986  "terminal": {
3987    "button": false
3988  }
3989}
3990```
3991
3992### Terminal: Working Directory
3993
3994- Description: What working directory to use when launching the terminal.
3995- Setting: `working_directory`
3996- Default: `"current_project_directory"`
3997
3998**Options**
3999
40001. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
4001
4002```json [settings]
4003{
4004  "terminal": {
4005    "working_directory": "current_project_directory"
4006  }
4007}
4008```
4009
40102. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
4011
4012```json [settings]
4013{
4014  "terminal": {
4015    "working_directory": "first_project_directory"
4016  }
4017}
4018```
4019
40203. Always use this platform's home directory (if we can find it)
4021
4022```json [settings]
4023{
4024  "terminal": {
4025    "working_directory": "always_home"
4026  }
4027}
4028```
4029
40304. 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.
4031
4032```json [settings]
4033{
4034  "terminal": {
4035    "working_directory": {
4036      "always": {
4037        "directory": "~/zed/projects/"
4038      }
4039    }
4040  }
4041}
4042```
4043
4044## REPL
4045
4046- Description: Repl settings.
4047- Setting: `repl`
4048- Default:
4049
4050```json [settings]
4051"repl": {
4052  // Maximum number of columns to keep in REPL's scrollback buffer.
4053  // Clamped with [20, 512] range.
4054  "max_columns": 128,
4055  // Maximum number of lines to keep in REPL's scrollback buffer.
4056  // Clamped with [4, 256] range.
4057  "max_lines": 32
4058},
4059```
4060
4061## Theme
4062
4063- 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.
4064- Setting: `theme`
4065- Default: `One Dark`
4066
4067### Theme Object
4068
4069- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4070- Setting: `theme`
4071- Default:
4072
4073```json [settings]
4074"theme": {
4075  "mode": "system",
4076  "dark": "One Dark",
4077  "light": "One Light"
4078},
4079```
4080
4081### Mode
4082
4083- Description: Specify theme mode.
4084- Setting: `mode`
4085- Default: `system`
4086
4087**Options**
4088
40891. Set the theme to dark mode
4090
4091```json [settings]
4092{
4093  "mode": "dark"
4094}
4095```
4096
40972. Set the theme to light mode
4098
4099```json [settings]
4100{
4101  "mode": "light"
4102}
4103```
4104
41053. Set the theme to system mode
4106
4107```json [settings]
4108{
4109  "mode": "system"
4110}
4111```
4112
4113### Dark
4114
4115- Description: The name of the dark Zed theme to use for the UI.
4116- Setting: `dark`
4117- Default: `One Dark`
4118
4119**Options**
4120
4121Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4122
4123### Light
4124
4125- Description: The name of the light Zed theme to use for the UI.
4126- Setting: `light`
4127- Default: `One Light`
4128
4129**Options**
4130
4131Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4132
4133## Title Bar
4134
4135- Description: Whether or not to show various elements in the title bar
4136- Setting: `title_bar`
4137- Default:
4138
4139```json [settings]
4140"title_bar": {
4141  "show_branch_icon": false,
4142  "show_branch_name": true,
4143  "show_project_items": true,
4144  "show_onboarding_banner": true,
4145  "show_user_picture": true,
4146  "show_sign_in": true,
4147  "show_menus": false
4148}
4149```
4150
4151**Options**
4152
4153- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4154- `show_branch_name`: Whether to show the branch name button in the titlebar
4155- `show_project_items`: Whether to show the project host and name in the titlebar
4156- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4157- `show_user_picture`: Whether to show user picture in the titlebar
4158- `show_sign_in`: Whether to show the sign in button in the titlebar
4159- `show_menus`: Whether to show the menus in the titlebar
4160
4161## Vim
4162
4163- Description: Whether or not to enable vim mode.
4164- Setting: `vim_mode`
4165- Default: `false`
4166
4167## When Closing With No Tabs
4168
4169- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4170- Setting: `when_closing_with_no_tabs`
4171- Default: `"platform_default"`
4172
4173**Options**
4174
41751. Use platform default behavior:
4176
4177```json [settings]
4178{
4179  "when_closing_with_no_tabs": "platform_default"
4180}
4181```
4182
41832. Always close the window:
4184
4185```json [settings]
4186{
4187  "when_closing_with_no_tabs": "close_window"
4188}
4189```
4190
41913. Never close the window:
4192
4193```json [settings]
4194{
4195  "when_closing_with_no_tabs": "keep_window_open"
4196}
4197```
4198
4199## Project Panel
4200
4201- Description: Customize project panel
4202- Setting: `project_panel`
4203- Default:
4204
4205```json [settings]
4206{
4207  "project_panel": {
4208    "button": true,
4209    "default_width": 240,
4210    "dock": "left",
4211    "entry_spacing": "comfortable",
4212    "file_icons": true,
4213    "folder_icons": true,
4214    "git_status": true,
4215    "indent_size": 20,
4216    "auto_reveal_entries": true,
4217    "auto_fold_dirs": true,
4218    "drag_and_drop": true,
4219    "scrollbar": {
4220      "show": null
4221    },
4222    "sticky_scroll": true,
4223    "show_diagnostics": "all",
4224    "indent_guides": {
4225      "show": "always"
4226    },
4227    "hide_root": false,
4228    "hide_hidden": false,
4229    "starts_open": true,
4230    "open_file_on_paste": true
4231  }
4232}
4233```
4234
4235### Dock
4236
4237- Description: Control the position of the dock
4238- Setting: `dock`
4239- Default: `left`
4240
4241**Options**
4242
42431. Default dock position to left
4244
4245```json [settings]
4246{
4247  "dock": "left"
4248}
4249```
4250
42512. Default dock position to right
4252
4253```json [settings]
4254{
4255  "dock": "right"
4256}
4257```
4258
4259### Entry Spacing
4260
4261- Description: Spacing between worktree entries
4262- Setting: `entry_spacing`
4263- Default: `comfortable`
4264
4265**Options**
4266
42671. Comfortable entry spacing
4268
4269```json [settings]
4270{
4271  "entry_spacing": "comfortable"
4272}
4273```
4274
42752. Standard entry spacing
4276
4277```json [settings]
4278{
4279  "entry_spacing": "standard"
4280}
4281```
4282
4283### Git Status
4284
4285- Description: Indicates newly created and updated files
4286- Setting: `git_status`
4287- Default: `true`
4288
4289**Options**
4290
42911. Default enable git status
4292
4293```json [settings]
4294{
4295  "git_status": true
4296}
4297```
4298
42992. Default disable git status
4300
4301```json [settings]
4302{
4303  "git_status": false
4304}
4305```
4306
4307### Default Width
4308
4309- Description: Customize default width taken by project panel
4310- Setting: `default_width`
4311- Default: `240`
4312
4313**Options**
4314
4315`float` values
4316
4317### Auto Reveal Entries
4318
4319- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4320- Setting: `auto_reveal_entries`
4321- Default: `true`
4322
4323**Options**
4324
43251. Enable auto reveal entries
4326
4327```json [settings]
4328{
4329  "auto_reveal_entries": true
4330}
4331```
4332
43332. Disable auto reveal entries
4334
4335```json [settings]
4336{
4337  "auto_reveal_entries": false
4338}
4339```
4340
4341### Auto Fold Dirs
4342
4343- Description: Whether to fold directories automatically when directory has only one directory inside.
4344- Setting: `auto_fold_dirs`
4345- Default: `true`
4346
4347**Options**
4348
43491. Enable auto fold dirs
4350
4351```json [settings]
4352{
4353  "auto_fold_dirs": true
4354}
4355```
4356
43572. Disable auto fold dirs
4358
4359```json [settings]
4360{
4361  "auto_fold_dirs": false
4362}
4363```
4364
4365### Indent Size
4366
4367- Description: Amount of indentation (in pixels) for nested items.
4368- Setting: `indent_size`
4369- Default: `20`
4370
4371### Indent Guides: Show
4372
4373- Description: Whether to show indent guides in the project panel.
4374- Setting: `indent_guides`
4375- Default:
4376
4377```json [settings]
4378"indent_guides": {
4379  "show": "always"
4380}
4381```
4382
4383**Options**
4384
43851. Show indent guides in the project panel
4386
4387```json [settings]
4388{
4389  "indent_guides": {
4390    "show": "always"
4391  }
4392}
4393```
4394
43952. Hide indent guides in the project panel
4396
4397```json [settings]
4398{
4399  "indent_guides": {
4400    "show": "never"
4401  }
4402}
4403```
4404
4405### Scrollbar: Show
4406
4407- 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.
4408- Setting: `scrollbar`
4409- Default:
4410
4411```json [settings]
4412"scrollbar": {
4413  "show": null
4414}
4415```
4416
4417**Options**
4418
44191. Show scrollbar in the project panel
4420
4421```json [settings]
4422{
4423  "scrollbar": {
4424    "show": "always"
4425  }
4426}
4427```
4428
44292. Hide scrollbar in the project panel
4430
4431```json [settings]
4432{
4433  "scrollbar": {
4434    "show": "never"
4435  }
4436}
4437```
4438
4439## Agent
4440
4441Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4442
4443## Collaboration Panel
4444
4445- Description: Customizations for the collaboration panel.
4446- Setting: `collaboration_panel`
4447- Default:
4448
4449```json [settings]
4450{
4451  "collaboration_panel": {
4452    "button": true,
4453    "dock": "left",
4454    "default_width": 240
4455  }
4456}
4457```
4458
4459**Options**
4460
4461- `button`: Whether to show the collaboration panel button in the status bar
4462- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4463- `default_width`: Default width of the collaboration panel
4464
4465## Debugger
4466
4467- Description: Configuration for debugger panel and settings
4468- Setting: `debugger`
4469- Default:
4470
4471```json [settings]
4472{
4473  "debugger": {
4474    "stepping_granularity": "line",
4475    "save_breakpoints": true,
4476    "dock": "bottom",
4477    "button": true
4478  }
4479}
4480```
4481
4482See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4483
4484## Git Panel
4485
4486- Description: Setting to customize the behavior of the git panel.
4487- Setting: `git_panel`
4488- Default:
4489
4490```json [settings]
4491{
4492  "git_panel": {
4493    "button": true,
4494    "dock": "left",
4495    "default_width": 360,
4496    "status_style": "icon",
4497    "fallback_branch_name": "main",
4498    "sort_by_path": false,
4499    "collapse_untracked_diff": false,
4500    "scrollbar": {
4501      "show": null
4502    }
4503  }
4504}
4505```
4506
4507**Options**
4508
4509- `button`: Whether to show the git panel button in the status bar
4510- `dock`: Where to dock the git panel. Can be `left` or `right`
4511- `default_width`: Default width of the git panel
4512- `status_style`: How to display git status. Can be `label_color` or `icon`
4513- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4514- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4515- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4516- `scrollbar`: When to show the scrollbar in the git panel
4517
4518## Outline Panel
4519
4520- Description: Customize outline Panel
4521- Setting: `outline_panel`
4522- Default:
4523
4524```json [settings]
4525"outline_panel": {
4526  "button": true,
4527  "default_width": 300,
4528  "dock": "left",
4529  "file_icons": true,
4530  "folder_icons": true,
4531  "git_status": true,
4532  "indent_size": 20,
4533  "auto_reveal_entries": true,
4534  "auto_fold_dirs": true,
4535  "indent_guides": {
4536    "show": "always"
4537  },
4538  "scrollbar": {
4539    "show": null
4540  }
4541}
4542```
4543
4544## Calls
4545
4546- Description: Customize behavior when participating in a call
4547- Setting: `calls`
4548- Default:
4549
4550```json [settings]
4551"calls": {
4552  // Join calls with the microphone live by default
4553  "mute_on_join": false,
4554  // Share your project when you are the first to join a channel
4555  "share_on_join": false
4556},
4557```
4558
4559## Unnecessary Code Fade
4560
4561- Description: How much to fade out unused code.
4562- Setting: `unnecessary_code_fade`
4563- Default: `0.3`
4564
4565**Options**
4566
4567Float values between `0.0` and `0.9`, where:
4568
4569- `0.0` means no fading (unused code looks the same as used code)
4570- `0.9` means maximum fading (unused code is very faint but still visible)
4571
4572**Example**
4573
4574```json [settings]
4575{
4576  "unnecessary_code_fade": 0.5
4577}
4578```
4579
4580## UI Font Family
4581
4582- Description: The name of the font to use for text in the UI.
4583- Setting: `ui_font_family`
4584- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4585
4586**Options**
4587
4588The 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).
4589
4590## UI Font Features
4591
4592- Description: The OpenType features to enable for text in the UI.
4593- Setting: `ui_font_features`
4594- Default:
4595
4596```json [settings]
4597"ui_font_features": {
4598  "calt": false
4599}
4600```
4601
4602- Platform: macOS and Windows.
4603
4604**Options**
4605
4606Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4607
4608For example, to disable font ligatures, add the following to your settings:
4609
4610```json [settings]
4611{
4612  "ui_font_features": {
4613    "calt": false
4614  }
4615}
4616```
4617
4618You can also set other OpenType features, like setting `cv01` to `7`:
4619
4620```json [settings]
4621{
4622  "ui_font_features": {
4623    "cv01": 7
4624  }
4625}
4626```
4627
4628## UI Font Fallbacks
4629
4630- Description: The font fallbacks to use for text in the UI.
4631- Setting: `ui_font_fallbacks`
4632- Default: `null`
4633- Platform: macOS and Windows.
4634
4635**Options**
4636
4637For example, to use `Nerd Font` as a fallback, add the following to your settings:
4638
4639```json [settings]
4640{
4641  "ui_font_fallbacks": ["Nerd Font"]
4642}
4643```
4644
4645## UI Font Size
4646
4647- Description: The default font size for text in the UI.
4648- Setting: `ui_font_size`
4649- Default: `16`
4650
4651**Options**
4652
4653`integer` values from `6` to `100` pixels (inclusive)
4654
4655## UI Font Weight
4656
4657- Description: The default font weight for text in the UI.
4658- Setting: `ui_font_weight`
4659- Default: `400`
4660
4661**Options**
4662
4663`integer` values between `100` and `900`
4664
4665## Settings Profiles
4666
4667- 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`.
4668- Setting: `profiles`
4669- Default: `{}`
4670
4671In your `settings.json` file, add the `profiles` object.
4672Each 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.
4673
4674Example:
4675
4676```json [settings]
4677"profiles": {
4678  "Presenting (Dark)": {
4679    "agent_buffer_font_size": 18.0,
4680    "buffer_font_size": 18.0,
4681    "theme": "One Dark",
4682    "ui_font_size": 18.0
4683  },
4684  "Presenting (Light)": {
4685    "agent_buffer_font_size": 18.0,
4686    "buffer_font_size": 18.0,
4687    "theme": "One Light",
4688    "ui_font_size": 18.0
4689  },
4690  "Writing": {
4691    "agent_buffer_font_size": 15.0,
4692    "buffer_font_size": 15.0,
4693    "theme": "Catppuccin Frappé - No Italics",
4694    "ui_font_size": 15.0,
4695    "tab_bar": { "show": false },
4696    "toolbar": { "breadcrumbs": false }
4697  }
4698}
4699```
4700
4701To preview and enable a settings profile, open the command palette via {#kb command_palette::Toggle} and search for `settings profile selector: toggle`.
4702
4703## An example configuration:
4704
4705```json [settings]
4706// ~/.config/zed/settings.json
4707{
4708  "theme": "cave-light",
4709  "tab_size": 2,
4710  "preferred_line_length": 80,
4711  "soft_wrap": "none",
4712
4713  "buffer_font_size": 18,
4714  "buffer_font_family": ".ZedMono",
4715
4716  "autosave": "on_focus_change",
4717  "format_on_save": "off",
4718  "vim_mode": false,
4719  "projects_online_by_default": true,
4720  "terminal": {
4721    "font_family": "FiraCode Nerd Font Mono",
4722    "blinking": "off"
4723  },
4724  "languages": {
4725    "C": {
4726      "format_on_save": "on",
4727      "formatter": "language_server",
4728      "preferred_line_length": 64,
4729      "soft_wrap": "preferred_line_length"
4730    }
4731  }
4732}
4733```