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