configuring-zed.md

   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 Editor
   8
   9You can browse through many of the supported settings via the Settings Editor, which can be opened with the {#kb zed::OpenSettings} keybinding, or through the `zed: open settings` action in the command palette. Through it, you can customize your local, user settings as well as project settings.
  10
  11> Note that not all settings that Zed supports are available through the Settings Editor yet.
  12> Some more intricate ones, such as language formatters, can only be changed through the JSON settings file {#kb zed::OpenSettingsFile}.
  13
  14## User Settings File
  15
  16<!--
  17TBD: Settings files. Rewrite with "remote settings" in mind (e.g. `local settings` on the remote host).
  18Consider renaming `zed: Open Local Settings` to `zed: Open Project Settings`.
  19
  20TBD: 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.
  21-->
  22
  23Your settings JSON file can be opened with {#kb zed::OpenSettingsFile}.
  24By 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.
  25
  26Whatever you have added to your user settings file gets merged with any local configuration inside your projects.
  27
  28### Default Settings
  29
  30In the Settings Editor, the values you see set are the default ones.
  31You can also verify them in JSON by running {#action zed::OpenDefaultSettings} from the command palette.
  32
  33Extensions that provide language servers may also provide default settings for those language servers.
  34
  35## Project Settings File
  36
  37Similarly to user files, you can open your project settings file by running {#action zed::OpenProjectSettings} from the command palette.
  38This will create a `.zed` directory containing`.zed/settings.json`.
  39
  40Although most projects will only need one settings file at the root, you can add more local settings files for subdirectories as needed.
  41Not all settings can be set in local files, just those that impact the behavior of the editor and language tooling.
  42For example you can set `tab_size`, `formatter` etc. but not `theme`, `vim_mode` and similar.
  43
  44The syntax for configuration files is a super-set of JSON that allows `//` comments.
  45
  46## Per-release Channel Overrides
  47
  48Zed reads the same `settings.json` across all release channels (Stable, Preview or Nightly).
  49However, you can scope overrides to a specific channel by adding top-level `stable`, `preview`, `nightly` or `dev` objects.
  50They are merged into the base configuration with settings from these keys taking precedence upon launching the specified build. For example:
  51
  52```json [settings]
  53{
  54  "theme": "sunset",
  55  "vim_mode": false,
  56  "nightly": {
  57    "theme": "cave-light",
  58    "vim_mode": true
  59  },
  60  "preview": {
  61    "theme": "zed-dark"
  62  }
  63}
  64```
  65
  66With this configuration, Stable keeps all base preferences, Preview switches to `zed-dark`, and Nightly enables Vim mode with a different theme.
  67
  68Changing settings in the Settings Editorwill always apply the change across all channels.
  69
  70# Settings
  71
  72Find below an extensive run-through of many supported settings by Zed.
  73
  74## Active Pane Modifiers
  75
  76- Description: Styling settings applied to the active pane.
  77- Setting: `active_pane_modifiers`
  78- Default:
  79
  80```json [settings]
  81{
  82  "active_pane_modifiers": {
  83    "border_size": 0.0,
  84    "inactive_opacity": 1.0
  85  }
  86}
  87```
  88
  89### Border size
  90
  91- 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.
  92- Setting: `border_size`
  93- Default: `0.0`
  94
  95**Options**
  96
  97Non-negative `float` values
  98
  99### Inactive Opacity
 100
 101- 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.
 102- Setting: `inactive_opacity`
 103- Default: `1.0`
 104
 105**Options**
 106
 107`float` values
 108
 109## Bottom Dock Layout
 110
 111- Description: Control the layout of the bottom dock, relative to the left and right docks.
 112- Setting: `bottom_dock_layout`
 113- Default: `"contained"`
 114
 115**Options**
 116
 1171. Contain the bottom dock, giving the full height of the window to the left and right docks.
 118
 119```json [settings]
 120{
 121  "bottom_dock_layout": "contained"
 122}
 123```
 124
 1252. Give the bottom dock the full width of the window, truncating the left and right docks.
 126
 127```json [settings]
 128{
 129  "bottom_dock_layout": "full"
 130}
 131```
 132
 1333. Left align the bottom dock, truncating the left dock and giving the right dock the full height of the window.
 134
 135```json [settings]
 136{
 137  "bottom_dock_layout": "left_aligned"
 138}
 139```
 140
 1414. Right align the bottom dock, giving the left dock the full height of the window and truncating the right dock.
 142
 143```json [settings]
 144{
 145  "bottom_dock_layout": "right_aligned"
 146}
 147```
 148
 149## Agent Font Size
 150
 151- Description: The font size for text in the agent panel. Inherits the UI font size if unset.
 152- Setting: `agent_font_size`
 153- Default: `null`
 154
 155**Options**
 156
 157`integer` values from `6` to `100` pixels (inclusive)
 158
 159## Allow Rewrap
 160
 161- Description: Controls where the {#action editor::Rewrap} action is allowed in the current language scope
 162- Setting: `allow_rewrap`
 163- Default: `"in_comments"`
 164
 165**Options**
 166
 1671. Allow rewrap in comments only:
 168
 169```json [settings]
 170{
 171  "allow_rewrap": "in_comments"
 172}
 173```
 174
 1752. Allow rewrap in selections only:
 176
 177```json [settings]
 178{
 179  "allow_rewrap": "in_selections"
 180}
 181```
 182
 1833. Allow rewrap anywhere:
 184
 185```json [settings]
 186{
 187  "allow_rewrap": "anywhere"
 188}
 189```
 190
 191Note: This setting has no effect in Vim mode, as rewrap is already allowed everywhere.
 192
 193## Auto Indent
 194
 195- Description: Whether indentation should be adjusted based on the context whilst typing. This can be specified on a per-language basis.
 196- Setting: `auto_indent`
 197- Default: `true`
 198
 199**Options**
 200
 201`boolean` values
 202
 203## Auto Indent On Paste
 204
 205- Description: Whether indentation of pasted content should be adjusted based on the context
 206- Setting: `auto_indent_on_paste`
 207- Default: `true`
 208
 209**Options**
 210
 211`boolean` values
 212
 213## Auto Install extensions
 214
 215- Description: Define extensions to be autoinstalled or never be installed.
 216- Setting: `auto_install_extensions`
 217- Default: `{ "html": true }`
 218
 219**Options**
 220
 221You can find the names of your currently installed extensions by listing the subfolders under the [extension installation location](./extensions/installing-extensions.md#installation-location):
 222
 223On macOS:
 224
 225```sh
 226ls ~/Library/Application\ Support/Zed/extensions/installed/
 227```
 228
 229On Linux:
 230
 231```sh
 232ls ~/.local/share/zed/extensions/installed
 233```
 234
 235Define extensions which should be installed (`true`) or never installed (`false`).
 236
 237```json [settings]
 238{
 239  "auto_install_extensions": {
 240    "html": true,
 241    "dockerfile": true,
 242    "docker-compose": false
 243  }
 244}
 245```
 246
 247## Autosave
 248
 249- Description: When to automatically save edited buffers.
 250- Setting: `autosave`
 251- Default: `off`
 252
 253**Options**
 254
 2551. To disable autosave, set it to `off`:
 256
 257```json [settings]
 258{
 259  "autosave": "off"
 260}
 261```
 262
 2632. To autosave when focus changes, use `on_focus_change`:
 264
 265```json [settings]
 266{
 267  "autosave": "on_focus_change"
 268}
 269```
 270
 2713. To autosave when the active window changes, use `on_window_change`:
 272
 273```json [settings]
 274{
 275  "autosave": "on_window_change"
 276}
 277```
 278
 2794. To autosave after an inactivity period, use `after_delay`:
 280
 281```json [settings]
 282{
 283  "autosave": {
 284    "after_delay": {
 285      "milliseconds": 1000
 286    }
 287  }
 288}
 289```
 290
 291Note that a save will be triggered when an unsaved tab is closed, even if this is earlier than the configured inactivity period.
 292
 293## Autoscroll on Clicks
 294
 295- Description: Whether to scroll when clicking near the edge of the visible text area.
 296- Setting: `autoscroll_on_clicks`
 297- Default: `false`
 298
 299**Options**
 300
 301`boolean` values
 302
 303## Auto Signature Help
 304
 305- Description: Show method signatures in the editor, when inside parentheses
 306- Setting: `auto_signature_help`
 307- Default: `false`
 308
 309**Options**
 310
 311`boolean` values
 312
 313### Show Signature Help After Edits
 314
 315- 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.
 316- Setting: `show_signature_help_after_edits`
 317- Default: `false`
 318
 319**Options**
 320
 321`boolean` values
 322
 323## Auto Update
 324
 325- Description: Whether or not to automatically check for updates.
 326- Setting: `auto_update`
 327- Default: `true`
 328
 329**Options**
 330
 331`boolean` values
 332
 333## Base Keymap
 334
 335- Description: Base key bindings scheme. Base keymaps can be overridden with user keymaps.
 336- Setting: `base_keymap`
 337- Default: `VSCode`
 338
 339**Options**
 340
 3411. VS Code
 342
 343```json [settings]
 344{
 345  "base_keymap": "VSCode"
 346}
 347```
 348
 3492. Atom
 350
 351```json [settings]
 352{
 353  "base_keymap": "Atom"
 354}
 355```
 356
 3573. JetBrains
 358
 359```json [settings]
 360{
 361  "base_keymap": "JetBrains"
 362}
 363```
 364
 3654. None
 366
 367```json [settings]
 368{
 369  "base_keymap": "None"
 370}
 371```
 372
 3735. Sublime Text
 374
 375```json [settings]
 376{
 377  "base_keymap": "SublimeText"
 378}
 379```
 380
 3816. TextMate
 382
 383```json [settings]
 384{
 385  "base_keymap": "TextMate"
 386}
 387```
 388
 389## Buffer Font Family
 390
 391- Description: The name of a font to use for rendering text in the editor.
 392- Setting: `buffer_font_family`
 393- Default: `.ZedMono`. This currently aliases to [Lilex](https://lilex.myrt.co).
 394
 395**Options**
 396
 397The name of any font family installed on the user's system, or `".ZedMono"`.
 398
 399## Buffer Font Features
 400
 401- Description: The OpenType features to enable for text in the editor.
 402- Setting: `buffer_font_features`
 403- Default: `null`
 404- Platform: macOS and Windows.
 405
 406**Options**
 407
 408Zed 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.
 409
 410For example, to disable font ligatures, add the following to your settings:
 411
 412```json [settings]
 413{
 414  "buffer_font_features": {
 415    "calt": false
 416  }
 417}
 418```
 419
 420You can also set other OpenType features, like setting `cv01` to `7`:
 421
 422```json [settings]
 423{
 424  "buffer_font_features": {
 425    "cv01": 7
 426  }
 427}
 428```
 429
 430## Buffer Font Fallbacks
 431
 432- Description: Set the buffer text's font fallbacks, this will be merged with the platform's default fallbacks.
 433- Setting: `buffer_font_fallbacks`
 434- Default: `null`
 435- Platform: macOS and Windows.
 436
 437**Options**
 438
 439For example, to use `Nerd Font` as a fallback, add the following to your settings:
 440
 441```json [settings]
 442{
 443  "buffer_font_fallbacks": ["Nerd Font"]
 444}
 445```
 446
 447## Buffer Font Size
 448
 449- Description: The default font size for text in the editor.
 450- Setting: `buffer_font_size`
 451- Default: `15`
 452
 453**Options**
 454
 455A font size from `6` to `100` pixels (inclusive)
 456
 457## Buffer Font Weight
 458
 459- Description: The default font weight for text in the editor.
 460- Setting: `buffer_font_weight`
 461- Default: `400`
 462
 463**Options**
 464
 465`integer` values between `100` and `900`
 466
 467## Buffer Line Height
 468
 469- Description: The default line height for text in the editor.
 470- Setting: `buffer_line_height`
 471- Default: `"comfortable"`
 472
 473**Options**
 474
 475`"standard"`, `"comfortable"` or `{ "custom": float }` (`1` is compact, `2` is loose)
 476
 477## Centered Layout
 478
 479- Description: Configuration for the centered layout mode.
 480- Setting: `centered_layout`
 481- Default:
 482
 483```json [settings]
 484"centered_layout": {
 485  "left_padding": 0.2,
 486  "right_padding": 0.2,
 487}
 488```
 489
 490**Options**
 491
 492The `left_padding` and `right_padding` options define the relative width of the
 493left 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`.
 494
 495## Close on File Delete
 496
 497- Description: Whether to automatically close editor tabs when their corresponding files are deleted from disk.
 498- Setting: `close_on_file_delete`
 499- Default: `false`
 500
 501**Options**
 502
 503`boolean` values
 504
 505When 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.
 506
 507Note: Dirty files (files with unsaved changes) will not be automatically closed even when this setting is enabled, ensuring you don't lose unsaved work.
 508
 509## Confirm Quit
 510
 511- Description: Whether or not to prompt the user to confirm before closing the application.
 512- Setting: `confirm_quit`
 513- Default: `false`
 514
 515**Options**
 516
 517`boolean` values
 518
 519## Diagnostics Max Severity
 520
 521- Description: Which level to use to filter out diagnostics displayed in the editor
 522- Setting: `diagnostics_max_severity`
 523- Default: `null`
 524
 525**Options**
 526
 5271. Allow all diagnostics (default):
 528
 529```json [settings]
 530{
 531  "diagnostics_max_severity": "all"
 532}
 533```
 534
 5352. Show only errors:
 536
 537```json [settings]
 538{
 539  "diagnostics_max_severity": "error"
 540}
 541```
 542
 5433. Show errors and warnings:
 544
 545```json [settings]
 546{
 547  "diagnostics_max_severity": "warning"
 548}
 549```
 550
 5514. Show errors, warnings, and information:
 552
 553```json [settings]
 554{
 555  "diagnostics_max_severity": "info"
 556}
 557```
 558
 5595. Show all including hints:
 560
 561```json [settings]
 562{
 563  "diagnostics_max_severity": "hint"
 564}
 565```
 566
 567## Disable AI
 568
 569- Description: Whether to disable all AI features in Zed
 570- Setting: `disable_ai`
 571- Default: `false`
 572
 573**Options**
 574
 575`boolean` values
 576
 577## Direnv Integration
 578
 579- Description: Settings for [direnv](https://direnv.net/) integration. Requires `direnv` to be installed.
 580  `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.
 581  It also allows for those environment variables to be used in tasks.
 582- Setting: `load_direnv`
 583- Default: `"direct"`
 584
 585**Options**
 586
 587There are three options to choose from:
 588
 5891. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
 5902. `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.
 5913. `disabled`: No shell environment will be loaded automatically; direnv must be invoked manually (e.g. with `direnv exec`) to be used.
 592
 593## Double Click In Multibuffer
 594
 595- Description: What to do when multibuffer is double clicked in some of its excerpts (parts of singleton buffers)
 596- Setting: `double_click_in_multibuffer`
 597- Default: `"select"`
 598
 599**Options**
 600
 6011. Behave as a regular buffer and select the whole word (default):
 602
 603```json [settings]
 604{
 605  "double_click_in_multibuffer": "select"
 606}
 607```
 608
 6092. Open the excerpt clicked as a new buffer in the new tab:
 610
 611```json [settings]
 612{
 613  "double_click_in_multibuffer": "open"
 614}
 615```
 616
 617For the case of "open", regular selection behavior can be achieved by holding `alt` when double clicking.
 618
 619## Drop Target Size
 620
 621- 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.
 622- Setting: `drop_target_size`
 623- Default: `0.2`
 624
 625**Options**
 626
 627`float` values between `0` and `0.5`
 628
 629## Edit Predictions
 630
 631- Description: Settings for edit predictions.
 632- Setting: `edit_predictions`
 633- Default:
 634
 635```json [settings]
 636  "edit_predictions": {
 637    "disabled_globs": [
 638      "**/.env*",
 639      "**/*.pem",
 640      "**/*.key",
 641      "**/*.cert",
 642      "**/*.crt",
 643      "**/.dev.vars",
 644      "**/secrets.yml"
 645    ]
 646  }
 647```
 648
 649**Options**
 650
 651### Disabled Globs
 652
 653- 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.
 654- Setting: `disabled_globs`
 655- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/.dev.vars", "**/secrets.yml"]`
 656
 657**Options**
 658
 659List of `string` values.
 660
 661## Edit Predictions Disabled in
 662
 663- Description: A list of language scopes in which edit predictions should be disabled.
 664- Setting: `edit_predictions_disabled_in`
 665- Default: `[]`
 666
 667**Options**
 668
 669List of `string` values
 670
 6711. Don't show edit predictions in comments:
 672
 673```json [settings]
 674"disabled_in": ["comment"]
 675```
 676
 6772. Don't show edit predictions in strings and comments:
 678
 679```json [settings]
 680"disabled_in": ["comment", "string"]
 681```
 682
 6833. Only in Go, don't show edit predictions in strings and comments:
 684
 685```json [settings]
 686{
 687  "languages": {
 688    "Go": {
 689      "edit_predictions_disabled_in": ["comment", "string"]
 690    }
 691  }
 692}
 693```
 694
 695## Current Line Highlight
 696
 697- Description: How to highlight the current line in the editor.
 698- Setting: `current_line_highlight`
 699- Default: `all`
 700
 701**Options**
 702
 7031. Don't highlight the current line:
 704
 705```json [settings]
 706"current_line_highlight": "none"
 707```
 708
 7092. Highlight the gutter area:
 710
 711```json [settings]
 712"current_line_highlight": "gutter"
 713```
 714
 7153. Highlight the editor area:
 716
 717```json [settings]
 718"current_line_highlight": "line"
 719```
 720
 7214. Highlight the full line:
 722
 723```json [settings]
 724"current_line_highlight": "all"
 725```
 726
 727## Selection Highlight
 728
 729- Description: Whether to highlight all occurrences of the selected text in an editor.
 730- Setting: `selection_highlight`
 731- Default: `true`
 732
 733## Rounded Selection
 734
 735- Description: Whether the text selection should have rounded corners.
 736- Setting: `rounded_selection`
 737- Default: `true`
 738
 739## Cursor Blink
 740
 741- Description: Whether or not the cursor blinks.
 742- Setting: `cursor_blink`
 743- Default: `true`
 744
 745**Options**
 746
 747`boolean` values
 748
 749## Cursor Shape
 750
 751- Description: Cursor shape for the default editor.
 752- Setting: `cursor_shape`
 753- Default: `bar`
 754
 755**Options**
 756
 7571. A vertical bar:
 758
 759```json [settings]
 760"cursor_shape": "bar"
 761```
 762
 7632. A block that surrounds the following character:
 764
 765```json [settings]
 766"cursor_shape": "block"
 767```
 768
 7693. An underline / underscore that runs along the following character:
 770
 771```json [settings]
 772"cursor_shape": "underline"
 773```
 774
 7754. An box drawn around the following character:
 776
 777```json [settings]
 778"cursor_shape": "hollow"
 779```
 780
 781## Gutter
 782
 783- Description: Settings for the editor gutter
 784- Setting: `gutter`
 785- Default:
 786
 787```json [settings]
 788{
 789  "gutter": {
 790    "line_numbers": true,
 791    "runnables": true,
 792    "breakpoints": true,
 793    "folds": true,
 794    "min_line_number_digits": 4
 795  }
 796}
 797```
 798
 799**Options**
 800
 801- `line_numbers`: Whether to show line numbers in the gutter
 802- `runnables`: Whether to show runnable buttons in the gutter
 803- `breakpoints`: Whether to show breakpoints in the gutter
 804- `folds`: Whether to show fold buttons in the gutter
 805- `min_line_number_digits`: Minimum number of characters to reserve space for in the gutter
 806
 807## Hide Mouse
 808
 809- Description: Determines when the mouse cursor should be hidden in an editor or input box.
 810- Setting: `hide_mouse`
 811- Default: `on_typing_and_movement`
 812
 813**Options**
 814
 8151. Never hide the mouse cursor:
 816
 817```json [settings]
 818"hide_mouse": "never"
 819```
 820
 8212. Hide only when typing:
 822
 823```json [settings]
 824"hide_mouse": "on_typing"
 825```
 826
 8273. Hide on both typing and cursor movement:
 828
 829```json [settings]
 830"hide_mouse": "on_typing_and_movement"
 831```
 832
 833## Snippet Sort Order
 834
 835- Description: Determines how snippets are sorted relative to other completion items.
 836- Setting: `snippet_sort_order`
 837- Default: `inline`
 838
 839**Options**
 840
 8411. Place snippets at the top of the completion list:
 842
 843```json [settings]
 844"snippet_sort_order": "top"
 845```
 846
 8472. Place snippets normally without any preference:
 848
 849```json [settings]
 850"snippet_sort_order": "inline"
 851```
 852
 8533. Place snippets at the bottom of the completion list:
 854
 855```json [settings]
 856"snippet_sort_order": "bottom"
 857```
 858
 8594. Do not show snippets in the completion list at all:
 860
 861```json [settings]
 862"snippet_sort_order": "none"
 863```
 864
 865## Editor Scrollbar
 866
 867- Description: Whether or not to show the editor scrollbar and various elements in it.
 868- Setting: `scrollbar`
 869- Default:
 870
 871```json [settings]
 872"scrollbar": {
 873  "show": "auto",
 874  "cursors": true,
 875  "git_diff": true,
 876  "search_results": true,
 877  "selected_text": true,
 878  "selected_symbol": true,
 879  "diagnostics": "all",
 880  "axes": {
 881    "horizontal": true,
 882    "vertical": true,
 883  },
 884},
 885```
 886
 887### Show Mode
 888
 889- Description: When to show the editor scrollbar.
 890- Setting: `show`
 891- Default: `auto`
 892
 893**Options**
 894
 8951. Show the scrollbar if there's important information or follow the system's configured behavior:
 896
 897```json [settings]
 898"scrollbar": {
 899  "show": "auto"
 900}
 901```
 902
 9032. Match the system's configured behavior:
 904
 905```json [settings]
 906"scrollbar": {
 907  "show": "system"
 908}
 909```
 910
 9113. Always show the scrollbar:
 912
 913```json [settings]
 914"scrollbar": {
 915  "show": "always"
 916}
 917```
 918
 9194. Never show the scrollbar:
 920
 921```json [settings]
 922"scrollbar": {
 923  "show": "never"
 924}
 925```
 926
 927### Cursor Indicators
 928
 929- Description: Whether to show cursor positions in the scrollbar.
 930- Setting: `cursors`
 931- Default: `true`
 932
 933Cursor indicators appear as small marks on the scrollbar showing where other collaborators' cursors are positioned in the file.
 934
 935**Options**
 936
 937`boolean` values
 938
 939### Git Diff Indicators
 940
 941- Description: Whether to show git diff indicators in the scrollbar.
 942- Setting: `git_diff`
 943- Default: `true`
 944
 945Git diff indicators appear as colored marks showing lines that have been added, modified, or deleted compared to the git HEAD.
 946
 947**Options**
 948
 949`boolean` values
 950
 951### Search Results Indicators
 952
 953- Description: Whether to show buffer search results in the scrollbar.
 954- Setting: `search_results`
 955- Default: `true`
 956
 957Search result indicators appear as marks showing all locations in the file where your current search query matches.
 958
 959**Options**
 960
 961`boolean` values
 962
 963### Selected Text Indicators
 964
 965- Description: Whether to show selected text occurrences in the scrollbar.
 966- Setting: `selected_text`
 967- Default: `true`
 968
 969Selected text indicators appear as marks showing all occurrences of the currently selected text throughout the file.
 970
 971**Options**
 972
 973`boolean` values
 974
 975### Selected Symbols Indicators
 976
 977- Description: Whether to show selected symbol occurrences in the scrollbar.
 978- Setting: `selected_symbol`
 979- Default: `true`
 980
 981Selected symbol indicators appear as marks showing all occurrences of the currently selected symbol (like a function or variable name) throughout the file.
 982
 983**Options**
 984
 985`boolean` values
 986
 987### Diagnostics
 988
 989- Description: Which diagnostic indicators to show in the scrollbar.
 990- Setting: `diagnostics`
 991- Default: `all`
 992
 993Diagnostic indicators appear as colored marks showing errors, warnings, and other language server diagnostics at their corresponding line positions in the file.
 994
 995**Options**
 996
 9971. Show all diagnostics:
 998
 999```json [settings]
1000{
1001  "show_diagnostics": "all"
1002}
1003```
1004
10052. Do not show any diagnostics:
1006
1007```json [settings]
1008{
1009  "show_diagnostics": "off"
1010}
1011```
1012
10133. Show only errors:
1014
1015```json [settings]
1016{
1017  "show_diagnostics": "error"
1018}
1019```
1020
10214. Show only errors and warnings:
1022
1023```json [settings]
1024{
1025  "show_diagnostics": "warning"
1026}
1027```
1028
10295. Show only errors, warnings, and information:
1030
1031```json [settings]
1032{
1033  "show_diagnostics": "info"
1034}
1035```
1036
1037### Axes
1038
1039- Description: Forcefully enable or disable the scrollbar for each axis
1040- Setting: `axes`
1041- Default:
1042
1043```json [settings]
1044"scrollbar": {
1045  "axes": {
1046    "horizontal": true,
1047    "vertical": true,
1048  },
1049}
1050```
1051
1052#### Horizontal
1053
1054- Description: When false, forcefully disables the horizontal scrollbar. Otherwise, obey other settings.
1055- Setting: `horizontal`
1056- Default: `true`
1057
1058**Options**
1059
1060`boolean` values
1061
1062#### Vertical
1063
1064- Description: When false, forcefully disables the vertical scrollbar. Otherwise, obey other settings.
1065- Setting: `vertical`
1066- Default: `true`
1067
1068**Options**
1069
1070`boolean` values
1071
1072## Minimap
1073
1074- Description: Settings related to the editor's minimap, which provides an overview of your document.
1075- Setting: `minimap`
1076- Default:
1077
1078```json [settings]
1079{
1080  "minimap": {
1081    "show": "never",
1082    "thumb": "always",
1083    "thumb_border": "left_open",
1084    "current_line_highlight": null
1085  }
1086}
1087```
1088
1089### Show Mode
1090
1091- Description: When to show the minimap in the editor.
1092- Setting: `show`
1093- Default: `never`
1094
1095**Options**
1096
10971. Always show the minimap:
1098
1099```json [settings]
1100{
1101  "show": "always"
1102}
1103```
1104
11052. Show the minimap if the editor's scrollbars are visible:
1106
1107```json [settings]
1108{
1109  "show": "auto"
1110}
1111```
1112
11133. Never show the minimap:
1114
1115```json [settings]
1116{
1117  "show": "never"
1118}
1119```
1120
1121### Thumb Display
1122
1123- Description: When to show the minimap thumb (the visible editor area) in the minimap.
1124- Setting: `thumb`
1125- Default: `always`
1126
1127**Options**
1128
11291. Show the minimap thumb when hovering over the minimap:
1130
1131```json [settings]
1132{
1133  "thumb": "hover"
1134}
1135```
1136
11372. Always show the minimap thumb:
1138
1139```json [settings]
1140{
1141  "thumb": "always"
1142}
1143```
1144
1145### Thumb Border
1146
1147- Description: How the minimap thumb border should look.
1148- Setting: `thumb_border`
1149- Default: `left_open`
1150
1151**Options**
1152
11531. Display a border on all sides of the thumb:
1154
1155```json [settings]
1156{
1157  "thumb_border": "full"
1158}
1159```
1160
11612. Display a border on all sides except the left side:
1162
1163```json [settings]
1164{
1165  "thumb_border": "left_open"
1166}
1167```
1168
11693. Display a border on all sides except the right side:
1170
1171```json [settings]
1172{
1173  "thumb_border": "right_open"
1174}
1175```
1176
11774. Display a border only on the left side:
1178
1179```json [settings]
1180{
1181  "thumb_border": "left_only"
1182}
1183```
1184
11855. Display the thumb without any border:
1186
1187```json [settings]
1188{
1189  "thumb_border": "none"
1190}
1191```
1192
1193### Current Line Highlight
1194
1195- Description: How to highlight the current line in the minimap.
1196- Setting: `current_line_highlight`
1197- Default: `null`
1198
1199**Options**
1200
12011. Inherit the editor's current line highlight setting:
1202
1203```json [settings]
1204{
1205  "minimap": {
1206    "current_line_highlight": null
1207  }
1208}
1209```
1210
12112. Highlight the current line in the minimap:
1212
1213```json [settings]
1214{
1215  "minimap": {
1216    "current_line_highlight": "line"
1217  }
1218}
1219```
1220
1221or
1222
1223```json [settings]
1224{
1225  "minimap": {
1226    "current_line_highlight": "all"
1227  }
1228}
1229```
1230
12313. Do not highlight the current line in the minimap:
1232
1233```json [settings]
1234{
1235  "minimap": {
1236    "current_line_highlight": "gutter"
1237  }
1238}
1239```
1240
1241or
1242
1243```json [settings]
1244{
1245  "minimap": {
1246    "current_line_highlight": "none"
1247  }
1248}
1249```
1250
1251## Editor Tab Bar
1252
1253- Description: Settings related to the editor's tab bar.
1254- Settings: `tab_bar`
1255- Default:
1256
1257```json [settings]
1258"tab_bar": {
1259  "show": true,
1260  "show_nav_history_buttons": true,
1261  "show_tab_bar_buttons": true
1262}
1263```
1264
1265### Show
1266
1267- Description: Whether or not to show the tab bar in the editor.
1268- Setting: `show`
1269- Default: `true`
1270
1271**Options**
1272
1273`boolean` values
1274
1275### Navigation History Buttons
1276
1277- Description: Whether or not to show the navigation history buttons.
1278- Setting: `show_nav_history_buttons`
1279- Default: `true`
1280
1281**Options**
1282
1283`boolean` values
1284
1285### Tab Bar Buttons
1286
1287- Description: Whether or not to show the tab bar buttons.
1288- Setting: `show_tab_bar_buttons`
1289- Default: `true`
1290
1291**Options**
1292
1293`boolean` values
1294
1295## Editor Tabs
1296
1297- Description: Configuration for the editor tabs.
1298- Setting: `tabs`
1299- Default:
1300
1301```json [settings]
1302"tabs": {
1303  "close_position": "right",
1304  "file_icons": false,
1305  "git_status": false,
1306  "activate_on_close": "history",
1307  "show_close_button": "hover",
1308  "show_diagnostics": "off"
1309},
1310```
1311
1312### Close Position
1313
1314- Description: Where to display close button within a tab.
1315- Setting: `close_position`
1316- Default: `right`
1317
1318**Options**
1319
13201. Display the close button on the right:
1321
1322```json [settings]
1323{
1324  "close_position": "right"
1325}
1326```
1327
13282. Display the close button on the left:
1329
1330```json [settings]
1331{
1332  "close_position": "left"
1333}
1334```
1335
1336### File Icons
1337
1338- Description: Whether to show the file icon for a tab.
1339- Setting: `file_icons`
1340- Default: `false`
1341
1342### Git Status
1343
1344- Description: Whether or not to show Git file status in tab.
1345- Setting: `git_status`
1346- Default: `false`
1347
1348### Activate on close
1349
1350- Description: What to do after closing the current tab.
1351- Setting: `activate_on_close`
1352- Default: `history`
1353
1354**Options**
1355
13561.  Activate the tab that was open previously:
1357
1358```json [settings]
1359{
1360  "activate_on_close": "history"
1361}
1362```
1363
13642. Activate the right neighbour tab if present:
1365
1366```json [settings]
1367{
1368  "activate_on_close": "neighbour"
1369}
1370```
1371
13723. Activate the left neighbour tab if present:
1373
1374```json [settings]
1375{
1376  "activate_on_close": "left_neighbour"
1377}
1378```
1379
1380### Show close button
1381
1382- Description: Controls the appearance behavior of the tab's close button.
1383- Setting: `show_close_button`
1384- Default: `hover`
1385
1386**Options**
1387
13881.  Show it just upon hovering the tab:
1389
1390```json [settings]
1391{
1392  "show_close_button": "hover"
1393}
1394```
1395
13962. Show it persistently:
1397
1398```json [settings]
1399{
1400  "show_close_button": "always"
1401}
1402```
1403
14043. Never show it, even if hovering it:
1405
1406```json [settings]
1407{
1408  "show_close_button": "hidden"
1409}
1410```
1411
1412### Show Diagnostics
1413
1414- 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.
1415- Setting: `show_diagnostics`
1416- Default: `off`
1417
1418**Options**
1419
14201. Do not mark any files:
1421
1422```json [settings]
1423{
1424  "show_diagnostics": "off"
1425}
1426```
1427
14282. Only mark files with errors:
1429
1430```json [settings]
1431{
1432  "show_diagnostics": "errors"
1433}
1434```
1435
14363. Mark files with errors and warnings:
1437
1438```json [settings]
1439{
1440  "show_diagnostics": "all"
1441}
1442```
1443
1444### Show Inline Code Actions
1445
1446- Description: Whether to show code action button at start of buffer line.
1447- Setting: `inline_code_actions`
1448- Default: `true`
1449
1450**Options**
1451
1452`boolean` values
1453
1454### Session
1455
1456- Description: Controls Zed lifecycle-related behavior.
1457- Setting: `session`
1458- Default:
1459
1460```json
1461{
1462  "session": {
1463    "restore_unsaved_buffers": true,
1464    "trust_all_worktrees": false
1465  }
1466}
1467```
1468
1469**Options**
1470
14711.  Whether or not to restore unsaved buffers on restart:
1472
1473```json [settings]
1474{
1475  "session": {
1476    "restore_unsaved_buffers": true
1477  }
1478}
1479```
1480
1481If this is true, user won't be prompted whether to save/discard dirty files when closing the application.
1482
14832. Whether or not to skip worktree and workspace trust checks:
1484
1485```json [settings]
1486{
1487  "session": {
1488    "trust_all_worktrees": false
1489  }
1490}
1491```
1492
1493When trusted, project settings are synchronized automatically, language and MCP servers are downloaded and started automatically.
1494
1495### Drag And Drop Selection
1496
1497- 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.
1498- Setting: `drag_and_drop_selection`
1499- Default:
1500
1501```json [settings]
1502"drag_and_drop_selection": {
1503  "enabled": true,
1504  "delay": 300
1505}
1506```
1507
1508## Editor Toolbar
1509
1510- Description: Whether or not to show various elements in the editor toolbar.
1511- Setting: `toolbar`
1512- Default:
1513
1514```json [settings]
1515"toolbar": {
1516  "breadcrumbs": true,
1517  "quick_actions": true,
1518  "selections_menu": true,
1519  "agent_review": true,
1520  "code_actions": false
1521},
1522```
1523
1524**Options**
1525
1526Each option controls displaying of a particular toolbar element. If all elements are hidden, the editor toolbar is not displayed.
1527
1528## Use System Tabs
1529
1530- Description: Whether to allow windows to tab together based on the user’s tabbing preference (macOS only).
1531- Setting: `use_system_window_tabs`
1532- Default: `false`
1533
1534**Options**
1535
1536This 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.
1537
1538## Enable Language Server
1539
1540- Description: Whether or not to use language servers to provide code intelligence.
1541- Setting: `enable_language_server`
1542- Default: `true`
1543
1544**Options**
1545
1546`boolean` values
1547
1548## Ensure Final Newline On Save
1549
1550- Description: Removes any lines containing only whitespace at the end of the file and ensures just one newline at the end.
1551- Setting: `ensure_final_newline_on_save`
1552- Default: `true`
1553
1554**Options**
1555
1556`boolean` values
1557
1558## Expand Excerpt Lines
1559
1560- Description: The default number of lines to expand excerpts in the multibuffer by
1561- Setting: `expand_excerpt_lines`
1562- Default: `5`
1563
1564**Options**
1565
1566Positive `integer` values
1567
1568## Excerpt Context Lines
1569
1570- Description: The number of lines of context to provide when showing excerpts in the multibuffer.
1571- Setting: `excerpt_context_lines`
1572- Default: `2`
1573
1574**Options**
1575
1576Positive `integer` value between 1 and 32. Values outside of this range will be clamped to this range.
1577
1578## Extend Comment On Newline
1579
1580- Description: Whether to start a new line with a comment when a previous line is a comment as well.
1581- Setting: `extend_comment_on_newline`
1582- Default: `true`
1583
1584**Options**
1585
1586`boolean` values
1587
1588## Status Bar
1589
1590- Description: Control various elements in the status bar. Note that some items in the status bar have their own settings set elsewhere.
1591- Setting: `status_bar`
1592- Default:
1593
1594```json [settings]
1595"status_bar": {
1596  "active_language_button": true,
1597  "cursor_position_button": true,
1598  "line_endings_button": false
1599},
1600```
1601
1602There 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.
1603
1604```json
1605"status_bar": {
1606  "experimental.show": false
1607}
1608```
1609
1610## LSP
1611
1612- Description: Configuration for language servers.
1613- Setting: `lsp`
1614- Default: `null`
1615
1616**Options**
1617
1618The following settings can be overridden for specific language servers:
1619
1620- `initialization_options`
1621- `settings`
1622
1623To override configuration for a language server, add an entry for that language server's name to the `lsp` value.
1624
1625Some 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.
1626
1627For example to pass the `check` option to `rust-analyzer`, use the following configuration:
1628
1629```json [settings]
1630"lsp": {
1631  "rust-analyzer": {
1632    "initialization_options": {
1633      "check": {
1634        "command": "clippy" // rust-analyzer.check.command (default: "check")
1635      }
1636    }
1637  }
1638}
1639```
1640
1641While other options may be changed at a runtime and should be placed under `settings`:
1642
1643```json [settings]
1644"lsp": {
1645  "yaml-language-server": {
1646    "settings": {
1647      "yaml": {
1648        "keyOrdering": true // Enforces alphabetical ordering of keys in maps
1649      }
1650    }
1651  }
1652}
1653```
1654
1655## Global LSP Settings
1656
1657- Description: Configuration for global LSP settings that apply to all language servers
1658- Setting: `global_lsp_settings`
1659- Default:
1660
1661```json [settings]
1662{
1663  "global_lsp_settings": {
1664    "button": true
1665  }
1666}
1667```
1668
1669**Options**
1670
1671- `button`: Whether to show the LSP status button in the status bar
1672
1673## LSP Highlight Debounce
1674
1675- Description: The debounce delay in milliseconds before querying highlights from the language server based on the current cursor location.
1676- Setting: `lsp_highlight_debounce`
1677- Default: `75`
1678
1679**Options**
1680
1681`integer` values representing milliseconds
1682
1683## Features
1684
1685- Description: Features that can be globally enabled or disabled
1686- Setting: `features`
1687- Default:
1688
1689```json [settings]
1690{
1691  "features": {
1692    "edit_prediction_provider": "zed"
1693  }
1694}
1695```
1696
1697### Edit Prediction Provider
1698
1699- Description: Which edit prediction provider to use
1700- Setting: `edit_prediction_provider`
1701- Default: `"zed"`
1702
1703**Options**
1704
17051. Use Zeta as the edit prediction provider:
1706
1707```json [settings]
1708{
1709  "features": {
1710    "edit_prediction_provider": "zed"
1711  }
1712}
1713```
1714
17152. Use Copilot as the edit prediction provider:
1716
1717```json [settings]
1718{
1719  "features": {
1720    "edit_prediction_provider": "copilot"
1721  }
1722}
1723```
1724
17253. Use Supermaven as the edit prediction provider:
1726
1727```json [settings]
1728{
1729  "features": {
1730    "edit_prediction_provider": "supermaven"
1731  }
1732}
1733```
1734
17354. Turn off edit predictions across all providers
1736
1737```json [settings]
1738{
1739  "features": {
1740    "edit_prediction_provider": "none"
1741  }
1742}
1743```
1744
1745## Format On Save
1746
1747- Description: Whether or not to perform a buffer format before saving.
1748- Setting: `format_on_save`
1749- Default: `on`
1750
1751**Options**
1752
17531. `on`, enables format on save obeying `formatter` setting:
1754
1755```json [settings]
1756{
1757  "format_on_save": "on"
1758}
1759```
1760
17612. `off`, disables format on save:
1762
1763```json [settings]
1764{
1765  "format_on_save": "off"
1766}
1767```
1768
1769## Formatter
1770
1771- Description: How to perform a buffer format.
1772- Setting: `formatter`
1773- Default: `auto`
1774
1775**Options**
1776
17771. To use the current language server, use `"language_server"`:
1778
1779```json [settings]
1780{
1781  "formatter": "language_server"
1782}
1783```
1784
17852. 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):
1786
1787```json [settings]
1788{
1789  "formatter": {
1790    "external": {
1791      "command": "sed",
1792      "arguments": ["-e", "s/ *$//"]
1793    }
1794  }
1795}
1796```
1797
17983. 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.
1799
1800WARNING: `{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.
1801
1802```json [settings]
1803  "formatter": {
1804    "external": {
1805      "command": "prettier",
1806      "arguments": ["--stdin-filepath", "{buffer_path}"]
1807    }
1808  }
1809```
1810
18114. Or to use code actions provided by the connected language servers, use `"code_actions"`:
1812
1813```json [settings]
1814{
1815  "formatter": [
1816    // Use ESLint's --fix:
1817    { "code_action": "source.fixAll.eslint" },
1818    // Organize imports on save:
1819    { "code_action": "source.organizeImports" }
1820  ]
1821}
1822```
1823
18245. Or to use multiple formatters consecutively, use an array of formatters:
1825
1826```json [settings]
1827{
1828  "formatter": [
1829    { "language_server": { "name": "rust-analyzer" } },
1830    {
1831      "external": {
1832        "command": "sed",
1833        "arguments": ["-e", "s/ *$//"]
1834      }
1835    }
1836  ]
1837}
1838```
1839
1840Here `rust-analyzer` will be used first to format the code, followed by a call of sed.
1841If any of the formatters fails, the subsequent ones will still be executed.
1842
1843## Auto close
1844
1845- Description: Whether to automatically add matching closing characters when typing opening parenthesis, bracket, brace, single or double quote characters.
1846- Setting: `use_autoclose`
1847- Default: `true`
1848
1849**Options**
1850
1851`boolean` values
1852
1853## Always Treat Brackets As Autoclosed
1854
1855- Description: Controls how the editor handles the autoclosed characters.
1856- Setting: `always_treat_brackets_as_autoclosed`
1857- Default: `false`
1858
1859**Options**
1860
1861`boolean` values
1862
1863**Example**
1864
1865If the setting is set to `true`:
1866
18671. Enter in the editor: `)))`
18682. Move the cursor to the start: `^)))`
18693. Enter again: `)))`
1870
1871The result is still `)))` and not `))))))`, which is what it would be by default.
1872
1873## File Scan Exclusions
1874
1875- Setting: `file_scan_exclusions`
1876- 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`.
1877- Default:
1878
1879```json [settings]
1880"file_scan_exclusions": [
1881  "**/.git",
1882  "**/.svn",
1883  "**/.hg",
1884  "**/.jj",
1885  "**/CVS",
1886  "**/.DS_Store",
1887  "**/Thumbs.db",
1888  "**/.classpath",
1889  "**/.settings"
1890],
1891```
1892
1893Note, 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.
1894
1895## File Scan Inclusions
1896
1897- Setting: `file_scan_inclusions`
1898- 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.
1899- Default:
1900
1901```json [settings]
1902"file_scan_inclusions": [".env*"],
1903```
1904
1905## File Types
1906
1907- Setting: `file_types`
1908- Description: Configure how Zed selects a language for a file based on its filename or extension. Supports glob entries.
1909- Default:
1910
1911```json [settings]
1912"file_types": {
1913  "JSONC": ["**/.zed/**/*.json", "**/zed/**/*.json", "**/Zed/**/*.json", "**/.vscode/**/*.json"],
1914  "Shell Script": [".env.*"]
1915}
1916```
1917
1918**Examples**
1919
1920To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files starting with `Dockerfile` as Dockerfile:
1921
1922```json [settings]
1923{
1924  "file_types": {
1925    "C++": ["c"],
1926    "TOML": ["MyLockFile"],
1927    "Dockerfile": ["Dockerfile*"]
1928  }
1929}
1930```
1931
1932## Diagnostics
1933
1934- Description: Configuration for diagnostics-related features.
1935- Setting: `diagnostics`
1936- Default:
1937
1938```json [settings]
1939{
1940  "diagnostics": {
1941    "include_warnings": true,
1942    "inline": {
1943      "enabled": false
1944    },
1945    "update_with_cursor": false,
1946    "primary_only": false,
1947    "use_rendered": false
1948  }
1949}
1950```
1951
1952### Inline Diagnostics
1953
1954- Description: Whether or not to show diagnostics information inline.
1955- Setting: `inline`
1956- Default:
1957
1958```json [settings]
1959{
1960  "diagnostics": {
1961    "inline": {
1962      "enabled": false,
1963      "update_debounce_ms": 150,
1964      "padding": 4,
1965      "min_column": 0,
1966      "max_severity": null
1967    }
1968  }
1969}
1970```
1971
1972**Options**
1973
19741. Enable inline diagnostics.
1975
1976```json [settings]
1977{
1978  "diagnostics": {
1979    "inline": {
1980      "enabled": true
1981    }
1982  }
1983}
1984```
1985
19862. Delay diagnostic updates until some time after the last diagnostic update.
1987
1988```json [settings]
1989{
1990  "diagnostics": {
1991    "inline": {
1992      "enabled": true,
1993      "update_debounce_ms": 150
1994    }
1995  }
1996}
1997```
1998
19993. Set padding between the end of the source line and the start of the diagnostic.
2000
2001```json [settings]
2002{
2003  "diagnostics": {
2004    "inline": {
2005      "enabled": true,
2006      "padding": 4
2007    }
2008  }
2009}
2010```
2011
20124. Horizontally align inline diagnostics at the given column.
2013
2014```json [settings]
2015{
2016  "diagnostics": {
2017    "inline": {
2018      "enabled": true,
2019      "min_column": 80
2020    }
2021  }
2022}
2023```
2024
20255. Show only warning and error diagnostics.
2026
2027```json [settings]
2028{
2029  "diagnostics": {
2030    "inline": {
2031      "enabled": true,
2032      "max_severity": "warning"
2033    }
2034  }
2035}
2036```
2037
2038## Git
2039
2040- Description: Configuration for git-related features.
2041- Setting: `git`
2042- Default:
2043
2044```json [settings]
2045{
2046  "git": {
2047    "git_gutter": "tracked_files",
2048    "inline_blame": {
2049      "enabled": true
2050    },
2051    "branch_picker": {
2052      "show_author_name": true
2053    },
2054    "hunk_style": "staged_hollow"
2055  }
2056}
2057```
2058
2059### Git Gutter
2060
2061- Description: Whether or not to show the git gutter.
2062- Setting: `git_gutter`
2063- Default: `tracked_files`
2064
2065**Options**
2066
20671. Show git gutter in tracked files
2068
2069```json [settings]
2070{
2071  "git": {
2072    "git_gutter": "tracked_files"
2073  }
2074}
2075```
2076
20772. Hide git gutter
2078
2079```json [settings]
2080{
2081  "git": {
2082    "git_gutter": "hide"
2083  }
2084}
2085```
2086
2087### Gutter Debounce
2088
2089- Description: Sets the debounce threshold (in milliseconds) after which changes are reflected in the git gutter.
2090- Setting: `gutter_debounce`
2091- Default: `null`
2092
2093**Options**
2094
2095`integer` values representing milliseconds
2096
2097Example:
2098
2099```json [settings]
2100{
2101  "git": {
2102    "gutter_debounce": 100
2103  }
2104}
2105```
2106
2107### Inline Git Blame
2108
2109- Description: Whether or not to show git blame information inline, on the currently focused line.
2110- Setting: `inline_blame`
2111- Default:
2112
2113```json [settings]
2114{
2115  "git": {
2116    "inline_blame": {
2117      "enabled": true
2118    }
2119  }
2120}
2121```
2122
2123**Options**
2124
21251. Disable inline git blame:
2126
2127```json [settings]
2128{
2129  "git": {
2130    "inline_blame": {
2131      "enabled": false
2132    }
2133  }
2134}
2135```
2136
21372. Only show inline git blame after a delay (that starts after cursor stops moving):
2138
2139```json [settings]
2140{
2141  "git": {
2142    "inline_blame": {
2143      "delay_ms": 500
2144    }
2145  }
2146}
2147```
2148
21493. Show a commit summary next to the commit date and author:
2150
2151```json [settings]
2152{
2153  "git": {
2154    "inline_blame": {
2155      "show_commit_summary": true
2156    }
2157  }
2158}
2159```
2160
21614. Use this as the minimum column at which to display inline blame information:
2162
2163```json [settings]
2164{
2165  "git": {
2166    "inline_blame": {
2167      "min_column": 80
2168    }
2169  }
2170}
2171```
2172
21735. Set the padding between the end of the line and the inline blame hint, in ems:
2174
2175```json [settings]
2176{
2177  "git": {
2178    "inline_blame": {
2179      "padding": 10
2180    }
2181  }
2182}
2183```
2184
2185### Branch Picker
2186
2187- Description: Configuration related to the branch picker.
2188- Setting: `branch_picker`
2189- Default:
2190
2191```json [settings]
2192{
2193  "git": {
2194    "branch_picker": {
2195      "show_author_name": false
2196    }
2197  }
2198}
2199```
2200
2201**Options**
2202
22031. Show the author name in the branch picker:
2204
2205```json [settings]
2206{
2207  "git": {
2208    "branch_picker": {
2209      "show_author_name": true
2210    }
2211  }
2212}
2213```
2214
2215### Hunk Style
2216
2217- Description: What styling we should use for the diff hunks.
2218- Setting: `hunk_style`
2219- Default:
2220
2221```json [settings]
2222{
2223  "git": {
2224    "hunk_style": "staged_hollow"
2225  }
2226}
2227```
2228
2229**Options**
2230
22311. Show the staged hunks faded out and with a border:
2232
2233```json [settings]
2234{
2235  "git": {
2236    "hunk_style": "staged_hollow"
2237  }
2238}
2239```
2240
22412. Show unstaged hunks faded out and with a border:
2242
2243```json [settings]
2244{
2245  "git": {
2246    "hunk_style": "unstaged_hollow"
2247  }
2248}
2249```
2250
2251## Go to Definition Fallback
2252
2253- Description: What to do when the {#action editor::GoToDefinition} action fails to find a definition
2254- Setting: `go_to_definition_fallback`
2255- Default: `"find_all_references"`
2256
2257**Options**
2258
22591. Do nothing:
2260
2261```json [settings]
2262{
2263  "go_to_definition_fallback": "none"
2264}
2265```
2266
22672. Find references for the same symbol (default):
2268
2269```json [settings]
2270{
2271  "go_to_definition_fallback": "find_all_references"
2272}
2273```
2274
2275## Hard Tabs
2276
2277- Description: Whether to indent lines using tab characters or multiple spaces.
2278- Setting: `hard_tabs`
2279- Default: `false`
2280
2281**Options**
2282
2283`boolean` values
2284
2285## Helix Mode
2286
2287- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
2288- Setting: `helix_mode`
2289- Default: `false`
2290
2291**Options**
2292
2293`boolean` values
2294
2295## Indent Guides
2296
2297- Description: Configuration related to indent guides. Indent guides can be configured separately for each language.
2298- Setting: `indent_guides`
2299- Default:
2300
2301```json [settings]
2302{
2303  "indent_guides": {
2304    "enabled": true,
2305    "line_width": 1,
2306    "active_line_width": 1,
2307    "coloring": "fixed",
2308    "background_coloring": "disabled"
2309  }
2310}
2311```
2312
2313**Options**
2314
23151. Disable indent guides
2316
2317```json [settings]
2318{
2319  "indent_guides": {
2320    "enabled": false
2321  }
2322}
2323```
2324
23252. Enable indent guides for a specific language.
2326
2327```json [settings]
2328{
2329  "languages": {
2330    "Python": {
2331      "indent_guides": {
2332        "enabled": true
2333      }
2334    }
2335  }
2336}
2337```
2338
23393. Enable indent aware coloring ("rainbow indentation").
2340   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.
2341
2342```json [settings]
2343{
2344  "indent_guides": {
2345    "enabled": true,
2346    "coloring": "indent_aware"
2347  }
2348}
2349```
2350
23514. Enable indent aware background coloring ("rainbow indentation").
2352   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.
2353
2354```json [settings]
2355{
2356  "indent_guides": {
2357    "enabled": true,
2358    "coloring": "indent_aware",
2359    "background_coloring": "indent_aware"
2360  }
2361}
2362```
2363
2364## Hover Popover Enabled
2365
2366- Description: Whether or not to show the informational hover box when moving the mouse over symbols in the editor.
2367- Setting: `hover_popover_enabled`
2368- Default: `true`
2369
2370**Options**
2371
2372`boolean` values
2373
2374## Hover Popover Delay
2375
2376- Description: Time to wait in milliseconds before showing the informational hover box.
2377- Setting: `hover_popover_delay`
2378- Default: `300`
2379
2380**Options**
2381
2382`integer` values representing milliseconds
2383
2384## Icon Theme
2385
2386- 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.
2387- Setting: `icon_theme`
2388- Default: `Zed (Default)`
2389
2390### Icon Theme Object
2391
2392- Description: Specify the icon theme using an object that includes the `mode`, `dark`, and `light`.
2393- Setting: `icon_theme`
2394- Default:
2395
2396```json [settings]
2397"icon_theme": {
2398  "mode": "system",
2399  "dark": "Zed (Default)",
2400  "light": "Zed (Default)"
2401},
2402```
2403
2404### Mode
2405
2406- Description: Specify the icon theme mode.
2407- Setting: `mode`
2408- Default: `system`
2409
2410**Options**
2411
24121. Set the icon theme to dark mode
2413
2414```json [settings]
2415{
2416  "mode": "dark"
2417}
2418```
2419
24202. Set the icon theme to light mode
2421
2422```json [settings]
2423{
2424  "mode": "light"
2425}
2426```
2427
24283. Set the icon theme to system mode
2429
2430```json [settings]
2431{
2432  "mode": "system"
2433}
2434```
2435
2436### Dark
2437
2438- Description: The name of the dark icon theme.
2439- Setting: `dark`
2440- Default: `Zed (Default)`
2441
2442**Options**
2443
2444Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2445
2446### Light
2447
2448- Description: The name of the light icon theme.
2449- Setting: `light`
2450- Default: `Zed (Default)`
2451
2452**Options**
2453
2454Run the {#action icon_theme_selector::Toggle} action in the command palette to see a current list of valid icon themes names.
2455
2456## Image Viewer
2457
2458- Description: Settings for image viewer functionality
2459- Setting: `image_viewer`
2460- Default:
2461
2462```json [settings]
2463{
2464  "image_viewer": {
2465    "unit": "binary"
2466  }
2467}
2468```
2469
2470**Options**
2471
2472### Unit
2473
2474- Description: The unit for image file sizes
2475- Setting: `unit`
2476- Default: `"binary"`
2477
2478**Options**
2479
24801. Use binary units (KiB, MiB):
2481
2482```json [settings]
2483{
2484  "image_viewer": {
2485    "unit": "binary"
2486  }
2487}
2488```
2489
24902. Use decimal units (KB, MB):
2491
2492```json [settings]
2493{
2494  "image_viewer": {
2495    "unit": "decimal"
2496  }
2497}
2498```
2499
2500## Inlay hints
2501
2502- Description: Configuration for displaying extra text with hints in the editor.
2503- Setting: `inlay_hints`
2504- Default:
2505
2506```json [settings]
2507"inlay_hints": {
2508  "enabled": false,
2509  "show_type_hints": true,
2510  "show_parameter_hints": true,
2511  "show_other_hints": true,
2512  "show_background": false,
2513  "edit_debounce_ms": 700,
2514  "scroll_debounce_ms": 50,
2515  "toggle_on_modifiers_press": null
2516}
2517```
2518
2519**Options**
2520
2521Inlay hints querying consists of two parts: editor (client) and LSP server.
2522With 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.
2523At 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.
2524
2525The following languages have inlay hints preconfigured by Zed:
2526
2527- [Go](https://docs.zed.dev/languages/go)
2528- [Rust](https://docs.zed.dev/languages/rust)
2529- [Svelte](https://docs.zed.dev/languages/svelte)
2530- [TypeScript](https://docs.zed.dev/languages/typescript)
2531
2532Use the `lsp` section for the server configuration. Examples are provided in the corresponding language documentation.
2533
2534Hints are not instantly queried in Zed, two kinds of debounces are used, either may be set to 0 to be disabled.
2535Settings-related hint updates are not debounced.
2536
2537All possible config values for `toggle_on_modifiers_press` are:
2538
2539```json [settings]
2540"inlay_hints": {
2541  "toggle_on_modifiers_press": {
2542    "control": true,
2543    "shift": true,
2544    "alt": true,
2545    "platform": true,
2546    "function": true
2547  }
2548}
2549```
2550
2551Unspecified values have a `false` value, hints won't be toggled if all the modifiers are `false` or not all the modifiers are pressed.
2552
2553## Journal
2554
2555- Description: Configuration for the journal.
2556- Setting: `journal`
2557- Default:
2558
2559```json [settings]
2560"journal": {
2561  "path": "~",
2562  "hour_format": "hour12"
2563}
2564
2565```
2566
2567### Path
2568
2569- Description: The path of the directory where journal entries are stored. If an invalid path is specified, the journal will fall back to using `~` (the home directory).
2570- Setting: `path`
2571- Default: `~`
2572
2573**Options**
2574
2575`string` values
2576
2577### Hour Format
2578
2579- Description: The format to use for displaying hours in the journal.
2580- Setting: `hour_format`
2581- Default: `hour12`
2582
2583**Options**
2584
25851. 12-hour format:
2586
2587```json [settings]
2588{
2589  "hour_format": "hour12"
2590}
2591```
2592
25932. 24-hour format:
2594
2595```json [settings]
2596{
2597  "hour_format": "hour24"
2598}
2599```
2600
2601## JSX Tag Auto Close
2602
2603- Description: Whether to automatically close JSX tags
2604- Setting: `jsx_tag_auto_close`
2605- Default:
2606
2607```json [settings]
2608{
2609  "jsx_tag_auto_close": {
2610    "enabled": true
2611  }
2612}
2613```
2614
2615**Options**
2616
2617- `enabled`: Whether to enable automatic JSX tag closing
2618
2619## Languages
2620
2621- Description: Configuration for specific languages.
2622- Setting: `languages`
2623- Default: `null`
2624
2625**Options**
2626
2627To override settings for a language, add an entry for that languages name to the `languages` value. Example:
2628
2629```json [settings]
2630"languages": {
2631  "C": {
2632    "format_on_save": "off",
2633    "preferred_line_length": 64,
2634    "soft_wrap": "preferred_line_length"
2635  },
2636  "JSON": {
2637    "tab_size": 4
2638  }
2639}
2640```
2641
2642The following settings can be overridden for each specific language:
2643
2644- [`enable_language_server`](#enable-language-server)
2645- [`ensure_final_newline_on_save`](#ensure-final-newline-on-save)
2646- [`format_on_save`](#format-on-save)
2647- [`formatter`](#formatter)
2648- [`hard_tabs`](#hard-tabs)
2649- [`preferred_line_length`](#preferred-line-length)
2650- [`remove_trailing_whitespace_on_save`](#remove-trailing-whitespace-on-save)
2651- [`show_edit_predictions`](#show-edit-predictions)
2652- [`show_whitespaces`](#show-whitespaces)
2653- [`whitespace_map`](#whitespace-map)
2654- [`soft_wrap`](#soft-wrap)
2655- [`tab_size`](#tab-size)
2656- [`use_autoclose`](#use-autoclose)
2657- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
2658
2659These values take in the same options as the root-level settings with the same name.
2660
2661## Language Models
2662
2663- Description: Configuration for language model providers
2664- Setting: `language_models`
2665- Default:
2666
2667```json [settings]
2668{
2669  "language_models": {
2670    "anthropic": {
2671      "api_url": "https://api.anthropic.com"
2672    },
2673    "google": {
2674      "api_url": "https://generativelanguage.googleapis.com"
2675    },
2676    "ollama": {
2677      "api_url": "http://localhost:11434"
2678    },
2679    "openai": {
2680      "api_url": "https://api.openai.com/v1"
2681    }
2682  }
2683}
2684```
2685
2686**Options**
2687
2688Configuration for various AI model providers including API URLs and authentication settings.
2689
2690## Line Indicator Format
2691
2692- Description: Format for line indicator in the status bar
2693- Setting: `line_indicator_format`
2694- Default: `"short"`
2695
2696**Options**
2697
26981. Short format:
2699
2700```json [settings]
2701{
2702  "line_indicator_format": "short"
2703}
2704```
2705
27062. Long format:
2707
2708```json [settings]
2709{
2710  "line_indicator_format": "long"
2711}
2712```
2713
2714## Linked Edits
2715
2716- 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.
2717- Setting: `linked_edits`
2718- Default: `true`
2719
2720**Options**
2721
2722`boolean` values
2723
2724## LSP Document Colors
2725
2726- Description: Whether to show document color information from the language server
2727- Setting: `lsp_document_colors`
2728- Default: `true`
2729
2730**Options**
2731
2732`boolean` values
2733
2734## Max Tabs
2735
2736- Description: Maximum number of tabs to show in the tab bar
2737- Setting: `max_tabs`
2738- Default: `null`
2739
2740**Options**
2741
2742Positive `integer` values or `null` for unlimited tabs
2743
2744## Middle Click Paste (Linux only)
2745
2746- Description: Enable middle-click paste on Linux
2747- Setting: `middle_click_paste`
2748- Default: `true`
2749
2750**Options**
2751
2752`boolean` values
2753
2754## Multi Cursor Modifier
2755
2756- 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.
2757- Setting: `multi_cursor_modifier`
2758- Default: `alt`
2759
2760**Options**
2761
27621. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2763
2764```json [settings]
2765{
2766  "multi_cursor_modifier": "alt"
2767}
2768```
2769
27702. Maps `Control` on Linux and Windows and to `Command` on macOS:
2771
2772```json [settings]
2773{
2774  "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2775}
2776```
2777
2778## Node
2779
2780- Description: Configuration for Node.js integration
2781- Setting: `node`
2782- Default:
2783
2784```json [settings]
2785{
2786  "node": {
2787    "ignore_system_version": false,
2788    "path": null,
2789    "npm_path": null
2790  }
2791}
2792```
2793
2794**Options**
2795
2796- `ignore_system_version`: Whether to ignore the system Node.js version
2797- `path`: Custom path to Node.js binary
2798- `npm_path`: Custom path to npm binary
2799
2800## Network Proxy
2801
2802- Description: Configure a network proxy for Zed.
2803- Setting: `proxy`
2804- Default: `null`
2805
2806**Options**
2807
2808The proxy setting must contain a URL to the proxy.
2809
2810The following URI schemes are supported:
2811
2812- `http`
2813- `https`
2814- `socks4` - SOCKS4 proxy with local DNS
2815- `socks4a` - SOCKS4 proxy with remote DNS
2816- `socks5` - SOCKS5 proxy with local DNS
2817- `socks5h` - SOCKS5 proxy with remote DNS
2818
2819`http` will be used when no scheme is specified.
2820
2821By 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`.
2822
2823For example, to set an `http` proxy, add the following to your settings:
2824
2825```json [settings]
2826{
2827  "proxy": "http://127.0.0.1:10809"
2828}
2829```
2830
2831Or to set a `socks5` proxy:
2832
2833```json [settings]
2834{
2835  "proxy": "socks5h://localhost:10808"
2836}
2837```
2838
2839If 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.
2840
2841## On Last Window Closed
2842
2843- Description: What to do when the last window is closed
2844- Setting: `on_last_window_closed`
2845- Default: `"platform_default"`
2846
2847**Options**
2848
28491. Use platform default behavior:
2850
2851```json [settings]
2852{
2853  "on_last_window_closed": "platform_default"
2854}
2855```
2856
28572. Always quit the application:
2858
2859```json [settings]
2860{
2861  "on_last_window_closed": "quit_app"
2862}
2863```
2864
2865## Profiles
2866
2867- Description: Configuration profiles that can be applied on top of existing settings
2868- Setting: `profiles`
2869- Default: `{}`
2870
2871**Options**
2872
2873Configuration object for defining settings profiles. Example:
2874
2875```json [settings]
2876{
2877  "profiles": {
2878    "presentation": {
2879      "buffer_font_size": 20,
2880      "ui_font_size": 18,
2881      "theme": "One Light"
2882    }
2883  }
2884}
2885```
2886
2887## Preview tabs
2888
2889- Description:
2890  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. \
2891   There are several ways to convert a preview tab into a regular tab:
2892
2893  - Double-clicking on the file
2894  - Double-clicking on the tab header
2895  - Using the {#action project_panel::OpenPermanent} action
2896  - Editing the file
2897  - Dragging the file to a different pane
2898
2899- Setting: `preview_tabs`
2900- Default:
2901
2902```json [settings]
2903"preview_tabs": {
2904  "enabled": true,
2905  "enable_preview_from_project_panel": true,
2906  "enable_preview_from_file_finder": false,
2907  "enable_preview_from_multibuffer": true,
2908  "enable_preview_multibuffer_from_code_navigation": false,
2909  "enable_preview_file_from_code_navigation": true,
2910  "enable_keep_preview_on_code_navigation": false,
2911}
2912```
2913
2914### Enable preview from project panel
2915
2916- Description: Determines whether to open files in preview mode when opened from the project panel with a single click.
2917- Setting: `enable_preview_from_project_panel`
2918- Default: `true`
2919
2920**Options**
2921
2922`boolean` values
2923
2924### Enable preview from file finder
2925
2926- Description: Determines whether to open files in preview mode when selected from the file finder.
2927- Setting: `enable_preview_from_file_finder`
2928- Default: `false`
2929
2930**Options**
2931
2932`boolean` values
2933
2934### Enable preview from multibuffer
2935
2936- Description: Determines whether to open files in preview mode when opened from a multibuffer.
2937- Setting: `enable_preview_from_multibuffer`
2938- Default: `true`
2939
2940**Options**
2941
2942`boolean` values
2943
2944### Enable preview multibuffer from code navigation
2945
2946- Description: Determines whether to open tabs in preview mode when code navigation is used to open a multibuffer.
2947- Setting: `enable_preview_multibuffer_from_code_navigation`
2948- Default: `false`
2949
2950**Options**
2951
2952`boolean` values
2953
2954### Enable preview file from code navigation
2955
2956- Description: Determines whether to open tabs in preview mode when code navigation is used to open a single file.
2957- Setting: `enable_preview_file_from_code_navigation`
2958- Default: `true`
2959
2960**Options**
2961
2962`boolean` values
2963
2964### Enable keep preview on code navigation
2965
2966- Description: Determines whether to keep tabs in preview mode when code navigation is used to navigate away from them. If `enable_preview_file_from_code_navigation` or `enable_preview_multibuffer_from_code_navigation` is also true, the new tab may replace the existing one.
2967- Setting: `enable_keep_preview_on_code_navigation`
2968- Default: `false`
2969
2970**Options**
2971
2972`boolean` values
2973
2974## File Finder
2975
2976### File Icons
2977
2978- Description: Whether to show file icons in the file finder.
2979- Setting: `file_icons`
2980- Default: `true`
2981
2982### Modal Max Width
2983
2984- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2985- Setting: `modal_max_width`
2986- Default: `small`
2987
2988### Skip Focus For Active In Search
2989
2990- Description: Determines whether the file finder should skip focus for the active file in search results.
2991- Setting: `skip_focus_for_active_in_search`
2992- Default: `true`
2993
2994## Pane Split Direction Horizontal
2995
2996- Description: The direction that you want to split panes horizontally
2997- Setting: `pane_split_direction_horizontal`
2998- Default: `"up"`
2999
3000**Options**
3001
30021. Split upward:
3003
3004```json [settings]
3005{
3006  "pane_split_direction_horizontal": "up"
3007}
3008```
3009
30102. Split downward:
3011
3012```json [settings]
3013{
3014  "pane_split_direction_horizontal": "down"
3015}
3016```
3017
3018## Pane Split Direction Vertical
3019
3020- Description: The direction that you want to split panes vertically
3021- Setting: `pane_split_direction_vertical`
3022- Default: `"left"`
3023
3024**Options**
3025
30261. Split to the left:
3027
3028```json [settings]
3029{
3030  "pane_split_direction_vertical": "left"
3031}
3032```
3033
30342. Split to the right:
3035
3036```json [settings]
3037{
3038  "pane_split_direction_vertical": "right"
3039}
3040```
3041
3042## Preferred Line Length
3043
3044- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
3045- Setting: `preferred_line_length`
3046- Default: `80`
3047
3048**Options**
3049
3050`integer` values
3051
3052## Private Files
3053
3054- Description: Globs to match against file paths to determine if a file is private
3055- Setting: `private_files`
3056- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
3057
3058**Options**
3059
3060List of `string` glob patterns
3061
3062## Projects Online By Default
3063
3064- Description: Whether or not to show the online projects view by default.
3065- Setting: `projects_online_by_default`
3066- Default: `true`
3067
3068**Options**
3069
3070`boolean` values
3071
3072## Read SSH Config
3073
3074- Description: Whether to read SSH configuration files
3075- Setting: `read_ssh_config`
3076- Default: `true`
3077
3078**Options**
3079
3080`boolean` values
3081
3082## Redact Private Values
3083
3084- Description: Hide the values of variables from visual display in private files
3085- Setting: `redact_private_values`
3086- Default: `false`
3087
3088**Options**
3089
3090`boolean` values
3091
3092## Relative Line Numbers
3093
3094- Description: Whether to show relative line numbers in the gutter
3095- Setting: `relative_line_numbers`
3096- Default: `"disabled"`
3097
3098**Options**
3099
31001. Show relative line numbers in the gutter whilst counting wrapped lines as one line:
3101
3102```json [settings]
3103{
3104  "relative_line_numbers": "enabled"
3105}
3106```
3107
31082. Show relative line numbers in the gutter, including wrapped lines in the counting:
3109
3110```json [settings]
3111{
3112  "relative_line_numbers": "wrapped"
3113}
3114```
3115
31162. Do not use relative line numbers:
3117
3118```json [settings]
3119{
3120  "relative_line_numbers": "disabled"
3121}
3122```
3123
3124## Remove Trailing Whitespace On Save
3125
3126- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3127- Setting: `remove_trailing_whitespace_on_save`
3128- Default: `true`
3129
3130**Options**
3131
3132`boolean` values
3133
3134## Resize All Panels In Dock
3135
3136- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3137- Setting: `resize_all_panels_in_dock`
3138- Default: `["left"]`
3139
3140**Options**
3141
3142List of strings containing any combination of:
3143
3144- `"left"`: Resize left dock panels together
3145- `"right"`: Resize right dock panels together
3146- `"bottom"`: Resize bottom dock panels together
3147
3148## Restore on File Reopen
3149
3150- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3151- Setting: `restore_on_file_reopen`
3152- Default: `true`
3153
3154**Options**
3155
3156`boolean` values
3157
3158## Restore on Startup
3159
3160- Description: Controls session restoration on startup.
3161- Setting: `restore_on_startup`
3162- Default: `last_session`
3163
3164**Options**
3165
31661. Restore all workspaces that were open when quitting Zed:
3167
3168```json [settings]
3169{
3170  "restore_on_startup": "last_session"
3171}
3172```
3173
31742. Restore the workspace that was closed last:
3175
3176```json [settings]
3177{
3178  "restore_on_startup": "last_workspace"
3179}
3180```
3181
31823. Always start with an empty editor:
3183
3184```json [settings]
3185{
3186  "restore_on_startup": "empty_tab"
3187}
3188```
3189
31904. Always start with the welcome launchpad:
3191
3192```json [settings]
3193{
3194  "restore_on_startup": "launchpad"
3195}
3196```
3197
3198## Scroll Beyond Last Line
3199
3200- Description: Whether the editor will scroll beyond the last line
3201- Setting: `scroll_beyond_last_line`
3202- Default: `"one_page"`
3203
3204**Options**
3205
32061. Scroll one page beyond the last line by one page:
3207
3208```json [settings]
3209{
3210  "scroll_beyond_last_line": "one_page"
3211}
3212```
3213
32142. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3215
3216```json [settings]
3217{
3218  "scroll_beyond_last_line": "vertical_scroll_margin"
3219}
3220```
3221
32223. The editor will not scroll beyond the last line:
3223
3224```json [settings]
3225{
3226  "scroll_beyond_last_line": "off"
3227}
3228```
3229
3230**Options**
3231
3232`boolean` values
3233
3234## Scroll Sensitivity
3235
3236- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3237- Setting: `scroll_sensitivity`
3238- Default: `1.0`
3239
3240**Options**
3241
3242Positive `float` values
3243
3244### Fast Scroll Sensitivity
3245
3246- 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.
3247- Setting: `fast_scroll_sensitivity`
3248- Default: `4.0`
3249
3250**Options**
3251
3252Positive `float` values
3253
3254### Horizontal Scroll Margin
3255
3256- Description: The number of characters to keep on either side when scrolling with the mouse
3257- Setting: `horizontal_scroll_margin`
3258- Default: `5`
3259
3260**Options**
3261
3262Non-negative `integer` values
3263
3264### Vertical Scroll Margin
3265
3266- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3267- Setting: `vertical_scroll_margin`
3268- Default: `3`
3269
3270**Options**
3271
3272Non-negative `integer` values
3273
3274## Search
3275
3276- Description: Search options to enable by default when opening new project and buffer searches.
3277- Setting: `search`
3278- Default:
3279
3280```json [settings]
3281"search": {
3282  "button": true,
3283  "whole_word": false,
3284  "case_sensitive": false,
3285  "include_ignored": false,
3286  "regex": false,
3287  "center_on_match": false
3288},
3289```
3290
3291### Button
3292
3293- Description: Whether to show the project search button in the status bar.
3294- Setting: `button`
3295- Default: `true`
3296
3297### Whole Word
3298
3299- Description: Whether to only match on whole words.
3300- Setting: `whole_word`
3301- Default: `false`
3302
3303### Case Sensitive
3304
3305- Description: Whether to match case sensitively. This setting affects both
3306  searches and editor actions like "Select Next Occurrence", "Select Previous
3307  Occurrence", and "Select All Occurrences".
3308- Setting: `case_sensitive`
3309- Default: `false`
3310
3311### Include Ignore
3312
3313- Description: Whether to include gitignored files in search results.
3314- Setting: `include_ignored`
3315- Default: `false`
3316
3317### Regex
3318
3319- Description: Whether to interpret the search query as a regular expression.
3320- Setting: `regex`
3321- Default: `false`
3322
3323### Center On Match
3324
3325- Description: Whether to center the cursor on each search match when navigating.
3326- Setting: `center_on_match`
3327- Default: `false`
3328
3329## Search Wrap
3330
3331- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3332- Setting: `search_wrap`
3333- Default: `true`
3334
3335## Center on Match
3336
3337- Description: If `center_on_match` is enabled, the editor will center the cursor on the current match when searching.
3338- Setting: `center_on_match`
3339- Default: `false`
3340
3341## Seed Search Query From Cursor
3342
3343- Description: When to populate a new search's query based on the text under the cursor.
3344- Setting: `seed_search_query_from_cursor`
3345- Default: `always`
3346
3347**Options**
3348
33491. `always` always populate the search query with the word under the cursor
33502. `selection` only populate the search query when there is text selected
33513. `never` never populate the search query
3352
3353## Use Smartcase Search
3354
3355- 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. \
3356  This applies to both in-file searches and project-wide searches.
3357- Setting: `use_smartcase_search`
3358- Default: `false`
3359
3360**Options**
3361
3362`boolean` values
3363
3364Examples:
3365
3366- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3367- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3368
3369## Show Call Status Icon
3370
3371- Description: Whether or not to show the call status icon in the status bar.
3372- Setting: `show_call_status_icon`
3373- Default: `true`
3374
3375**Options**
3376
3377`boolean` values
3378
3379## Completions
3380
3381- Description: Controls how completions are processed for this language.
3382- Setting: `completions`
3383- Default:
3384
3385```json [settings]
3386{
3387  "completions": {
3388    "words": "fallback",
3389    "words_min_length": 3,
3390    "lsp": true,
3391    "lsp_fetch_timeout_ms": 0,
3392    "lsp_insert_mode": "replace_suffix"
3393  }
3394}
3395```
3396
3397### Words
3398
3399- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3400- Setting: `words`
3401- Default: `fallback`
3402
3403**Options**
3404
34051. `enabled` - Always fetch document's words for completions along with LSP completions
34062. `fallback` - Only if LSP response errors or times out, use document's words to show completions
34073. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3408
3409### Min Words Query Length
3410
3411- Description: Minimum number of characters required to automatically trigger word-based completions.
3412  Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3413- Setting: `words_min_length`
3414- Default: `3`
3415
3416**Options**
3417
3418Positive integer values
3419
3420### LSP
3421
3422- Description: Whether to fetch LSP completions or not.
3423- Setting: `lsp`
3424- Default: `true`
3425
3426**Options**
3427
3428`boolean` values
3429
3430### LSP Fetch Timeout (ms)
3431
3432- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3433- Setting: `lsp_fetch_timeout_ms`
3434- Default: `0`
3435
3436**Options**
3437
3438`integer` values representing milliseconds
3439
3440### LSP Insert Mode
3441
3442- Description: Controls what range to replace when accepting LSP completions.
3443- Setting: `lsp_insert_mode`
3444- Default: `replace_suffix`
3445
3446**Options**
3447
34481. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
34492. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
34503. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
34514. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3452
3453## Show Completions On Input
3454
3455- Description: Whether or not to show completions as you type.
3456- Setting: `show_completions_on_input`
3457- Default: `true`
3458
3459**Options**
3460
3461`boolean` values
3462
3463## Show Completion Documentation
3464
3465- Description: Whether to display inline and alongside documentation for items in the completions menu.
3466- Setting: `show_completion_documentation`
3467- Default: `true`
3468
3469**Options**
3470
3471`boolean` values
3472
3473## Show Edit Predictions
3474
3475- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3476- Setting: `show_edit_predictions`
3477- Default: `true`
3478
3479**Options**
3480
3481`boolean` values
3482
3483## Show Whitespaces
3484
3485- Description: Whether or not to render whitespace characters in the editor.
3486- Setting: `show_whitespaces`
3487- Default: `selection`
3488
3489**Options**
3490
34911. `all`
34922. `selection`
34933. `none`
34944. `boundary`
3495
3496## Whitespace Map
3497
3498- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3499- Setting: `whitespace_map`
3500- Default:
3501
3502```json [settings]
3503{
3504  "whitespace_map": {
3505    "space": "•",
3506    "tab": "→"
3507  }
3508}
3509```
3510
3511## Soft Wrap
3512
3513- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3514- Setting: `soft_wrap`
3515- Default: `none`
3516
3517**Options**
3518
35191. `none` to avoid wrapping generally, unless the line is too long
35202. `prefer_line` (deprecated, same as `none`)
35213. `editor_width` to wrap lines that overflow the editor width
35224. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
35235. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3524
3525## Show Wrap Guides
3526
3527- 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.
3528- Setting: `show_wrap_guides`
3529- Default: `true`
3530
3531**Options**
3532
3533`boolean` values
3534
3535## Use On Type Format
3536
3537- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3538- Setting: `use_on_type_format`
3539- Default: `true`
3540
3541**Options**
3542
3543`boolean` values
3544
3545## Use Auto Surround
3546
3547- 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 ().
3548- Setting: `use_auto_surround`
3549- Default: `true`
3550
3551**Options**
3552
3553`boolean` values
3554
3555## Use System Path Prompts
3556
3557- 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.
3558- Setting: `use_system_path_prompts`
3559- Default: `true`
3560
3561**Options**
3562
3563`boolean` values
3564
3565## Use System Prompts
3566
3567- 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.
3568- Setting: `use_system_prompts`
3569- Default: `true`
3570
3571**Options**
3572
3573`boolean` values
3574
3575## Wrap Guides (Vertical Rulers)
3576
3577- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3578- Setting: `wrap_guides`
3579- Default: []
3580
3581**Options**
3582
3583List of `integer` column numbers
3584
3585## Tab Size
3586
3587- Description: The number of spaces to use for each tab character.
3588- Setting: `tab_size`
3589- Default: `4`
3590
3591**Options**
3592
3593`integer` values
3594
3595## Tasks
3596
3597- Description: Configuration for tasks that can be run within Zed
3598- Setting: `tasks`
3599- Default:
3600
3601```json [settings]
3602{
3603  "tasks": {
3604    "variables": {},
3605    "enabled": true,
3606    "prefer_lsp": false
3607  }
3608}
3609```
3610
3611**Options**
3612
3613- `variables`: Custom variables for task configuration
3614- `enabled`: Whether tasks are enabled
3615- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3616
3617## Telemetry
3618
3619- Description: Control what info is collected by Zed.
3620- Setting: `telemetry`
3621- Default:
3622
3623```json [settings]
3624"telemetry": {
3625  "diagnostics": true,
3626  "metrics": true
3627},
3628```
3629
3630**Options**
3631
3632### Diagnostics
3633
3634- Description: Setting for sending debug-related data, such as crash reports.
3635- Setting: `diagnostics`
3636- Default: `true`
3637
3638**Options**
3639
3640`boolean` values
3641
3642### Metrics
3643
3644- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3645- Setting: `metrics`
3646- Default: `true`
3647
3648**Options**
3649
3650`boolean` values
3651
3652## Terminal
3653
3654- Description: Configuration for the terminal.
3655- Setting: `terminal`
3656- Default:
3657
3658```json [settings]
3659{
3660  "terminal": {
3661    "alternate_scroll": "off",
3662    "blinking": "terminal_controlled",
3663    "copy_on_select": false,
3664    "keep_selection_on_copy": true,
3665    "dock": "bottom",
3666    "default_width": 640,
3667    "default_height": 320,
3668    "detect_venv": {
3669      "on": {
3670        "directories": [".env", "env", ".venv", "venv"],
3671        "activate_script": "default"
3672      }
3673    },
3674    "env": {},
3675    "font_family": null,
3676    "font_features": null,
3677    "font_size": null,
3678    "line_height": "comfortable",
3679    "minimum_contrast": 45,
3680    "option_as_meta": false,
3681    "button": true,
3682    "shell": "system",
3683    "scroll_multiplier": 3.0,
3684    "toolbar": {
3685      "breadcrumbs": false
3686    },
3687    "working_directory": "current_project_directory",
3688    "scrollbar": {
3689      "show": null
3690    }
3691  }
3692}
3693```
3694
3695### Terminal: Dock
3696
3697- Description: Control the position of the dock
3698- Setting: `dock`
3699- Default: `bottom`
3700
3701**Options**
3702
3703`"bottom"`, `"left"` or `"right"`
3704
3705### Terminal: Alternate Scroll
3706
3707- 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.
3708- Setting: `alternate_scroll`
3709- Default: `off`
3710
3711**Options**
3712
37131. Default alternate scroll mode to off
3714
3715```json [settings]
3716{
3717  "terminal": {
3718    "alternate_scroll": "off"
3719  }
3720}
3721```
3722
37232. Default alternate scroll mode to on
3724
3725```json [settings]
3726{
3727  "terminal": {
3728    "alternate_scroll": "on"
3729  }
3730}
3731```
3732
3733### Terminal: Blinking
3734
3735- Description: Set the cursor blinking behavior in the terminal
3736- Setting: `blinking`
3737- Default: `terminal_controlled`
3738
3739**Options**
3740
37411. Never blink the cursor, ignore the terminal mode
3742
3743```json [settings]
3744{
3745  "terminal": {
3746    "blinking": "off"
3747  }
3748}
3749```
3750
37512. Default the cursor blink to off, but allow the terminal to turn blinking on
3752
3753```json [settings]
3754{
3755  "terminal": {
3756    "blinking": "terminal_controlled"
3757  }
3758}
3759```
3760
37613. Always blink the cursor, ignore the terminal mode
3762
3763```json [settings]
3764{
3765  "terminal": {
3766    "blinking": "on"
3767  }
3768}
3769```
3770
3771### Terminal: Copy On Select
3772
3773- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3774- Setting: `copy_on_select`
3775- Default: `false`
3776
3777**Options**
3778
3779`boolean` values
3780
3781**Example**
3782
3783```json [settings]
3784{
3785  "terminal": {
3786    "copy_on_select": true
3787  }
3788}
3789```
3790
3791### Terminal: Cursor Shape
3792
3793- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3794- Setting: `cursor_shape`
3795- Default: `null` (defaults to block)
3796
3797**Options**
3798
37991. A block that surrounds the following character
3800
3801```json [settings]
3802{
3803  "terminal": {
3804    "cursor_shape": "block"
3805  }
3806}
3807```
3808
38092. A vertical bar
3810
3811```json [settings]
3812{
3813  "terminal": {
3814    "cursor_shape": "bar"
3815  }
3816}
3817```
3818
38193. An underline / underscore that runs along the following character
3820
3821```json [settings]
3822{
3823  "terminal": {
3824    "cursor_shape": "underline"
3825  }
3826}
3827```
3828
38294. A box drawn around the following character
3830
3831```json [settings]
3832{
3833  "terminal": {
3834    "cursor_shape": "hollow"
3835  }
3836}
3837```
3838
3839### Terminal: Keep Selection On Copy
3840
3841- Description: Whether or not to keep the selection in the terminal after copying text.
3842- Setting: `keep_selection_on_copy`
3843- Default: `true`
3844
3845**Options**
3846
3847`boolean` values
3848
3849**Example**
3850
3851```json [settings]
3852{
3853  "terminal": {
3854    "keep_selection_on_copy": false
3855  }
3856}
3857```
3858
3859### Terminal: Env
3860
3861- 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
3862- Setting: `env`
3863- Default: `{}`
3864
3865**Example**
3866
3867```json [settings]
3868{
3869  "terminal": {
3870    "env": {
3871      "ZED": "1",
3872      "KEY": "value1:value2"
3873    }
3874  }
3875}
3876```
3877
3878### Terminal: Font Size
3879
3880- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3881- Setting: `font_size`
3882- Default: `null`
3883
3884**Options**
3885
3886`integer` values
3887
3888```json [settings]
3889{
3890  "terminal": {
3891    "font_size": 15
3892  }
3893}
3894```
3895
3896### Terminal: Font Family
3897
3898- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3899- Setting: `font_family`
3900- Default: `null`
3901
3902**Options**
3903
3904The name of any font family installed on the user's system
3905
3906```json [settings]
3907{
3908  "terminal": {
3909    "font_family": "Berkeley Mono"
3910  }
3911}
3912```
3913
3914### Terminal: Font Features
3915
3916- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3917- Setting: `font_features`
3918- Default: `null`
3919- Platform: macOS and Windows.
3920
3921**Options**
3922
3923See Buffer Font Features
3924
3925```json [settings]
3926{
3927  "terminal": {
3928    "font_features": {
3929      "calt": false
3930      // See Buffer Font Features for more features
3931    }
3932  }
3933}
3934```
3935
3936### Terminal: Line Height
3937
3938- Description: Set the terminal's line height.
3939- Setting: `line_height`
3940- Default: `standard`
3941
3942**Options**
3943
39441. Use a line height that's `comfortable` for reading, 1.618.
3945
3946```json [settings]
3947{
3948  "terminal": {
3949    "line_height": "comfortable"
3950  }
3951}
3952```
3953
39542. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3955
3956```json [settings]
3957{
3958  "terminal": {
3959    "line_height": "standard"
3960  }
3961}
3962```
3963
39643.  Use a custom line height.
3965
3966```json [settings]
3967{
3968  "terminal": {
3969    "line_height": {
3970      "custom": 2
3971    }
3972  }
3973}
3974```
3975
3976### Terminal: Minimum Contrast
3977
3978- 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.
3979- Setting: `minimum_contrast`
3980- Default: `45`
3981
3982**Options**
3983
3984`integer` values from 0 to 106. Common recommended values:
3985
3986- `0`: No contrast adjustment
3987- `45`: Minimum for large fluent text (default)
3988- `60`: Minimum for other content text
3989- `75`: Minimum for body text
3990- `90`: Preferred for body text
3991
3992```json [settings]
3993{
3994  "terminal": {
3995    "minimum_contrast": 45
3996  }
3997}
3998```
3999
4000### Terminal: Option As Meta
4001
4002- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
4003- Setting: `option_as_meta`
4004- Default: `false`
4005
4006**Options**
4007
4008`boolean` values
4009
4010```json [settings]
4011{
4012  "terminal": {
4013    "option_as_meta": true
4014  }
4015}
4016```
4017
4018### Terminal: Shell
4019
4020- Description: What shell to use when launching the terminal.
4021- Setting: `shell`
4022- Default: `system`
4023
4024**Options**
4025
40261. Use the system's default terminal configuration (usually the `/etc/passwd` file).
4027
4028```json [settings]
4029{
4030  "terminal": {
4031    "shell": "system"
4032  }
4033}
4034```
4035
40362. A program to launch:
4037
4038```json [settings]
4039{
4040  "terminal": {
4041    "shell": {
4042      "program": "sh"
4043    }
4044  }
4045}
4046```
4047
40483. A program with arguments:
4049
4050```json [settings]
4051{
4052  "terminal": {
4053    "shell": {
4054      "with_arguments": {
4055        "program": "/bin/bash",
4056        "args": ["--login"]
4057      }
4058    }
4059  }
4060}
4061```
4062
4063## Terminal: Detect Virtual Environments {#terminal-detect_venv}
4064
4065- 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.
4066- Setting: `detect_venv`
4067- Default:
4068
4069```json [settings]
4070{
4071  "terminal": {
4072    "detect_venv": {
4073      "on": {
4074        // Default directories to search for virtual environments, relative
4075        // to the current working directory. We recommend overriding this
4076        // in your project's settings, rather than globally.
4077        "directories": [".env", "env", ".venv", "venv"],
4078        // Can also be `csh`, `fish`, and `nushell`
4079        "activate_script": "default"
4080      }
4081    }
4082  }
4083}
4084```
4085
4086Disable with:
4087
4088```json [settings]
4089{
4090  "terminal": {
4091    "detect_venv": "off"
4092  }
4093}
4094```
4095
4096### Terminal: Scroll Multiplier
4097
4098- Description: The multiplier for scrolling speed in the terminal when using mouse wheel or trackpad.
4099- Setting: `scroll_multiplier`
4100- Default: `1.0`
4101
4102**Options**
4103
4104Positive floating point values. Values less than or equal to 0 will be clamped to a minimum of 0.01.
4105
4106**Example**
4107
4108```json
4109{
4110  "terminal": {
4111    "scroll_multiplier": 5.0
4112  }
4113}
4114```
4115
4116## Terminal: Toolbar
4117
4118- Description: Whether or not to show various elements in the terminal toolbar.
4119- Setting: `toolbar`
4120- Default:
4121
4122```json [settings]
4123{
4124  "terminal": {
4125    "toolbar": {
4126      "breadcrumbs": false
4127    }
4128  }
4129}
4130```
4131
4132**Options**
4133
4134At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
4135
4136If the terminal title is empty, the breadcrumbs won't be shown.
4137
4138The shell running in the terminal needs to be configured to emit the title.
4139
4140Example command to set the title: `echo -e "\e]2;New Title\007";`
4141
4142### Terminal: Button
4143
4144- Description: Control to show or hide the terminal button in the status bar
4145- Setting: `button`
4146- Default: `true`
4147
4148**Options**
4149
4150`boolean` values
4151
4152```json [settings]
4153{
4154  "terminal": {
4155    "button": false
4156  }
4157}
4158```
4159
4160### Terminal: Working Directory
4161
4162- Description: What working directory to use when launching the terminal.
4163- Setting: `working_directory`
4164- Default: `"current_project_directory"`
4165
4166**Options**
4167
41681. Use the current file's project directory. Fallback to the first project directory strategy if unsuccessful.
4169
4170```json [settings]
4171{
4172  "terminal": {
4173    "working_directory": "current_project_directory"
4174  }
4175}
4176```
4177
41782. Use the first project in this workspace's directory. Fallback to using this platform's home directory.
4179
4180```json [settings]
4181{
4182  "terminal": {
4183    "working_directory": "first_project_directory"
4184  }
4185}
4186```
4187
41883. Always use this platform's home directory if it can be found.
4189
4190```json [settings]
4191{
4192  "terminal": {
4193    "working_directory": "always_home"
4194  }
4195}
4196```
4197
41984. 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.
4199
4200```json [settings]
4201{
4202  "terminal": {
4203    "working_directory": {
4204      "always": {
4205        "directory": "~/zed/projects/"
4206      }
4207    }
4208  }
4209}
4210```
4211
4212### Terminal: Path Hyperlink Regexes
4213
4214- Description: Regexes used to identify path hyperlinks. The regexes can be specified in two forms - a single regex string, or an array of strings (which will be collected into a single multi-line regex string).
4215- Setting: `path_hyperlink_regexes`
4216- Default:
4217
4218```json [settings]
4219{
4220  "terminal": {
4221    "path_hyperlink_regexes": [
4222      // Python-style diagnostics
4223      "File \"(?<path>[^\"]+)\", line (?<line>[0-9]+)",
4224      // Common path syntax with optional line, column, description, trailing punctuation, or
4225      // surrounding symbols or quotes
4226      [
4227        "(?x)",
4228        "# optionally starts with 0-2 opening prefix symbols",
4229        "[({\\[<]{0,2}",
4230        "# which may be followed by an opening quote",
4231        "(?<quote>[\"'`])?",
4232        "# `path` is the shortest sequence of any non-space character",
4233        "(?<link>(?<path>[^ ]+?",
4234        "    # which may end with a line and optionally a column,",
4235        "    (?<line_column>:+[0-9]+(:[0-9]+)?|:?\\([0-9]+([,:][0-9]+)?\\))?",
4236        "))",
4237        "# which must be followed by a matching quote",
4238        "(?(<quote>)\\k<quote>)",
4239        "# and optionally a single closing symbol",
4240        "[)}\\]>]?",
4241        "# if line/column matched, may be followed by a description",
4242        "(?(<line_column>):[^ 0-9][^ ]*)?",
4243        "# which may be followed by trailing punctuation",
4244        "[.,:)}\\]>]*",
4245        "# and always includes trailing whitespace or end of line",
4246        "([ ]+|$)"
4247      ]
4248    ]
4249  }
4250}
4251```
4252
4253### Terminal: Path Hyperlink Timeout (ms)
4254
4255- Description: Maximum time to search for a path hyperlink. When set to 0, path hyperlinks are disabled.
4256- Setting: `path_hyperlink_timeout_ms`
4257- Default: `1`
4258
4259## REPL
4260
4261- Description: Repl settings.
4262- Setting: `repl`
4263- Default:
4264
4265```json [settings]
4266"repl": {
4267  // Maximum number of columns to keep in REPL's scrollback buffer.
4268  // Clamped with [20, 512] range.
4269  "max_columns": 128,
4270  // Maximum number of lines to keep in REPL's scrollback buffer.
4271  // Clamped with [4, 256] range.
4272  "max_lines": 32
4273},
4274```
4275
4276## Theme
4277
4278- 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.
4279- Setting: `theme`
4280- Default: `One Dark`
4281
4282### Theme Object
4283
4284- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4285- Setting: `theme`
4286- Default:
4287
4288```json [settings]
4289"theme": {
4290  "mode": "system",
4291  "dark": "One Dark",
4292  "light": "One Light"
4293},
4294```
4295
4296### Mode
4297
4298- Description: Specify theme mode.
4299- Setting: `mode`
4300- Default: `system`
4301
4302**Options**
4303
43041. Set the theme to dark mode
4305
4306```json [settings]
4307{
4308  "mode": "dark"
4309}
4310```
4311
43122. Set the theme to light mode
4313
4314```json [settings]
4315{
4316  "mode": "light"
4317}
4318```
4319
43203. Set the theme to system mode
4321
4322```json [settings]
4323{
4324  "mode": "system"
4325}
4326```
4327
4328### Dark
4329
4330- Description: The name of the dark Zed theme to use for the UI.
4331- Setting: `dark`
4332- Default: `One Dark`
4333
4334**Options**
4335
4336Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4337
4338### Light
4339
4340- Description: The name of the light Zed theme to use for the UI.
4341- Setting: `light`
4342- Default: `One Light`
4343
4344**Options**
4345
4346Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4347
4348## Title Bar
4349
4350- Description: Whether or not to show various elements in the title bar
4351- Setting: `title_bar`
4352- Default:
4353
4354```json [settings]
4355"title_bar": {
4356  "show_branch_icon": false,
4357  "show_branch_name": true,
4358  "show_project_items": true,
4359  "show_onboarding_banner": true,
4360  "show_user_picture": true,
4361  "show_user_menu": true,
4362  "show_sign_in": true,
4363  "show_menus": false
4364}
4365```
4366
4367**Options**
4368
4369- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4370- `show_branch_name`: Whether to show the branch name button in the titlebar
4371- `show_project_items`: Whether to show the project host and name in the titlebar
4372- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4373- `show_user_picture`: Whether to show user picture in the titlebar
4374- `show_user_menu`: Whether to show the user menu button in the titlebar (the one that displays your avatar by default and contains options like Settings, Keymap, Themes, etc.)
4375- `show_sign_in`: Whether to show the sign in button in the titlebar
4376- `show_menus`: Whether to show the menus in the titlebar
4377
4378## Vim
4379
4380- Description: Whether or not to enable vim mode.
4381- Setting: `vim_mode`
4382- Default: `false`
4383
4384## When Closing With No Tabs
4385
4386- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4387- Setting: `when_closing_with_no_tabs`
4388- Default: `"platform_default"`
4389
4390**Options**
4391
43921. Use platform default behavior:
4393
4394```json [settings]
4395{
4396  "when_closing_with_no_tabs": "platform_default"
4397}
4398```
4399
44002. Always close the window:
4401
4402```json [settings]
4403{
4404  "when_closing_with_no_tabs": "close_window"
4405}
4406```
4407
44083. Never close the window:
4409
4410```json [settings]
4411{
4412  "when_closing_with_no_tabs": "keep_window_open"
4413}
4414```
4415
4416## Project Panel
4417
4418- Description: Customize project panel
4419- Setting: `project_panel`
4420- Default:
4421
4422```json [settings]
4423{
4424  "project_panel": {
4425    "button": true,
4426    "default_width": 240,
4427    "dock": "left",
4428    "entry_spacing": "comfortable",
4429    "file_icons": true,
4430    "folder_icons": true,
4431    "git_status": true,
4432    "indent_size": 20,
4433    "auto_reveal_entries": true,
4434    "auto_fold_dirs": true,
4435    "drag_and_drop": true,
4436    "scrollbar": {
4437      "show": null
4438    },
4439    "sticky_scroll": true,
4440    "show_diagnostics": "all",
4441    "indent_guides": {
4442      "show": "always"
4443    },
4444    "sort_mode": "directories_first",
4445    "hide_root": false,
4446    "hide_hidden": false,
4447    "starts_open": true,
4448    "auto_open": {
4449      "on_create": true,
4450      "on_paste": true,
4451      "on_drop": true
4452    }
4453  }
4454}
4455```
4456
4457### Dock
4458
4459- Description: Control the position of the dock
4460- Setting: `dock`
4461- Default: `left`
4462
4463**Options**
4464
44651. Default dock position to left
4466
4467```json [settings]
4468{
4469  "dock": "left"
4470}
4471```
4472
44732. Default dock position to right
4474
4475```json [settings]
4476{
4477  "dock": "right"
4478}
4479```
4480
4481### Entry Spacing
4482
4483- Description: Spacing between worktree entries
4484- Setting: `entry_spacing`
4485- Default: `comfortable`
4486
4487**Options**
4488
44891. Comfortable entry spacing
4490
4491```json [settings]
4492{
4493  "entry_spacing": "comfortable"
4494}
4495```
4496
44972. Standard entry spacing
4498
4499```json [settings]
4500{
4501  "entry_spacing": "standard"
4502}
4503```
4504
4505### Git Status
4506
4507- Description: Indicates newly created and updated files
4508- Setting: `git_status`
4509- Default: `true`
4510
4511**Options**
4512
45131. Default enable git status
4514
4515```json [settings]
4516{
4517  "git_status": true
4518}
4519```
4520
45212. Default disable git status
4522
4523```json [settings]
4524{
4525  "git_status": false
4526}
4527```
4528
4529### Default Width
4530
4531- Description: Customize default width taken by project panel
4532- Setting: `default_width`
4533- Default: `240`
4534
4535**Options**
4536
4537`float` values
4538
4539### Auto Reveal Entries
4540
4541- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4542- Setting: `auto_reveal_entries`
4543- Default: `true`
4544
4545**Options**
4546
45471. Enable auto reveal entries
4548
4549```json [settings]
4550{
4551  "auto_reveal_entries": true
4552}
4553```
4554
45552. Disable auto reveal entries
4556
4557```json [settings]
4558{
4559  "auto_reveal_entries": false
4560}
4561```
4562
4563### Auto Fold Dirs
4564
4565- Description: Whether to fold directories automatically when directory has only one directory inside.
4566- Setting: `auto_fold_dirs`
4567- Default: `true`
4568
4569**Options**
4570
45711. Enable auto fold dirs
4572
4573```json [settings]
4574{
4575  "auto_fold_dirs": true
4576}
4577```
4578
45792. Disable auto fold dirs
4580
4581```json [settings]
4582{
4583  "auto_fold_dirs": false
4584}
4585```
4586
4587### Indent Size
4588
4589- Description: Amount of indentation (in pixels) for nested items.
4590- Setting: `indent_size`
4591- Default: `20`
4592
4593### Indent Guides: Show
4594
4595- Description: Whether to show indent guides in the project panel.
4596- Setting: `indent_guides`
4597- Default:
4598
4599```json [settings]
4600"indent_guides": {
4601  "show": "always"
4602}
4603```
4604
4605**Options**
4606
46071. Show indent guides in the project panel
4608
4609```json [settings]
4610{
4611  "indent_guides": {
4612    "show": "always"
4613  }
4614}
4615```
4616
46172. Hide indent guides in the project panel
4618
4619```json [settings]
4620{
4621  "indent_guides": {
4622    "show": "never"
4623  }
4624}
4625```
4626
4627### Scrollbar: Show
4628
4629- 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.
4630- Setting: `scrollbar`
4631- Default:
4632
4633```json [settings]
4634"scrollbar": {
4635  "show": null
4636}
4637```
4638
4639**Options**
4640
46411. Show scrollbar in the project panel
4642
4643```json [settings]
4644{
4645  "scrollbar": {
4646    "show": "always"
4647  }
4648}
4649```
4650
46512. Hide scrollbar in the project panel
4652
4653```json [settings]
4654{
4655  "scrollbar": {
4656    "show": "never"
4657  }
4658}
4659```
4660
4661### Sort Mode
4662
4663- Description: Sort order for entries in the project panel
4664- Setting: `sort_mode`
4665- Default: `directories_first`
4666
4667**Options**
4668
46691. Show directories first, then files
4670
4671```json [settings]
4672{
4673  "sort_mode": "directories_first"
4674}
4675```
4676
46772. Mix directories and files together
4678
4679```json [settings]
4680{
4681  "sort_mode": "mixed"
4682}
4683```
4684
46853. Show files first, then directories
4686
4687```json [settings]
4688{
4689  "sort_mode": "files_first"
4690}
4691```
4692
4693### Auto Open
4694
4695- Description: Control whether files are opened automatically after different creation flows in the project panel.
4696- Setting: `auto_open`
4697- Default:
4698
4699```json [settings]
4700"auto_open": {
4701  "on_create": true,
4702  "on_paste": true,
4703  "on_drop": true
4704}
4705```
4706
4707**Options**
4708
4709- `on_create`: Whether to automatically open newly created files in the editor.
4710- `on_paste`: Whether to automatically open files after pasting or duplicating them.
4711- `on_drop`: Whether to automatically open files dropped from external sources.
4712
4713## Agent
4714
4715Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4716
4717## Collaboration Panel
4718
4719- Description: Customizations for the collaboration panel.
4720- Setting: `collaboration_panel`
4721- Default:
4722
4723```json [settings]
4724{
4725  "collaboration_panel": {
4726    "button": true,
4727    "dock": "left",
4728    "default_width": 240
4729  }
4730}
4731```
4732
4733**Options**
4734
4735- `button`: Whether to show the collaboration panel button in the status bar
4736- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4737- `default_width`: Default width of the collaboration panel
4738
4739## Debugger
4740
4741- Description: Configuration for debugger panel and settings
4742- Setting: `debugger`
4743- Default:
4744
4745```json [settings]
4746{
4747  "debugger": {
4748    "stepping_granularity": "line",
4749    "save_breakpoints": true,
4750    "dock": "bottom",
4751    "button": true
4752  }
4753}
4754```
4755
4756See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4757
4758## Git Panel
4759
4760- Description: Setting to customize the behavior of the git panel.
4761- Setting: `git_panel`
4762- Default:
4763
4764```json [settings]
4765{
4766  "git_panel": {
4767    "button": true,
4768    "dock": "left",
4769    "default_width": 360,
4770    "status_style": "icon",
4771    "fallback_branch_name": "main",
4772    "sort_by_path": false,
4773    "collapse_untracked_diff": false,
4774    "scrollbar": {
4775      "show": null
4776    }
4777  }
4778}
4779```
4780
4781**Options**
4782
4783- `button`: Whether to show the git panel button in the status bar
4784- `dock`: Where to dock the git panel. Can be `left` or `right`
4785- `default_width`: Default width of the git panel
4786- `status_style`: How to display git status. Can be `label_color` or `icon`
4787- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4788- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4789- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4790- `scrollbar`: When to show the scrollbar in the git panel
4791
4792## Git Hosting Providers
4793
4794- Description: Register self-hosted GitHub, GitLab, or Bitbucket instances so commit hashes, issue references, and permalinks resolve to the right host.
4795- Setting: `git_hosting_providers`
4796- Default: `[]`
4797
4798**Options**
4799
4800Each entry accepts:
4801
4802- `provider`: One of `github`, `gitlab`, or `bitbucket`
4803- `name`: Display name for the instance
4804- `base_url`: Base URL, e.g. `https://git.example.corp`
4805
4806You can define these in user or project settings; project settings are merged on top of user settings.
4807
4808```json [settings]
4809{
4810  "git_hosting_providers": [
4811    {
4812      "provider": "github",
4813      "name": "BigCorp GitHub",
4814      "base_url": "https://git.example.corp"
4815    }
4816  ]
4817}
4818```
4819
4820## Outline Panel
4821
4822- Description: Customize outline Panel
4823- Setting: `outline_panel`
4824- Default:
4825
4826```json [settings]
4827"outline_panel": {
4828  "button": true,
4829  "default_width": 300,
4830  "dock": "left",
4831  "file_icons": true,
4832  "folder_icons": true,
4833  "git_status": true,
4834  "indent_size": 20,
4835  "auto_reveal_entries": true,
4836  "auto_fold_dirs": true,
4837  "indent_guides": {
4838    "show": "always"
4839  },
4840  "scrollbar": {
4841    "show": null
4842  }
4843}
4844```
4845
4846## Calls
4847
4848- Description: Customize behavior when participating in a call
4849- Setting: `calls`
4850- Default:
4851
4852```json [settings]
4853"calls": {
4854  // Join calls with the microphone live by default
4855  "mute_on_join": false,
4856  // Share your project when you are the first to join a channel
4857  "share_on_join": false
4858},
4859```
4860
4861## Colorize Brackets
4862
4863- Description: Whether to use tree-sitter bracket queries to detect and colorize the brackets in the editor (also known as "rainbow brackets").
4864- Setting: `colorize_brackets`
4865- Default: `false`
4866
4867**Options**
4868
4869`boolean` values
4870
4871The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
4872
4873## Unnecessary Code Fade
4874
4875- Description: How much to fade out unused code.
4876- Setting: `unnecessary_code_fade`
4877- Default: `0.3`
4878
4879**Options**
4880
4881Float values between `0.0` and `0.9`, where:
4882
4883- `0.0` means no fading (unused code looks the same as used code)
4884- `0.9` means maximum fading (unused code is very faint but still visible)
4885
4886**Example**
4887
4888```json [settings]
4889{
4890  "unnecessary_code_fade": 0.5
4891}
4892```
4893
4894## UI Font Family
4895
4896- Description: The name of the font to use for text in the UI.
4897- Setting: `ui_font_family`
4898- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4899
4900**Options**
4901
4902The 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).
4903
4904## UI Font Features
4905
4906- Description: The OpenType features to enable for text in the UI.
4907- Setting: `ui_font_features`
4908- Default:
4909
4910```json [settings]
4911"ui_font_features": {
4912  "calt": false
4913}
4914```
4915
4916- Platform: macOS and Windows.
4917
4918**Options**
4919
4920Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4921
4922For example, to disable font ligatures, add the following to your settings:
4923
4924```json [settings]
4925{
4926  "ui_font_features": {
4927    "calt": false
4928  }
4929}
4930```
4931
4932You can also set other OpenType features, like setting `cv01` to `7`:
4933
4934```json [settings]
4935{
4936  "ui_font_features": {
4937    "cv01": 7
4938  }
4939}
4940```
4941
4942## UI Font Fallbacks
4943
4944- Description: The font fallbacks to use for text in the UI.
4945- Setting: `ui_font_fallbacks`
4946- Default: `null`
4947- Platform: macOS and Windows.
4948
4949**Options**
4950
4951For example, to use `Nerd Font` as a fallback, add the following to your settings:
4952
4953```json [settings]
4954{
4955  "ui_font_fallbacks": ["Nerd Font"]
4956}
4957```
4958
4959## UI Font Size
4960
4961- Description: The default font size for text in the UI.
4962- Setting: `ui_font_size`
4963- Default: `16`
4964
4965**Options**
4966
4967`integer` values from `6` to `100` pixels (inclusive)
4968
4969## UI Font Weight
4970
4971- Description: The default font weight for text in the UI.
4972- Setting: `ui_font_weight`
4973- Default: `400`
4974
4975**Options**
4976
4977`integer` values between `100` and `900`
4978
4979## Settings Profiles
4980
4981- Description: Configure any number of settings profiles that are temporarily applied on top of your existing user settings when selected from `settings profile selector: toggle`.
4982- Setting: `profiles`
4983- Default: `{}`
4984
4985In your `settings.json` file, add the `profiles` object.
4986Each key within this object is the name of a settings profile, and each value is an object that can include any of Zed's settings.
4987
4988Example:
4989
4990```json [settings]
4991"profiles": {
4992  "Presenting (Dark)": {
4993    "agent_buffer_font_size": 18.0,
4994    "buffer_font_size": 18.0,
4995    "theme": "One Dark",
4996    "ui_font_size": 18.0
4997  },
4998  "Presenting (Light)": {
4999    "agent_buffer_font_size": 18.0,
5000    "buffer_font_size": 18.0,
5001    "theme": "One Light",
5002    "ui_font_size": 18.0
5003  },
5004  "Writing": {
5005    "agent_buffer_font_size": 15.0,
5006    "buffer_font_size": 15.0,
5007    "theme": "Catppuccin Frappé - No Italics",
5008    "ui_font_size": 15.0,
5009    "tab_bar": { "show": false },
5010    "toolbar": { "breadcrumbs": false }
5011  }
5012}
5013```
5014
5015To preview and enable a settings profile, open the command palette via {#kb command_palette::Toggle} and search for `settings profile selector: toggle`.
5016
5017## An example configuration:
5018
5019```json [settings]
5020// ~/.config/zed/settings.json
5021{
5022  "theme": "cave-light",
5023  "tab_size": 2,
5024  "preferred_line_length": 80,
5025  "soft_wrap": "none",
5026
5027  "buffer_font_size": 18,
5028  "buffer_font_family": ".ZedMono",
5029
5030  "autosave": "on_focus_change",
5031  "format_on_save": "off",
5032  "vim_mode": false,
5033  "projects_online_by_default": true,
5034  "terminal": {
5035    "font_family": "FiraCode Nerd Font Mono",
5036    "blinking": "off"
5037  },
5038  "languages": {
5039    "C": {
5040      "format_on_save": "on",
5041      "formatter": "language_server",
5042      "preferred_line_length": 64,
5043      "soft_wrap": "preferred_line_length"
5044    }
5045  }
5046}
5047```