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