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