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