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## Use System Tabs
1425
1426- Description: Whether to allow windows to tab together based on the user’s tabbing preference (macOS only).
1427- Setting: `use_system_window_tabs`
1428- Default: `false`
1429
1430**Options**
1431
1432This setting enables integration with macOS’s native window tabbing feature. When set to `true`, Zed windows can be grouped together as tabs in a single macOS window, following the system-wide tabbing preferences set by the user (such as "Always", "In Full Screen", or "Never"). This setting is only available on macOS.
1433
1434## Enable Language Server
1435
1436- Description: Whether or not to use language servers to provide code intelligence.
1437- Setting: `enable_language_server`
1438- Default: `true`
1439
1440**Options**
1441
1442`boolean` values
1443
1444## Ensure Final Newline On Save
1445
1446- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
1447- Setting: `ensure_final_newline_on_save`
1448- Default: `true`
1449
1450**Options**
1451
1452`boolean` values
1453
1454## Expand Excerpt Lines
1455
1456- Description: The default number of lines to expand excerpts in the multibuffer by
1457- Setting: `expand_excerpt_lines`
1458- Default: `5`
1459
1460**Options**
1461
1462Positive `integer` values
1463
1464## Extend Comment On Newline
1465
1466- Description: Whether to start a new line with a comment when a previous line is a comment as well.
1467- Setting: `extend_comment_on_newline`
1468- Default: `true`
1469
1470**Options**
1471
1472`boolean` values
1473
1474## Status Bar
1475
1476- Description: Control various elements in the status bar. Note that some items in the status bar have their own settings set elsewhere.
1477- Setting: `status_bar`
1478- Default:
1479
1480```json
1481"status_bar": {
1482  "active_language_button": true,
1483  "cursor_position_button": true
1484},
1485```
1486
1487## LSP
1488
1489- Description: Configuration for language servers.
1490- Setting: `lsp`
1491- Default: `null`
1492
1493**Options**
1494
1495The following settings can be overridden for specific language servers:
1496
1497- `initialization_options`
1498- `settings`
1499
1500To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1501
1502Some 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.
1503
1504For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1505
1506```json
1507"lsp": {
1508  "rust-analyzer": {
1509    "initialization_options": {
1510      "check": {
1511        "command": "clippy" // rust-analyzer.check.command (default: "check")
1512      }
1513    }
1514  }
1515}
1516```
1517
1518While other options may be changed at a runtime and should be placed under `settings`:
1519
1520```json
1521"lsp": {
1522  "yaml-language-server": {
1523    "settings": {
1524      "yaml": {
1525        "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1526      }
1527    }
1528  }
1529}
1530```
1531
1532## Global LSP Settings
1533
1534- Description: Configuration for global LSP settings that apply to all language servers
1535- Setting: `global_lsp_settings`
1536- Default:
1537
1538```json
1539{
1540  "global_lsp_settings": {
1541    "button": true
1542  }
1543}
1544```
1545
1546**Options**
1547
1548- `button`: Whether to show the LSP status button in the status bar
1549
1550## LSP Highlight Debounce
1551
1552- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1553- Setting: `lsp_highlight_debounce`
1554- Default: `75`
1555
1556## Global LSP Settings
1557
1558- Description: Common language server settings.
1559- Setting: `global_lsp_settings`
1560- Default:
1561
1562```json
1563"global_lsp_settings": {
1564  "button": true
1565}
1566```
1567
1568**Options**
1569
1570`integer` values representing milliseconds
1571
1572## Features
1573
1574- Description: Features that can be globally enabled or disabled
1575- Setting: `features`
1576- Default:
1577
1578```json
1579{
1580  "features": {
1581    "edit_prediction_provider": "zed"
1582  }
1583}
1584```
1585
1586### Edit Prediction Provider
1587
1588- Description: Which edit prediction provider to use
1589- Setting: `edit_prediction_provider`
1590- Default: `"zed"`
1591
1592**Options**
1593
15941. Use Zeta as the edit prediction provider:
1595
1596```json
1597{
1598  "features": {
1599    "edit_prediction_provider": "zed"
1600  }
1601}
1602```
1603
16042. Use Copilot as the edit prediction provider:
1605
1606```json
1607{
1608  "features": {
1609    "edit_prediction_provider": "copilot"
1610  }
1611}
1612```
1613
16143. Use Supermaven as the edit prediction provider:
1615
1616```json
1617{
1618  "features": {
1619    "edit_prediction_provider": "supermaven"
1620  }
1621}
1622```
1623
16244. Turn off edit predictions across all providers
1625
1626```json
1627{
1628  "features": {
1629    "edit_prediction_provider": "none"
1630  }
1631}
1632```
1633
1634## Format On Save
1635
1636- Description: Whether or not to perform a buffer format before saving.
1637- Setting: `format_on_save`
1638- Default: `on`
1639
1640**Options**
1641
16421. `on`, enables format on save obeying `formatter` setting:
1643
1644```json
1645{
1646  "format_on_save": "on"
1647}
1648```
1649
16502. `off`, disables format on save:
1651
1652```json
1653{
1654  "format_on_save": "off"
1655}
1656```
1657
1658## Formatter
1659
1660- Description: How to perform a buffer format.
1661- Setting: `formatter`
1662- Default: `auto`
1663
1664**Options**
1665
16661. To use the current language server, use `"language_server"`:
1667
1668```json
1669{
1670  "formatter": "language_server"
1671}
1672```
1673
16742. 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):
1675
1676```json
1677{
1678  "formatter": {
1679    "external": {
1680      "command": "sed",
1681      "arguments": ["-e", "s/ *$//"]
1682    }
1683  }
1684}
1685```
1686
16873. 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.
1688
1689WARNING: `{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.
1690
1691```json
1692  "formatter": {
1693    "external": {
1694      "command": "prettier",
1695      "arguments": ["--stdin-filepath", "{buffer_path}"]
1696    }
1697  }
1698```
1699
17004. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1701
1702```json
1703{
1704  "formatter": {
1705    "code_actions": {
1706      // Use ESLint's --fix:
1707      "source.fixAll.eslint": true,
1708      // Organize imports on save:
1709      "source.organizeImports": true
1710    }
1711  }
1712}
1713```
1714
17155. Or to use multiple formatters consecutively, use an array of formatters:
1716
1717```json
1718{
1719  "formatter": [
1720    { "language_server": { "name": "rust-analyzer" } },
1721    {
1722      "external": {
1723        "command": "sed",
1724        "arguments": ["-e", "s/ *$//"]
1725      }
1726    }
1727  ]
1728}
1729```
1730
1731Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1732If any of the formatters fails, the subsequent ones will still be executed.
1733
1734## Code Actions On Format
1735
1736- Description: The code actions to perform with the primary language server when formatting the buffer.
1737- Setting: `code_actions_on_format`
1738- Default: `{}`, except for Go it's `{ "source.organizeImports": true }`
1739
1740**Examples**
1741
1742<!--
1743TBD: Add Python Ruff source.organizeImports example
1744-->
1745
17461. Organize imports on format in TypeScript and TSX buffers:
1747
1748```json
1749{
1750  "languages": {
1751    "TypeScript": {
1752      "code_actions_on_format": {
1753        "source.organizeImports": true
1754      }
1755    },
1756    "TSX": {
1757      "code_actions_on_format": {
1758        "source.organizeImports": true
1759      }
1760    }
1761  }
1762}
1763```
1764
17652. Run ESLint `fixAll` code action when formatting:
1766
1767```json
1768{
1769  "languages": {
1770    "JavaScript": {
1771      "code_actions_on_format": {
1772        "source.fixAll.eslint": true
1773      }
1774    }
1775  }
1776}
1777```
1778
17793. Run only a single ESLint rule when using `fixAll`:
1780
1781```json
1782{
1783  "languages": {
1784    "JavaScript": {
1785      "code_actions_on_format": {
1786        "source.fixAll.eslint": true
1787      }
1788    }
1789  },
1790  "lsp": {
1791    "eslint": {
1792      "settings": {
1793        "codeActionOnSave": {
1794          "rules": ["import/order"]
1795        }
1796      }
1797    }
1798  }
1799}
1800```
1801
1802## Auto close
1803
1804- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1805- Setting: `use_autoclose`
1806- Default: `true`
1807
1808**Options**
1809
1810`boolean` values
1811
1812## Always Treat Brackets As Autoclosed
1813
1814- Description: Controls how the editor handles the autoclosed characters.
1815- Setting: `always_treat_brackets_as_autoclosed`
1816- Default: `false`
1817
1818**Options**
1819
1820`boolean` values
1821
1822**Example**
1823
1824If the setting is set to `true`:
1825
18261. Enter in the editor: `)))`
18272. Move the cursor to the start: `^)))`
18283. Enter again: `)))`
1829
1830The result is still `)))` and not `))))))`, which is what it would be by default.
1831
1832## File Scan Exclusions
1833
1834- Setting: `file_scan_exclusions`
1835- Description: Files or globs of files that will be excluded by Zed entirely. They will be skipped during file scans, file searches, and not be displayed in the project file tree. Overrides `file_scan_inclusions`.
1836- Default:
1837
1838```json
1839"file_scan_exclusions": [
1840  "**/.git",
1841  "**/.svn",
1842  "**/.hg",
1843  "**/.jj",
1844  "**/CVS",
1845  "**/.DS_Store",
1846  "**/Thumbs.db",
1847  "**/.classpath",
1848  "**/.settings"
1849],
1850```
1851
1852Note, specifying `file_scan_exclusions` in settings.json will override the defaults (shown above). If you are looking to exclude additional items you will need to include all the default values in your settings.
1853
1854## File Scan Inclusions
1855
1856- Setting: `file_scan_inclusions`
1857- Description: Files or globs of files that will be included by Zed, even when ignored by git. This is useful for files that are not tracked by git, but are still important to your project. Note that globs that are overly broad can slow down Zed's file scanning. `file_scan_exclusions` takes precedence over these inclusions.
1858- Default:
1859
1860```json
1861"file_scan_inclusions": [".env*"],
1862```
1863
1864## File Types
1865
1866- Setting: `file_types`
1867- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1868- Default:
1869
1870```json
1871"file_types": {
1872  "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1873  "Shell Script": [".env.*"]
1874}
1875```
1876
1877**Examples**
1878
1879To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1880
1881```json
1882{
1883  "file_types": {
1884    "C++": ["c"],
1885    "TOML": ["MyLockFile"],
1886    "Dockerfile": ["Dockerfile*"]
1887  }
1888}
1889```
1890
1891## Diagnostics
1892
1893- Description: Configuration for diagnostics-related features.
1894- Setting: `diagnostics`
1895- Default:
1896
1897```json
1898{
1899  "diagnostics": {
1900    "include_warnings": true,
1901    "inline": {
1902      "enabled": false
1903    },
1904    "update_with_cursor": false,
1905    "primary_only": false,
1906    "use_rendered": false
1907  }
1908}
1909```
1910
1911### Inline Diagnostics
1912
1913- Description: Whether or not to show diagnostics information inline.
1914- Setting: `inline`
1915- Default:
1916
1917```json
1918{
1919  "diagnostics": {
1920    "inline": {
1921      "enabled": false,
1922      "update_debounce_ms": 150,
1923      "padding": 4,
1924      "min_column": 0,
1925      "max_severity": null
1926    }
1927  }
1928}
1929```
1930
1931**Options**
1932
19331. Enable inline diagnostics.
1934
1935```json
1936{
1937  "diagnostics": {
1938    "inline": {
1939      "enabled": true
1940    }
1941  }
1942}
1943```
1944
19452. Delay diagnostic updates until some time after the last diagnostic update.
1946
1947```json
1948{
1949  "diagnostics": {
1950    "inline": {
1951      "enabled": true,
1952      "update_debounce_ms": 150
1953    }
1954  }
1955}
1956```
1957
19583. Set padding between the end of the source line and the start of the diagnostic.
1959
1960```json
1961{
1962  "diagnostics": {
1963    "inline": {
1964      "enabled": true,
1965      "padding": 4
1966    }
1967  }
1968}
1969```
1970
19714. Horizontally align inline diagnostics at the given column.
1972
1973```json
1974{
1975  "diagnostics": {
1976    "inline": {
1977      "enabled": true,
1978      "min_column": 80
1979    }
1980  }
1981}
1982```
1983
19845. Show only warning and error diagnostics.
1985
1986```json
1987{
1988  "diagnostics": {
1989    "inline": {
1990      "enabled": true,
1991      "max_severity": "warning"
1992    }
1993  }
1994}
1995```
1996
1997## Git
1998
1999- Description: Configuration for git-related features.
2000- Setting: `git`
2001- Default:
2002
2003```json
2004{
2005  "git": {
2006    "git_gutter": "tracked_files",
2007    "inline_blame": {
2008      "enabled": true
2009    },
2010    "hunk_style": "staged_hollow"
2011  }
2012}
2013```
2014
2015### Git Gutter
2016
2017- Description: Whether or not to show the git gutter.
2018- Setting: `git_gutter`
2019- Default: `tracked_files`
2020
2021**Options**
2022
20231. Show git gutter in tracked files
2024
2025```json
2026{
2027  "git": {
2028    "git_gutter": "tracked_files"
2029  }
2030}
2031```
2032
20332. Hide git gutter
2034
2035```json
2036{
2037  "git": {
2038    "git_gutter": "hide"
2039  }
2040}
2041```
2042
2043### Gutter Debounce
2044
2045- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2046- Setting: `gutter_debounce`
2047- Default: `null`
2048
2049**Options**
2050
2051`integer` values representing milliseconds
2052
2053Example:
2054
2055```json
2056{
2057  "git": {
2058    "gutter_debounce": 100
2059  }
2060}
2061```
2062
2063### Inline Git Blame
2064
2065- Description: Whether or not to show git blame information inline, on the currently focused line.
2066- Setting: `inline_blame`
2067- Default:
2068
2069```json
2070{
2071  "git": {
2072    "inline_blame": {
2073      "enabled": true
2074    }
2075  }
2076}
2077```
2078
2079**Options**
2080
20811. Disable inline git blame:
2082
2083```json
2084{
2085  "git": {
2086    "inline_blame": {
2087      "enabled": false
2088    }
2089  }
2090}
2091```
2092
20932. Only show inline git blame after a delay (that starts after cursor stops moving):
2094
2095```json
2096{
2097  "git": {
2098    "inline_blame": {
2099      "delay_ms": 500
2100    }
2101  }
2102}
2103```
2104
21053. Show a commit summary next to the commit date and author:
2106
2107```json
2108{
2109  "git": {
2110    "inline_blame": {
2111      "show_commit_summary": true
2112    }
2113  }
2114}
2115```
2116
21174. Use this as the minimum column at which to display inline blame information:
2118
2119```json
2120{
2121  "git": {
2122    "inline_blame": {
2123      "min_column": 80
2124    }
2125  }
2126}
2127```
2128
21295. Set the padding between the end of the line and the inline blame hint, in ems:
2130
2131```json
2132{
2133  "git": {
2134    "inline_blame": {
2135      "padding": 10
2136    }
2137  }
2138}
2139```
2140
2141### Hunk Style
2142
2143- Description: What styling we should use for the diff hunks.
2144- Setting: `hunk_style`
2145- Default:
2146
2147```json
2148{
2149  "git": {
2150    "hunk_style": "staged_hollow"
2151  }
2152}
2153```
2154
2155**Options**
2156
21571. Show the staged hunks faded out and with a border:
2158
2159```json
2160{
2161  "git": {
2162    "hunk_style": "staged_hollow"
2163  }
2164}
2165```
2166
21672. Show unstaged hunks faded out and with a border:
2168
2169```json
2170{
2171  "git": {
2172    "hunk_style": "unstaged_hollow"
2173  }
2174}
2175```
2176
2177## Go to Definition Fallback
2178
2179- Description: What to do when the "go to definition" action fails to find a definition
2180- Setting: `go_to_definition_fallback`
2181- Default: `"find_all_references"`
2182
2183**Options**
2184
21851. Do nothing:
2186
2187```json
2188{
2189  "go_to_definition_fallback": "none"
2190}
2191```
2192
21932. Find references for the same symbol (default):
2194
2195```json
2196{
2197  "go_to_definition_fallback": "find_all_references"
2198}
2199```
2200
2201## Hard Tabs
2202
2203- Description: Whether to indent lines using tab characters or multiple spaces.
2204- Setting: `hard_tabs`
2205- Default: `false`
2206
2207**Options**
2208
2209`boolean` values
2210
2211## Helix Mode
2212
2213- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2214- Setting: `helix_mode`
2215- Default: `false`
2216
2217**Options**
2218
2219`boolean` values
2220
2221## Indent Guides
2222
2223- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2224- Setting: `indent_guides`
2225- Default:
2226
2227```json
2228{
2229  "indent_guides": {
2230    "enabled": true,
2231    "line_width": 1,
2232    "active_line_width": 1,
2233    "coloring": "fixed",
2234    "background_coloring": "disabled"
2235  }
2236}
2237```
2238
2239**Options**
2240
22411. Disable indent guides
2242
2243```json
2244{
2245  "indent_guides": {
2246    "enabled": false
2247  }
2248}
2249```
2250
22512. Enable indent guides for a specific language.
2252
2253```json
2254{
2255  "languages": {
2256    "Python": {
2257      "indent_guides": {
2258        "enabled": true
2259      }
2260    }
2261  }
2262}
2263```
2264
22653. Enable indent aware coloring ("rainbow indentation").
2266   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.
2267
2268```json
2269{
2270  "indent_guides": {
2271    "enabled": true,
2272    "coloring": "indent_aware"
2273  }
2274}
2275```
2276
22774. Enable indent aware background coloring ("rainbow indentation").
2278   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.
2279
2280```json
2281{
2282  "indent_guides": {
2283    "enabled": true,
2284    "coloring": "indent_aware",
2285    "background_coloring": "indent_aware"
2286  }
2287}
2288```
2289
2290## Hover Popover Enabled
2291
2292- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2293- Setting: `hover_popover_enabled`
2294- Default: `true`
2295
2296**Options**
2297
2298`boolean` values
2299
2300## Hover Popover Delay
2301
2302- Description: Time to wait in milliseconds before showing the informational hover box.
2303- Setting: `hover_popover_delay`
2304- Default: `300`
2305
2306**Options**
2307
2308`integer` values representing milliseconds
2309
2310## Icon Theme
2311
2312- 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.
2313- Setting: `icon_theme`
2314- Default: `Zed (Default)`
2315
2316### Icon Theme Object
2317
2318- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2319- Setting: `icon_theme`
2320- Default:
2321
2322```json
2323"icon_theme": {
2324  "mode": "system",
2325  "dark": "Zed (Default)",
2326  "light": "Zed (Default)"
2327},
2328```
2329
2330### Mode
2331
2332- Description: Specify the icon theme mode.
2333- Setting: `mode`
2334- Default: `system`
2335
2336**Options**
2337
23381. Set the icon theme to dark mode
2339
2340```json
2341{
2342  "mode": "dark"
2343}
2344```
2345
23462. Set the icon theme to light mode
2347
2348```json
2349{
2350  "mode": "light"
2351}
2352```
2353
23543. Set the icon theme to system mode
2355
2356```json
2357{
2358  "mode": "system"
2359}
2360```
2361
2362### Dark
2363
2364- Description: The name of the dark icon theme.
2365- Setting: `dark`
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### Light
2373
2374- Description: The name of the light icon theme.
2375- Setting: `light`
2376- Default: `Zed (Default)`
2377
2378**Options**
2379
2380Run the `icon theme selector: toggle` action in the command palette to see a current list of valid icon themes names.
2381
2382## Image Viewer
2383
2384- Description: Settings for image viewer functionality
2385- Setting: `image_viewer`
2386- Default:
2387
2388```json
2389{
2390  "image_viewer": {
2391    "unit": "binary"
2392  }
2393}
2394```
2395
2396**Options**
2397
2398### Unit
2399
2400- Description: The unit for image file sizes
2401- Setting: `unit`
2402- Default: `"binary"`
2403
2404**Options**
2405
24061. Use binary units (KiB, MiB):
2407
2408```json
2409{
2410  "image_viewer": {
2411    "unit": "binary"
2412  }
2413}
2414```
2415
24162. Use decimal units (KB, MB):
2417
2418```json
2419{
2420  "image_viewer": {
2421    "unit": "decimal"
2422  }
2423}
2424```
2425
2426## Inlay hints
2427
2428- Description: Configuration for displaying extra text with hints in the editor.
2429- Setting: `inlay_hints`
2430- Default:
2431
2432```json
2433"inlay_hints": {
2434  "enabled": false,
2435  "show_type_hints": true,
2436  "show_parameter_hints": true,
2437  "show_other_hints": true,
2438  "show_background": false,
2439  "edit_debounce_ms": 700,
2440  "scroll_debounce_ms": 50,
2441  "toggle_on_modifiers_press": null
2442}
2443```
2444
2445**Options**
2446
2447Inlay hints querying consists of two parts: editor (client) and LSP server.
2448With 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.
2449At 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.
2450
2451The following languages have inlay hints preconfigured by Zed:
2452
2453- [Go](https://docs.zed.dev/languages/go)
2454- [Rust](https://docs.zed.dev/languages/rust)
2455- [Svelte](https://docs.zed.dev/languages/svelte)
2456- [Typescript](https://docs.zed.dev/languages/typescript)
2457
2458Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2459
2460Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2461Settings-related hint updates are not debounced.
2462
2463All possible config values for `toggle_on_modifiers_press` are:
2464
2465```json
2466"inlay_hints": {
2467  "toggle_on_modifiers_press": {
2468    "control": true,
2469    "shift": true,
2470    "alt": true,
2471    "platform": true,
2472    "function": true
2473  }
2474}
2475```
2476
2477Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2478
2479## Journal
2480
2481- Description: Configuration for the journal.
2482- Setting: `journal`
2483- Default:
2484
2485```json
2486"journal": {
2487  "path": "~",
2488  "hour_format": "hour12"
2489}
2490```
2491
2492### Path
2493
2494- Description: The path of the directory where journal entries are stored.
2495- Setting: `path`
2496- Default: `~`
2497
2498**Options**
2499
2500`string` values
2501
2502### Hour Format
2503
2504- Description: The format to use for displaying hours in the journal.
2505- Setting: `hour_format`
2506- Default: `hour12`
2507
2508**Options**
2509
25101. 12-hour format:
2511
2512```json
2513{
2514  "hour_format": "hour12"
2515}
2516```
2517
25182. 24-hour format:
2519
2520```json
2521{
2522  "hour_format": "hour24"
2523}
2524```
2525
2526## JSX Tag Auto Close
2527
2528- Description: Whether to automatically close JSX tags
2529- Setting: `jsx_tag_auto_close`
2530- Default:
2531
2532```json
2533{
2534  "jsx_tag_auto_close": {
2535    "enabled": true
2536  }
2537}
2538```
2539
2540**Options**
2541
2542- `enabled`: Whether to enable automatic JSX tag closing
2543
2544## Languages
2545
2546- Description: Configuration for specific languages.
2547- Setting: `languages`
2548- Default: `null`
2549
2550**Options**
2551
2552To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2553
2554```json
2555"languages": {
2556  "C": {
2557    "format_on_save": "off",
2558    "preferred_line_length": 64,
2559    "soft_wrap": "preferred_line_length"
2560  },
2561  "JSON": {
2562    "tab_size": 4
2563  }
2564}
2565```
2566
2567The following settings can be overridden for each specific language:
2568
2569- [`enable_language_server`](#enable-language-server)
2570- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2571- [`format_on_save`](#format-on-save)
2572- [`formatter`](#formatter)
2573- [`hard_tabs`](#hard-tabs)
2574- [`preferred_line_length`](#preferred-line-length)
2575- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2576- [`show_edit_predictions`](#show-edit-predictions)
2577- [`show_whitespaces`](#show-whitespaces)
2578- [`soft_wrap`](#soft-wrap)
2579- [`tab_size`](#tab-size)
2580- [`use_autoclose`](#use-autoclose)
2581- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2582
2583These values take in the same options as the root-level settings with the same name.
2584
2585## Language Models
2586
2587- Description: Configuration for language model providers
2588- Setting: `language_models`
2589- Default:
2590
2591```json
2592{
2593  "language_models": {
2594    "anthropic": {
2595      "api_url": "https://api.anthropic.com"
2596    },
2597    "google": {
2598      "api_url": "https://generativelanguage.googleapis.com"
2599    },
2600    "ollama": {
2601      "api_url": "http://localhost:11434"
2602    },
2603    "openai": {
2604      "api_url": "https://api.openai.com/v1"
2605    }
2606  }
2607}
2608```
2609
2610**Options**
2611
2612Configuration for various AI model providers including API URLs and authentication settings.
2613
2614## Line Indicator Format
2615
2616- Description: Format for line indicator in the status bar
2617- Setting: `line_indicator_format`
2618- Default: `"short"`
2619
2620**Options**
2621
26221. Short format:
2623
2624```json
2625{
2626  "line_indicator_format": "short"
2627}
2628```
2629
26302. Long format:
2631
2632```json
2633{
2634  "line_indicator_format": "long"
2635}
2636```
2637
2638## Linked Edits
2639
2640- 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.
2641- Setting: `linked_edits`
2642- Default: `true`
2643
2644**Options**
2645
2646`boolean` values
2647
2648## LSP Document Colors
2649
2650- Description: Whether to show document color information from the language server
2651- Setting: `lsp_document_colors`
2652- Default: `true`
2653
2654**Options**
2655
2656`boolean` values
2657
2658## Max Tabs
2659
2660- Description: Maximum number of tabs to show in the tab bar
2661- Setting: `max_tabs`
2662- Default: `null`
2663
2664**Options**
2665
2666Positive `integer` values or `null` for unlimited tabs
2667
2668## Middle Click Paste (Linux only)
2669
2670- Description: Enable middle-click paste on Linux
2671- Setting: `middle_click_paste`
2672- Default: `true`
2673
2674**Options**
2675
2676`boolean` values
2677
2678## Multi Cursor Modifier
2679
2680- 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.
2681- Setting: `multi_cursor_modifier`
2682- Default: `alt`
2683
2684**Options**
2685
26861. Maps to `Alt` on Linux and Windows and to `Option` on MacOS:
2687
2688```json
2689{
2690  "multi_cursor_modifier": "alt"
2691}
2692```
2693
26942. Maps `Control` on Linux and Windows and to `Command` on MacOS:
2695
2696```json
2697{
2698  "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2699}
2700```
2701
2702## Node
2703
2704- Description: Configuration for Node.js integration
2705- Setting: `node`
2706- Default:
2707
2708```json
2709{
2710  "node": {
2711    "ignore_system_version": false,
2712    "path": null,
2713    "npm_path": null
2714  }
2715}
2716```
2717
2718**Options**
2719
2720- `ignore_system_version`: Whether to ignore the system Node.js version
2721- `path`: Custom path to Node.js binary
2722- `npm_path`: Custom path to npm binary
2723
2724## Network Proxy
2725
2726- Description: Configure a network proxy for Zed.
2727- Setting: `proxy`
2728- Default: `null`
2729
2730**Options**
2731
2732The proxy setting must contain a URL to the proxy.
2733
2734The following URI schemes are supported:
2735
2736- `http`
2737- `https`
2738- `socks4` - SOCKS4 proxy with local DNS
2739- `socks4a` - SOCKS4 proxy with remote DNS
2740- `socks5` - SOCKS5 proxy with local DNS
2741- `socks5h` - SOCKS5 proxy with remote DNS
2742
2743`http` will be used when no scheme is specified.
2744
2745By 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`.
2746
2747For example, to set an `http` proxy, add the following to your settings:
2748
2749```json
2750{
2751  "proxy": "http://127.0.0.1:10809"
2752}
2753```
2754
2755Or to set a `socks5` proxy:
2756
2757```json
2758{
2759  "proxy": "socks5h://localhost:10808"
2760}
2761```
2762
2763If 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.
2764
2765## On Last Window Closed
2766
2767- Description: What to do when the last window is closed
2768- Setting: `on_last_window_closed`
2769- Default: `"platform_default"`
2770
2771**Options**
2772
27731. Use platform default behavior:
2774
2775```json
2776{
2777  "on_last_window_closed": "platform_default"
2778}
2779```
2780
27812. Always quit the application:
2782
2783```json
2784{
2785  "on_last_window_closed": "quit_app"
2786}
2787```
2788
2789## Profiles
2790
2791- Description: Configuration profiles that can be applied on top of existing settings
2792- Setting: `profiles`
2793- Default: `{}`
2794
2795**Options**
2796
2797Configuration object for defining settings profiles. Example:
2798
2799```json
2800{
2801  "profiles": {
2802    "presentation": {
2803      "buffer_font_size": 20,
2804      "ui_font_size": 18,
2805      "theme": "One Light"
2806    }
2807  }
2808}
2809```
2810
2811## Preview tabs
2812
2813- Description:
2814  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. \
2815   There are several ways to convert a preview tab into a regular tab:
2816
2817  - Double-clicking on the file
2818  - Double-clicking on the tab header
2819  - Using the `project_panel::OpenPermanent` action
2820  - Editing the file
2821  - Dragging the file to a different pane
2822
2823- Setting: `preview_tabs`
2824- Default:
2825
2826```json
2827"preview_tabs": {
2828  "enabled": true,
2829  "enable_preview_from_file_finder": false,
2830  "enable_preview_from_code_navigation": false,
2831}
2832```
2833
2834### Enable preview from file finder
2835
2836- Description: Determines whether to open files in preview mode when selected from the file finder.
2837- Setting: `enable_preview_from_file_finder`
2838- Default: `false`
2839
2840**Options**
2841
2842`boolean` values
2843
2844### Enable preview from code navigation
2845
2846- Description: Determines whether a preview tab gets replaced when code navigation is used to navigate away from the tab.
2847- Setting: `enable_preview_from_code_navigation`
2848- Default: `false`
2849
2850**Options**
2851
2852`boolean` values
2853
2854## File Finder
2855
2856### File Icons
2857
2858- Description: Whether to show file icons in the file finder.
2859- Setting: `file_icons`
2860- Default: `true`
2861
2862### Modal Max Width
2863
2864- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2865- Setting: `modal_max_width`
2866- Default: `small`
2867
2868### Skip Focus For Active In Search
2869
2870- Description: Determines whether the file finder should skip focus for the active file in search results.
2871- Setting: `skip_focus_for_active_in_search`
2872- Default: `true`
2873
2874## Pane Split Direction Horizontal
2875
2876- Description: The direction that you want to split panes horizontally
2877- Setting: `pane_split_direction_horizontal`
2878- Default: `"up"`
2879
2880**Options**
2881
28821. Split upward:
2883
2884```json
2885{
2886  "pane_split_direction_horizontal": "up"
2887}
2888```
2889
28902. Split downward:
2891
2892```json
2893{
2894  "pane_split_direction_horizontal": "down"
2895}
2896```
2897
2898## Pane Split Direction Vertical
2899
2900- Description: The direction that you want to split panes vertically
2901- Setting: `pane_split_direction_vertical`
2902- Default: `"left"`
2903
2904**Options**
2905
29061. Split to the left:
2907
2908```json
2909{
2910  "pane_split_direction_vertical": "left"
2911}
2912```
2913
29142. Split to the right:
2915
2916```json
2917{
2918  "pane_split_direction_vertical": "right"
2919}
2920```
2921
2922## Preferred Line Length
2923
2924- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
2925- Setting: `preferred_line_length`
2926- Default: `80`
2927
2928**Options**
2929
2930`integer` values
2931
2932## Private Files
2933
2934- Description: Globs to match against file paths to determine if a file is private
2935- Setting: `private_files`
2936- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
2937
2938**Options**
2939
2940List of `string` glob patterns
2941
2942## Projects Online By Default
2943
2944- Description: Whether or not to show the online projects view by default.
2945- Setting: `projects_online_by_default`
2946- Default: `true`
2947
2948**Options**
2949
2950`boolean` values
2951
2952## Read SSH Config
2953
2954- Description: Whether to read SSH configuration files
2955- Setting: `read_ssh_config`
2956- Default: `true`
2957
2958**Options**
2959
2960`boolean` values
2961
2962## Redact Private Values
2963
2964- Description: Hide the values of variables from visual display in private files
2965- Setting: `redact_private_values`
2966- Default: `false`
2967
2968**Options**
2969
2970`boolean` values
2971
2972## Relative Line Numbers
2973
2974- Description: Whether to show relative line numbers in the gutter
2975- Setting: `relative_line_numbers`
2976- Default: `false`
2977
2978**Options**
2979
2980`boolean` values
2981
2982## Remove Trailing Whitespace On Save
2983
2984- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
2985- Setting: `remove_trailing_whitespace_on_save`
2986- Default: `true`
2987
2988**Options**
2989
2990`boolean` values
2991
2992## Resize All Panels In Dock
2993
2994- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
2995- Setting: `resize_all_panels_in_dock`
2996- Default: `["left"]`
2997
2998**Options**
2999
3000List of strings containing any combination of:
3001
3002- `"left"`: Resize left dock panels together
3003- `"right"`: Resize right dock panels together
3004- `"bottom"`: Resize bottom dock panels together
3005
3006## Restore on File Reopen
3007
3008- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3009- Setting: `restore_on_file_reopen`
3010- Default: `true`
3011
3012**Options**
3013
3014`boolean` values
3015
3016## Restore on Startup
3017
3018- Description: Controls session restoration on startup.
3019- Setting: `restore_on_startup`
3020- Default: `last_session`
3021
3022**Options**
3023
30241. Restore all workspaces that were open when quitting Zed:
3025
3026```json
3027{
3028  "restore_on_startup": "last_session"
3029}
3030```
3031
30322. Restore the workspace that was closed last:
3033
3034```json
3035{
3036  "restore_on_startup": "last_workspace"
3037}
3038```
3039
30403. Always start with an empty editor:
3041
3042```json
3043{
3044  "restore_on_startup": "none"
3045}
3046```
3047
3048## Scroll Beyond Last Line
3049
3050- Description: Whether the editor will scroll beyond the last line
3051- Setting: `scroll_beyond_last_line`
3052- Default: `"one_page"`
3053
3054**Options**
3055
30561. Scroll one page beyond the last line by one page:
3057
3058```json
3059{
3060  "scroll_beyond_last_line": "one_page"
3061}
3062```
3063
30642. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3065
3066```json
3067{
3068  "scroll_beyond_last_line": "vertical_scroll_margin"
3069}
3070```
3071
30723. The editor will not scroll beyond the last line:
3073
3074```json
3075{
3076  "scroll_beyond_last_line": "off"
3077}
3078```
3079
3080**Options**
3081
3082`boolean` values
3083
3084## Scroll Sensitivity
3085
3086- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3087- Setting: `scroll_sensitivity`
3088- Default: `1.0`
3089
3090**Options**
3091
3092Positive `float` values
3093
3094### Fast Scroll Sensitivity
3095
3096- 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.
3097- Setting: `fast_scroll_sensitivity`
3098- Default: `4.0`
3099
3100**Options**
3101
3102Positive `float` values
3103
3104### Horizontal Scroll Margin
3105
3106- Description: The number of characters to keep on either side when scrolling with the mouse
3107- Setting: `horizontal_scroll_margin`
3108- Default: `5`
3109
3110**Options**
3111
3112Non-negative `integer` values
3113
3114### Vertical Scroll Margin
3115
3116- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3117- Setting: `vertical_scroll_margin`
3118- Default: `3`
3119
3120**Options**
3121
3122Non-negative `integer` values
3123
3124## Search
3125
3126- Description: Search options to enable by default when opening new project and buffer searches.
3127- Setting: `search`
3128- Default:
3129
3130```json
3131"search": {
3132  "whole_word": false,
3133  "case_sensitive": false,
3134  "include_ignored": false,
3135  "regex": false
3136},
3137```
3138
3139## Search Wrap
3140
3141- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3142- Setting: `search_wrap`
3143- Default: `true`
3144
3145## Seed Search Query From Cursor
3146
3147- Description: When to populate a new search's query based on the text under the cursor.
3148- Setting: `seed_search_query_from_cursor`
3149- Default: `always`
3150
3151**Options**
3152
31531. `always` always populate the search query with the word under the cursor
31542. `selection` only populate the search query when there is text selected
31553. `never` never populate the search query
3156
3157## Use Smartcase Search
3158
3159- 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. \
3160  This applies to both in-file searches and project-wide searches.
3161- Setting: `use_smartcase_search`
3162- Default: `false`
3163
3164**Options**
3165
3166`boolean` values
3167
3168Examples:
3169
3170- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3171- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3172
3173## Show Call Status Icon
3174
3175- Description: Whether or not to show the call status icon in the status bar.
3176- Setting: `show_call_status_icon`
3177- Default: `true`
3178
3179**Options**
3180
3181`boolean` values
3182
3183## Completions
3184
3185- Description: Controls how completions are processed for this language.
3186- Setting: `completions`
3187- Default:
3188
3189```json
3190{
3191  "completions": {
3192    "words": "fallback",
3193    "words_min_length": 3,
3194    "lsp": true,
3195    "lsp_fetch_timeout_ms": 0,
3196    "lsp_insert_mode": "replace_suffix"
3197  }
3198}
3199```
3200
3201### Words
3202
3203- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3204- Setting: `words`
3205- Default: `fallback`
3206
3207**Options**
3208
32091. `enabled` - Always fetch document's words for completions along with LSP completions
32102. `fallback` - Only if LSP response errors or times out, use document's words to show completions
32113. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3212
3213### Min Words Query Length
3214
3215- Description: Minimum number of characters required to automatically trigger word-based completions.
3216  Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3217- Setting: `words_min_length`
3218- Default: `3`
3219
3220**Options**
3221
3222Positive integer values
3223
3224### LSP
3225
3226- Description: Whether to fetch LSP completions or not.
3227- Setting: `lsp`
3228- Default: `true`
3229
3230**Options**
3231
3232`boolean` values
3233
3234### LSP Fetch Timeout (ms)
3235
3236- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3237- Setting: `lsp_fetch_timeout_ms`
3238- Default: `0`
3239
3240**Options**
3241
3242`integer` values representing milliseconds
3243
3244### LSP Insert Mode
3245
3246- Description: Controls what range to replace when accepting LSP completions.
3247- Setting: `lsp_insert_mode`
3248- Default: `replace_suffix`
3249
3250**Options**
3251
32521. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
32532. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
32543. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
32554. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3256
3257## Show Completions On Input
3258
3259- Description: Whether or not to show completions as you type.
3260- Setting: `show_completions_on_input`
3261- Default: `true`
3262
3263**Options**
3264
3265`boolean` values
3266
3267## Show Completion Documentation
3268
3269- Description: Whether to display inline and alongside documentation for items in the completions menu.
3270- Setting: `show_completion_documentation`
3271- Default: `true`
3272
3273**Options**
3274
3275`boolean` values
3276
3277## Show Edit Predictions
3278
3279- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3280- Setting: `show_edit_predictions`
3281- Default: `true`
3282
3283**Options**
3284
3285`boolean` values
3286
3287## Show Whitespaces
3288
3289- Description: Whether or not to render whitespace characters in the editor.
3290- Setting: `show_whitespaces`
3291- Default: `selection`
3292
3293**Options**
3294
32951. `all`
32962. `selection`
32973. `none`
32984. `boundary`
3299
3300## Soft Wrap
3301
3302- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3303- Setting: `soft_wrap`
3304- Default: `none`
3305
3306**Options**
3307
33081. `none` to avoid wrapping generally, unless the line is too long
33092. `prefer_line` (deprecated, same as `none`)
33103. `editor_width` to wrap lines that overflow the editor width
33114. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
33125. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3313
3314## Show Wrap Guides
3315
3316- 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.
3317- Setting: `show_wrap_guides`
3318- Default: `true`
3319
3320**Options**
3321
3322`boolean` values
3323
3324## Use On Type Format
3325
3326- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3327- Setting: `use_on_type_format`
3328- Default: `true`
3329
3330**Options**
3331
3332`boolean` values
3333
3334## Use Auto Surround
3335
3336- 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 ().
3337- Setting: `use_auto_surround`
3338- Default: `true`
3339
3340**Options**
3341
3342`boolean` values
3343
3344## Use System Path Prompts
3345
3346- 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.
3347- Setting: `use_system_path_prompts`
3348- Default: `true`
3349
3350**Options**
3351
3352`boolean` values
3353
3354## Use System Prompts
3355
3356- 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.
3357- Setting: `use_system_prompts`
3358- Default: `true`
3359
3360**Options**
3361
3362`boolean` values
3363
3364## Wrap Guides (Vertical Rulers)
3365
3366- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3367- Setting: `wrap_guides`
3368- Default: []
3369
3370**Options**
3371
3372List of `integer` column numbers
3373
3374## Tab Size
3375
3376- Description: The number of spaces to use for each tab character.
3377- Setting: `tab_size`
3378- Default: `4`
3379
3380**Options**
3381
3382`integer` values
3383
3384## Tasks
3385
3386- Description: Configuration for tasks that can be run within Zed
3387- Setting: `tasks`
3388- Default:
3389
3390```json
3391{
3392  "tasks": {
3393    "variables": {},
3394    "enabled": true,
3395    "prefer_lsp": false
3396  }
3397}
3398```
3399
3400**Options**
3401
3402- `variables`: Custom variables for task configuration
3403- `enabled`: Whether tasks are enabled
3404- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3405
3406## Telemetry
3407
3408- Description: Control what info is collected by Zed.
3409- Setting: `telemetry`
3410- Default:
3411
3412```json
3413"telemetry": {
3414  "diagnostics": true,
3415  "metrics": true
3416},
3417```
3418
3419**Options**
3420
3421### Diagnostics
3422
3423- Description: Setting for sending debug-related data, such as crash reports.
3424- Setting: `diagnostics`
3425- Default: `true`
3426
3427**Options**
3428
3429`boolean` values
3430
3431### Metrics
3432
3433- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3434- Setting: `metrics`
3435- Default: `true`
3436
3437**Options**
3438
3439`boolean` values
3440
3441## Terminal
3442
3443- Description: Configuration for the terminal.
3444- Setting: `terminal`
3445- Default:
3446
3447```json
3448{
3449  "terminal": {
3450    "alternate_scroll": "off",
3451    "blinking": "terminal_controlled",
3452    "copy_on_select": false,
3453    "keep_selection_on_copy": false,
3454    "dock": "bottom",
3455    "default_width": 640,
3456    "default_height": 320,
3457    "detect_venv": {
3458      "on": {
3459        "directories": [".env", "env", ".venv", "venv"],
3460        "activate_script": "default"
3461      }
3462    },
3463    "env": {},
3464    "font_family": null,
3465    "font_features": null,
3466    "font_size": null,
3467    "line_height": "comfortable",
3468    "minimum_contrast": 45,
3469    "option_as_meta": false,
3470    "button": true,
3471    "shell": "system",
3472    "toolbar": {
3473      "breadcrumbs": true
3474    },
3475    "working_directory": "current_project_directory",
3476    "scrollbar": {
3477      "show": null
3478    }
3479  }
3480}
3481```
3482
3483### Terminal: Dock
3484
3485- Description: Control the position of the dock
3486- Setting: `dock`
3487- Default: `bottom`
3488
3489**Options**
3490
3491`"bottom"`, `"left"` or `"right"`
3492
3493### Terminal: Alternate Scroll
3494
3495- 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.
3496- Setting: `alternate_scroll`
3497- Default: `off`
3498
3499**Options**
3500
35011. Default alternate scroll mode to off
3502
3503```json
3504{
3505  "terminal": {
3506    "alternate_scroll": "off"
3507  }
3508}
3509```
3510
35112. Default alternate scroll mode to on
3512
3513```json
3514{
3515  "terminal": {
3516    "alternate_scroll": "on"
3517  }
3518}
3519```
3520
3521### Terminal: Blinking
3522
3523- Description: Set the cursor blinking behavior in the terminal
3524- Setting: `blinking`
3525- Default: `terminal_controlled`
3526
3527**Options**
3528
35291. Never blink the cursor, ignore the terminal mode
3530
3531```json
3532{
3533  "terminal": {
3534    "blinking": "off"
3535  }
3536}
3537```
3538
35392. Default the cursor blink to off, but allow the terminal to turn blinking on
3540
3541```json
3542{
3543  "terminal": {
3544    "blinking": "terminal_controlled"
3545  }
3546}
3547```
3548
35493. Always blink the cursor, ignore the terminal mode
3550
3551```json
3552{
3553  "terminal": {
3554    "blinking": "on"
3555  }
3556}
3557```
3558
3559### Terminal: Copy On Select
3560
3561- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3562- Setting: `copy_on_select`
3563- Default: `false`
3564
3565**Options**
3566
3567`boolean` values
3568
3569**Example**
3570
3571```json
3572{
3573  "terminal": {
3574    "copy_on_select": true
3575  }
3576}
3577```
3578
3579### Terminal: Cursor Shape
3580
3581- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3582- Setting: `cursor_shape`
3583- Default: `null` (defaults to block)
3584
3585**Options**
3586
35871. A block that surrounds the following character
3588
3589```json
3590{
3591  "terminal": {
3592    "cursor_shape": "block"
3593  }
3594}
3595```
3596
35972. A vertical bar
3598
3599```json
3600{
3601  "terminal": {
3602    "cursor_shape": "bar"
3603  }
3604}
3605```
3606
36073. An underline / underscore that runs along the following character
3608
3609```json
3610{
3611  "terminal": {
3612    "cursor_shape": "underline"
3613  }
3614}
3615```
3616
36174. A box drawn around the following character
3618
3619```json
3620{
3621  "terminal": {
3622    "cursor_shape": "hollow"
3623  }
3624}
3625```
3626
3627### Terminal: Keep Selection On Copy
3628
3629- Description: Whether or not to keep the selection in the terminal after copying text.
3630- Setting: `keep_selection_on_copy`
3631- Default: `false`
3632
3633**Options**
3634
3635`boolean` values
3636
3637**Example**
3638
3639```json
3640{
3641  "terminal": {
3642    "keep_selection_on_copy": true
3643  }
3644}
3645```
3646
3647### Terminal: Env
3648
3649- 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
3650- Setting: `env`
3651- Default: `{}`
3652
3653**Example**
3654
3655```json
3656{
3657  "terminal": {
3658    "env": {
3659      "ZED": "1",
3660      "KEY": "value1:value2"
3661    }
3662  }
3663}
3664```
3665
3666### Terminal: Font Size
3667
3668- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3669- Setting: `font_size`
3670- Default: `null`
3671
3672**Options**
3673
3674`integer` values
3675
3676```json
3677{
3678  "terminal": {
3679    "font_size": 15
3680  }
3681}
3682```
3683
3684### Terminal: Font Family
3685
3686- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3687- Setting: `font_family`
3688- Default: `null`
3689
3690**Options**
3691
3692The name of any font family installed on the user's system
3693
3694```json
3695{
3696  "terminal": {
3697    "font_family": "Berkeley Mono"
3698  }
3699}
3700```
3701
3702### Terminal: Font Features
3703
3704- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3705- Setting: `font_features`
3706- Default: `null`
3707- Platform: macOS and Windows.
3708
3709**Options**
3710
3711See Buffer Font Features
3712
3713```json
3714{
3715  "terminal": {
3716    "font_features": {
3717      "calt": false
3718      // See Buffer Font Features for more features
3719    }
3720  }
3721}
3722```
3723
3724### Terminal: Line Height
3725
3726- Description: Set the terminal's line height.
3727- Setting: `line_height`
3728- Default: `comfortable`
3729
3730**Options**
3731
37321. Use a line height that's `comfortable` for reading, 1.618. (default)
3733
3734```json
3735{
3736  "terminal": {
3737    "line_height": "comfortable"
3738  }
3739}
3740```
3741
37422. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters
3743
3744```json
3745{
3746  "terminal": {
3747    "line_height": "standard"
3748  }
3749}
3750```
3751
37523.  Use a custom line height.
3753
3754```json
3755{
3756  "terminal": {
3757    "line_height": {
3758      "custom": 2
3759    }
3760  }
3761}
3762```
3763
3764### Terminal: Minimum Contrast
3765
3766- 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.
3767- Setting: `minimum_contrast`
3768- Default: `45`
3769
3770**Options**
3771
3772`integer` values from 0 to 106. Common recommended values:
3773
3774- `0`: No contrast adjustment
3775- `45`: Minimum for large fluent text (default)
3776- `60`: Minimum for other content text
3777- `75`: Minimum for body text
3778- `90`: Preferred for body text
3779
3780```json
3781{
3782  "terminal": {
3783    "minimum_contrast": 45
3784  }
3785}
3786```
3787
3788### Terminal: Option As Meta
3789
3790- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
3791- Setting: `option_as_meta`
3792- Default: `false`
3793
3794**Options**
3795
3796`boolean` values
3797
3798```json
3799{
3800  "terminal": {
3801    "option_as_meta": true
3802  }
3803}
3804```
3805
3806### Terminal: Shell
3807
3808- Description: What shell to use when launching the terminal.
3809- Setting: `shell`
3810- Default: `system`
3811
3812**Options**
3813
38141. Use the system's default terminal configuration (usually the `/etc/passwd` file).
3815
3816```json
3817{
3818  "terminal": {
3819    "shell": "system"
3820  }
3821}
3822```
3823
38242. A program to launch:
3825
3826```json
3827{
3828  "terminal": {
3829    "shell": {
3830      "program": "sh"
3831    }
3832  }
3833}
3834```
3835
38363. A program with arguments:
3837
3838```json
3839{
3840  "terminal": {
3841    "shell": {
3842      "with_arguments": {
3843        "program": "/bin/bash",
3844        "args": ["--login"]
3845      }
3846    }
3847  }
3848}
3849```
3850
3851## Terminal: Detect Virtual Environments {#terminal-detect_venv}
3852
3853- 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.
3854- Setting: `detect_venv`
3855- Default:
3856
3857```json
3858{
3859  "terminal": {
3860    "detect_venv": {
3861      "on": {
3862        // Default directories to search for virtual environments, relative
3863        // to the current working directory. We recommend overriding this
3864        // in your project's settings, rather than globally.
3865        "directories": [".env", "env", ".venv", "venv"],
3866        // Can also be `csh`, `fish`, and `nushell`
3867        "activate_script": "default"
3868      }
3869    }
3870  }
3871}
3872```
3873
3874Disable with:
3875
3876```json
3877{
3878  "terminal": {
3879    "detect_venv": "off"
3880  }
3881}
3882```
3883
3884## Terminal: Toolbar
3885
3886- Description: Whether or not to show various elements in the terminal toolbar.
3887- Setting: `toolbar`
3888- Default:
3889
3890```json
3891{
3892  "terminal": {
3893    "toolbar": {
3894      "breadcrumbs": true
3895    }
3896  }
3897}
3898```
3899
3900**Options**
3901
3902At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
3903
3904If the terminal title is empty, the breadcrumbs won't be shown.
3905
3906The shell running in the terminal needs to be configured to emit the title.
3907
3908Example command to set the title: `echo -e "\e]2;New Title\007";`
3909
3910### Terminal: Button
3911
3912- Description: Control to show or hide the terminal button in the status bar
3913- Setting: `button`
3914- Default: `true`
3915
3916**Options**
3917
3918`boolean` values
3919
3920```json
3921{
3922  "terminal": {
3923    "button": false
3924  }
3925}
3926```
3927
3928### Terminal: Working Directory
3929
3930- Description: What working directory to use when launching the terminal.
3931- Setting: `working_directory`
3932- Default: `"current_project_directory"`
3933
3934**Options**
3935
39361. Use the current file's project directory. Will Fallback to the first project directory strategy if unsuccessful
3937
3938```json
3939{
3940  "terminal": {
3941    "working_directory": "current_project_directory"
3942  }
3943}
3944```
3945
39462. Use the first project in this workspace's directory. Will fallback to using this platform's home directory.
3947
3948```json
3949{
3950  "terminal": {
3951    "working_directory": "first_project_directory"
3952  }
3953}
3954```
3955
39563. Always use this platform's home directory (if we can find it)
3957
3958```json
3959{
3960  "terminal": {
3961    "working_directory": "always_home"
3962  }
3963}
3964```
3965
39664. 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.
3967
3968```json
3969{
3970  "terminal": {
3971    "working_directory": {
3972      "always": {
3973        "directory": "~/zed/projects/"
3974      }
3975    }
3976  }
3977}
3978```
3979
3980## Theme
3981
3982- Description: The theme setting can be specified in two forms - either as the name of a theme or as an object containing the `mode`, `dark`, and `light` themes for the Zed UI.
3983- Setting: `theme`
3984- Default: `One Dark`
3985
3986### Theme Object
3987
3988- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
3989- Setting: `theme`
3990- Default:
3991
3992```json
3993"theme": {
3994  "mode": "system",
3995  "dark": "One Dark",
3996  "light": "One Light"
3997},
3998```
3999
4000### Mode
4001
4002- Description: Specify theme mode.
4003- Setting: `mode`
4004- Default: `system`
4005
4006**Options**
4007
40081. Set the theme to dark mode
4009
4010```json
4011{
4012  "mode": "dark"
4013}
4014```
4015
40162. Set the theme to light mode
4017
4018```json
4019{
4020  "mode": "light"
4021}
4022```
4023
40243. Set the theme to system mode
4025
4026```json
4027{
4028  "mode": "system"
4029}
4030```
4031
4032### Dark
4033
4034- Description: The name of the dark Zed theme to use for the UI.
4035- Setting: `dark`
4036- Default: `One Dark`
4037
4038**Options**
4039
4040Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
4041
4042### Light
4043
4044- Description: The name of the light Zed theme to use for the UI.
4045- Setting: `light`
4046- Default: `One Light`
4047
4048**Options**
4049
4050Run the `theme selector: toggle` action in the command palette to see a current list of valid themes names.
4051
4052## Title Bar
4053
4054- Description: Whether or not to show various elements in the title bar
4055- Setting: `title_bar`
4056- Default:
4057
4058```json
4059"title_bar": {
4060  "show_branch_icon": false,
4061  "show_branch_name": true,
4062  "show_project_items": true,
4063  "show_onboarding_banner": true,
4064  "show_user_picture": true,
4065  "show_sign_in": true,
4066  "show_menus": false
4067}
4068```
4069
4070**Options**
4071
4072- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4073- `show_branch_name`: Whether to show the branch name button in the titlebar
4074- `show_project_items`: Whether to show the project host and name in the titlebar
4075- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4076- `show_user_picture`: Whether to show user picture in the titlebar
4077- `show_sign_in`: Whether to show the sign in button in the titlebar
4078- `show_menus`: Whether to show the menus in the titlebar
4079
4080## Vim
4081
4082- Description: Whether or not to enable vim mode.
4083- Setting: `vim_mode`
4084- Default: `false`
4085
4086## When Closing With No Tabs
4087
4088- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4089- Setting: `when_closing_with_no_tabs`
4090- Default: `"platform_default"`
4091
4092**Options**
4093
40941. Use platform default behavior:
4095
4096```json
4097{
4098  "when_closing_with_no_tabs": "platform_default"
4099}
4100```
4101
41022. Always close the window:
4103
4104```json
4105{
4106  "when_closing_with_no_tabs": "close_window"
4107}
4108```
4109
41103. Never close the window:
4111
4112```json
4113{
4114  "when_closing_with_no_tabs": "keep_window_open"
4115}
4116```
4117
4118## Project Panel
4119
4120- Description: Customize project panel
4121- Setting: `project_panel`
4122- Default:
4123
4124```json
4125{
4126  "project_panel": {
4127    "button": true,
4128    "default_width": 240,
4129    "dock": "left",
4130    "entry_spacing": "comfortable",
4131    "file_icons": true,
4132    "folder_icons": true,
4133    "git_status": true,
4134    "indent_size": 20,
4135    "auto_reveal_entries": true,
4136    "auto_fold_dirs": true,
4137    "drag_and_drop": true,
4138    "scrollbar": {
4139      "show": null
4140    },
4141    "sticky_scroll": true,
4142    "show_diagnostics": "all",
4143    "indent_guides": {
4144      "show": "always"
4145    },
4146    "hide_root": false,
4147    "starts_open": true
4148  }
4149}
4150```
4151
4152### Dock
4153
4154- Description: Control the position of the dock
4155- Setting: `dock`
4156- Default: `left`
4157
4158**Options**
4159
41601. Default dock position to left
4161
4162```json
4163{
4164  "dock": "left"
4165}
4166```
4167
41682. Default dock position to right
4169
4170```json
4171{
4172  "dock": "right"
4173}
4174```
4175
4176### Entry Spacing
4177
4178- Description: Spacing between worktree entries
4179- Setting: `entry_spacing`
4180- Default: `comfortable`
4181
4182**Options**
4183
41841. Comfortable entry spacing
4185
4186```json
4187{
4188  "entry_spacing": "comfortable"
4189}
4190```
4191
41922. Standard entry spacing
4193
4194```json
4195{
4196  "entry_spacing": "standard"
4197}
4198```
4199
4200### Git Status
4201
4202- Description: Indicates newly created and updated files
4203- Setting: `git_status`
4204- Default: `true`
4205
4206**Options**
4207
42081. Default enable git status
4209
4210```json
4211{
4212  "git_status": true
4213}
4214```
4215
42162. Default disable git status
4217
4218```json
4219{
4220  "git_status": false
4221}
4222```
4223
4224### Default Width
4225
4226- Description: Customize default width taken by project panel
4227- Setting: `default_width`
4228- Default: `240`
4229
4230**Options**
4231
4232`float` values
4233
4234### Auto Reveal Entries
4235
4236- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4237- Setting: `auto_reveal_entries`
4238- Default: `true`
4239
4240**Options**
4241
42421. Enable auto reveal entries
4243
4244```json
4245{
4246  "auto_reveal_entries": true
4247}
4248```
4249
42502. Disable auto reveal entries
4251
4252```json
4253{
4254  "auto_reveal_entries": false
4255}
4256```
4257
4258### Auto Fold Dirs
4259
4260- Description: Whether to fold directories automatically when directory has only one directory inside.
4261- Setting: `auto_fold_dirs`
4262- Default: `true`
4263
4264**Options**
4265
42661. Enable auto fold dirs
4267
4268```json
4269{
4270  "auto_fold_dirs": true
4271}
4272```
4273
42742. Disable auto fold dirs
4275
4276```json
4277{
4278  "auto_fold_dirs": false
4279}
4280```
4281
4282### Indent Size
4283
4284- Description: Amount of indentation (in pixels) for nested items.
4285- Setting: `indent_size`
4286- Default: `20`
4287
4288### Indent Guides: Show
4289
4290- Description: Whether to show indent guides in the project panel.
4291- Setting: `indent_guides`
4292- Default:
4293
4294```json
4295"indent_guides": {
4296  "show": "always"
4297}
4298```
4299
4300**Options**
4301
43021. Show indent guides in the project panel
4303
4304```json
4305{
4306  "indent_guides": {
4307    "show": "always"
4308  }
4309}
4310```
4311
43122. Hide indent guides in the project panel
4313
4314```json
4315{
4316  "indent_guides": {
4317    "show": "never"
4318  }
4319}
4320```
4321
4322### Scrollbar: Show
4323
4324- 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.
4325- Setting: `scrollbar`
4326- Default:
4327
4328```json
4329"scrollbar": {
4330  "show": null
4331}
4332```
4333
4334**Options**
4335
43361. Show scrollbar in the project panel
4337
4338```json
4339{
4340  "scrollbar": {
4341    "show": "always"
4342  }
4343}
4344```
4345
43462. Hide scrollbar in the project panel
4347
4348```json
4349{
4350  "scrollbar": {
4351    "show": "never"
4352  }
4353}
4354```
4355
4356## Agent
4357
4358Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4359
4360## Collaboration Panel
4361
4362- Description: Customizations for the collaboration panel.
4363- Setting: `collaboration_panel`
4364- Default:
4365
4366```json
4367{
4368  "collaboration_panel": {
4369    "button": true,
4370    "dock": "left",
4371    "default_width": 240
4372  }
4373}
4374```
4375
4376**Options**
4377
4378- `button`: Whether to show the collaboration panel button in the status bar
4379- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4380- `default_width`: Default width of the collaboration panel
4381
4382## Chat Panel
4383
4384- Description: Customizations for the chat panel.
4385- Setting: `chat_panel`
4386- Default:
4387
4388```json
4389{
4390  "chat_panel": {
4391    "button": "when_in_call",
4392    "dock": "right",
4393    "default_width": 240
4394  }
4395}
4396```
4397
4398**Options**
4399
4400- `button`: When to show the chat panel button in the status bar. Can be `never`, `always`, or `when_in_call`.
4401- `dock`: Where to dock the chat panel. Can be 'left' or 'right'
4402- `default_width`: Default width of the chat panel
4403
4404## Debugger
4405
4406- Description: Configuration for debugger panel and settings
4407- Setting: `debugger`
4408- Default:
4409
4410```json
4411{
4412  "debugger": {
4413    "stepping_granularity": "line",
4414    "save_breakpoints": true,
4415    "dock": "bottom",
4416    "button": true
4417  }
4418}
4419```
4420
4421See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4422
4423## Git Panel
4424
4425- Description: Setting to customize the behavior of the git panel.
4426- Setting: `git_panel`
4427- Default:
4428
4429```json
4430{
4431  "git_panel": {
4432    "button": true,
4433    "dock": "left",
4434    "default_width": 360,
4435    "status_style": "icon",
4436    "fallback_branch_name": "main",
4437    "sort_by_path": false,
4438    "collapse_untracked_diff": false,
4439    "scrollbar": {
4440      "show": null
4441    }
4442  }
4443}
4444```
4445
4446**Options**
4447
4448- `button`: Whether to show the git panel button in the status bar
4449- `dock`: Where to dock the git panel. Can be `left` or `right`
4450- `default_width`: Default width of the git panel
4451- `status_style`: How to display git status. Can be `label_color` or `icon`
4452- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4453- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4454- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4455- `scrollbar`: When to show the scrollbar in the git panel
4456
4457## Outline Panel
4458
4459- Description: Customize outline Panel
4460- Setting: `outline_panel`
4461- Default:
4462
4463```json
4464"outline_panel": {
4465  "button": true,
4466  "default_width": 300,
4467  "dock": "left",
4468  "file_icons": true,
4469  "folder_icons": true,
4470  "git_status": true,
4471  "indent_size": 20,
4472  "auto_reveal_entries": true,
4473  "auto_fold_dirs": true,
4474  "indent_guides": {
4475    "show": "always"
4476  },
4477  "scrollbar": {
4478    "show": null
4479  }
4480}
4481```
4482
4483## Calls
4484
4485- Description: Customize behavior when participating in a call
4486- Setting: `calls`
4487- Default:
4488
4489```json
4490"calls": {
4491  // Join calls with the microphone live by default
4492  "mute_on_join": false,
4493  // Share your project when you are the first to join a channel
4494  "share_on_join": false
4495},
4496```
4497
4498## Unnecessary Code Fade
4499
4500- Description: How much to fade out unused code.
4501- Setting: `unnecessary_code_fade`
4502- Default: `0.3`
4503
4504**Options**
4505
4506Float values between `0.0` and `0.9`, where:
4507
4508- `0.0` means no fading (unused code looks the same as used code)
4509- `0.9` means maximum fading (unused code is very faint but still visible)
4510
4511**Example**
4512
4513```json
4514{
4515  "unnecessary_code_fade": 0.5
4516}
4517```
4518
4519## UI Font Family
4520
4521- Description: The name of the font to use for text in the UI.
4522- Setting: `ui_font_family`
4523- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4524
4525**Options**
4526
4527The 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).
4528
4529## UI Font Features
4530
4531- Description: The OpenType features to enable for text in the UI.
4532- Setting: `ui_font_features`
4533- Default:
4534
4535```json
4536"ui_font_features": {
4537  "calt": false
4538}
4539```
4540
4541- Platform: macOS and Windows.
4542
4543**Options**
4544
4545Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4546
4547For example, to disable font ligatures, add the following to your settings:
4548
4549```json
4550{
4551  "ui_font_features": {
4552    "calt": false
4553  }
4554}
4555```
4556
4557You can also set other OpenType features, like setting `cv01` to `7`:
4558
4559```json
4560{
4561  "ui_font_features": {
4562    "cv01": 7
4563  }
4564}
4565```
4566
4567## UI Font Fallbacks
4568
4569- Description: The font fallbacks to use for text in the UI.
4570- Setting: `ui_font_fallbacks`
4571- Default: `null`
4572- Platform: macOS and Windows.
4573
4574**Options**
4575
4576For example, to use `Nerd Font` as a fallback, add the following to your settings:
4577
4578```json
4579{
4580  "ui_font_fallbacks": ["Nerd Font"]
4581}
4582```
4583
4584## UI Font Size
4585
4586- Description: The default font size for text in the UI.
4587- Setting: `ui_font_size`
4588- Default: `16`
4589
4590**Options**
4591
4592`integer` values from `6` to `100` pixels (inclusive)
4593
4594## UI Font Weight
4595
4596- Description: The default font weight for text in the UI.
4597- Setting: `ui_font_weight`
4598- Default: `400`
4599
4600**Options**
4601
4602`integer` values between `100` and `900`
4603
4604## An example configuration:
4605
4606```json
4607// ~/.config/zed/settings.json
4608{
4609  "theme": "cave-light",
4610  "tab_size": 2,
4611  "preferred_line_length": 80,
4612  "soft_wrap": "none",
4613
4614  "buffer_font_size": 18,
4615  "buffer_font_family": ".ZedMono",
4616
4617  "autosave": "on_focus_change",
4618  "format_on_save": "off",
4619  "vim_mode": false,
4620  "projects_online_by_default": true,
4621  "terminal": {
4622    "font_family": "FiraCode Nerd Font Mono",
4623    "blinking": "off"
4624  },
4625  "languages": {
4626    "C": {
4627      "format_on_save": "language_server",
4628      "preferred_line_length": 64,
4629      "soft_wrap": "preferred_line_length"
4630    }
4631  }
4632}
4633```