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