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    "google": {
2671      "api_url": "https://generativelanguage.googleapis.com"
2672    },
2673    "ollama": {
2674      "api_url": "http://localhost:11434"
2675    },
2676    "openai": {
2677      "api_url": "https://api.openai.com/v1"
2678    }
2679  }
2680}
2681```
2682
2683**Options**
2684
2685Configuration for various AI model providers including API URLs and authentication settings.
2686
2687## Line Indicator Format
2688
2689- Description: Format for line indicator in the status bar
2690- Setting: `line_indicator_format`
2691- Default: `"short"`
2692
2693**Options**
2694
26951. Short format:
2696
2697```json [settings]
2698{
2699  "line_indicator_format": "short"
2700}
2701```
2702
27032. Long format:
2704
2705```json [settings]
2706{
2707  "line_indicator_format": "long"
2708}
2709```
2710
2711## Linked Edits
2712
2713- 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.
2714- Setting: `linked_edits`
2715- Default: `true`
2716
2717**Options**
2718
2719`boolean` values
2720
2721## LSP Document Colors
2722
2723- Description: Whether to show document color information from the language server
2724- Setting: `lsp_document_colors`
2725- Default: `true`
2726
2727**Options**
2728
2729`boolean` values
2730
2731## Max Tabs
2732
2733- Description: Maximum number of tabs to show in the tab bar
2734- Setting: `max_tabs`
2735- Default: `null`
2736
2737**Options**
2738
2739Positive `integer` values or `null` for unlimited tabs
2740
2741## Middle Click Paste (Linux only)
2742
2743- Description: Enable middle-click paste on Linux
2744- Setting: `middle_click_paste`
2745- Default: `true`
2746
2747**Options**
2748
2749`boolean` values
2750
2751## Multi Cursor Modifier
2752
2753- 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.
2754- Setting: `multi_cursor_modifier`
2755- Default: `alt`
2756
2757**Options**
2758
27591. Maps to `Alt` on Linux and Windows and to `Option` on macOS:
2760
2761```json [settings]
2762{
2763  "multi_cursor_modifier": "alt"
2764}
2765```
2766
27672. Maps `Control` on Linux and Windows and to `Command` on macOS:
2768
2769```json [settings]
2770{
2771  "multi_cursor_modifier": "cmd_or_ctrl" // alias: "cmd", "ctrl"
2772}
2773```
2774
2775## Node
2776
2777- Description: Configuration for Node.js integration
2778- Setting: `node`
2779- Default:
2780
2781```json [settings]
2782{
2783  "node": {
2784    "ignore_system_version": false,
2785    "path": null,
2786    "npm_path": null
2787  }
2788}
2789```
2790
2791**Options**
2792
2793- `ignore_system_version`: Whether to ignore the system Node.js version
2794- `path`: Custom path to Node.js binary
2795- `npm_path`: Custom path to npm binary
2796
2797## Network Proxy
2798
2799- Description: Configure a network proxy for Zed.
2800- Setting: `proxy`
2801- Default: `null`
2802
2803**Options**
2804
2805The proxy setting must contain a URL to the proxy.
2806
2807The following URI schemes are supported:
2808
2809- `http`
2810- `https`
2811- `socks4` - SOCKS4 proxy with local DNS
2812- `socks4a` - SOCKS4 proxy with remote DNS
2813- `socks5` - SOCKS5 proxy with local DNS
2814- `socks5h` - SOCKS5 proxy with remote DNS
2815
2816`http` will be used when no scheme is specified.
2817
2818By 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`.
2819
2820For example, to set an `http` proxy, add the following to your settings:
2821
2822```json [settings]
2823{
2824  "proxy": "http://127.0.0.1:10809"
2825}
2826```
2827
2828Or to set a `socks5` proxy:
2829
2830```json [settings]
2831{
2832  "proxy": "socks5h://localhost:10808"
2833}
2834```
2835
2836If 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.
2837
2838## On Last Window Closed
2839
2840- Description: What to do when the last window is closed
2841- Setting: `on_last_window_closed`
2842- Default: `"platform_default"`
2843
2844**Options**
2845
28461. Use platform default behavior:
2847
2848```json [settings]
2849{
2850  "on_last_window_closed": "platform_default"
2851}
2852```
2853
28542. Always quit the application:
2855
2856```json [settings]
2857{
2858  "on_last_window_closed": "quit_app"
2859}
2860```
2861
2862## Profiles
2863
2864- Description: Configuration profiles that can be applied on top of existing settings
2865- Setting: `profiles`
2866- Default: `{}`
2867
2868**Options**
2869
2870Configuration object for defining settings profiles. Example:
2871
2872```json [settings]
2873{
2874  "profiles": {
2875    "presentation": {
2876      "buffer_font_size": 20,
2877      "ui_font_size": 18,
2878      "theme": "One Light"
2879    }
2880  }
2881}
2882```
2883
2884## Preview tabs
2885
2886- Description:
2887  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. \
2888   There are several ways to convert a preview tab into a regular tab:
2889
2890  - Double-clicking on the file
2891  - Double-clicking on the tab header
2892  - Using the {#action project_panel::OpenPermanent} action
2893  - Editing the file
2894  - Dragging the file to a different pane
2895
2896- Setting: `preview_tabs`
2897- Default:
2898
2899```json [settings]
2900"preview_tabs": {
2901  "enabled": true,
2902  "enable_preview_from_project_panel": true,
2903  "enable_preview_from_file_finder": false,
2904  "enable_preview_from_multibuffer": true,
2905  "enable_preview_multibuffer_from_code_navigation": false,
2906  "enable_preview_file_from_code_navigation": true,
2907  "enable_keep_preview_on_code_navigation": false,
2908}
2909```
2910
2911### Enable preview from project panel
2912
2913- Description: Determines whether to open files in preview mode when opened from the project panel with a single click.
2914- Setting: `enable_preview_from_project_panel`
2915- Default: `true`
2916
2917**Options**
2918
2919`boolean` values
2920
2921### Enable preview from file finder
2922
2923- Description: Determines whether to open files in preview mode when selected from the file finder.
2924- Setting: `enable_preview_from_file_finder`
2925- Default: `false`
2926
2927**Options**
2928
2929`boolean` values
2930
2931### Enable preview from multibuffer
2932
2933- Description: Determines whether to open files in preview mode when opened from a multibuffer.
2934- Setting: `enable_preview_from_multibuffer`
2935- Default: `true`
2936
2937**Options**
2938
2939`boolean` values
2940
2941### Enable preview multibuffer from code navigation
2942
2943- Description: Determines whether to open tabs in preview mode when code navigation is used to open a multibuffer.
2944- Setting: `enable_preview_multibuffer_from_code_navigation`
2945- Default: `false`
2946
2947**Options**
2948
2949`boolean` values
2950
2951### Enable preview file from code navigation
2952
2953- Description: Determines whether to open tabs in preview mode when code navigation is used to open a single file.
2954- Setting: `enable_preview_file_from_code_navigation`
2955- Default: `true`
2956
2957**Options**
2958
2959`boolean` values
2960
2961### Enable keep preview on code navigation
2962
2963- 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.
2964- Setting: `enable_keep_preview_on_code_navigation`
2965- Default: `false`
2966
2967**Options**
2968
2969`boolean` values
2970
2971## File Finder
2972
2973### File Icons
2974
2975- Description: Whether to show file icons in the file finder.
2976- Setting: `file_icons`
2977- Default: `true`
2978
2979### Modal Max Width
2980
2981- Description: Max-width of the file finder modal. It can take one of these values: `small`, `medium`, `large`, `xlarge`, and `full`.
2982- Setting: `modal_max_width`
2983- Default: `small`
2984
2985### Skip Focus For Active In Search
2986
2987- Description: Determines whether the file finder should skip focus for the active file in search results.
2988- Setting: `skip_focus_for_active_in_search`
2989- Default: `true`
2990
2991## Pane Split Direction Horizontal
2992
2993- Description: The direction that you want to split panes horizontally
2994- Setting: `pane_split_direction_horizontal`
2995- Default: `"up"`
2996
2997**Options**
2998
29991. Split upward:
3000
3001```json [settings]
3002{
3003  "pane_split_direction_horizontal": "up"
3004}
3005```
3006
30072. Split downward:
3008
3009```json [settings]
3010{
3011  "pane_split_direction_horizontal": "down"
3012}
3013```
3014
3015## Pane Split Direction Vertical
3016
3017- Description: The direction that you want to split panes vertically
3018- Setting: `pane_split_direction_vertical`
3019- Default: `"left"`
3020
3021**Options**
3022
30231. Split to the left:
3024
3025```json [settings]
3026{
3027  "pane_split_direction_vertical": "left"
3028}
3029```
3030
30312. Split to the right:
3032
3033```json [settings]
3034{
3035  "pane_split_direction_vertical": "right"
3036}
3037```
3038
3039## Preferred Line Length
3040
3041- Description: The column at which to soft-wrap lines, for buffers where soft-wrap is enabled.
3042- Setting: `preferred_line_length`
3043- Default: `80`
3044
3045**Options**
3046
3047`integer` values
3048
3049## Private Files
3050
3051- Description: Globs to match against file paths to determine if a file is private
3052- Setting: `private_files`
3053- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
3054
3055**Options**
3056
3057List of `string` glob patterns
3058
3059## Projects Online By Default
3060
3061- Description: Whether or not to show the online projects view by default.
3062- Setting: `projects_online_by_default`
3063- Default: `true`
3064
3065**Options**
3066
3067`boolean` values
3068
3069## Read SSH Config
3070
3071- Description: Whether to read SSH configuration files
3072- Setting: `read_ssh_config`
3073- Default: `true`
3074
3075**Options**
3076
3077`boolean` values
3078
3079## Redact Private Values
3080
3081- Description: Hide the values of variables from visual display in private files
3082- Setting: `redact_private_values`
3083- Default: `false`
3084
3085**Options**
3086
3087`boolean` values
3088
3089## Relative Line Numbers
3090
3091- Description: Whether to show relative line numbers in the gutter
3092- Setting: `relative_line_numbers`
3093- Default: `"disabled"`
3094
3095**Options**
3096
30971. Show relative line numbers in the gutter whilst counting wrapped lines as one line:
3098
3099```json [settings]
3100{
3101  "relative_line_numbers": "enabled"
3102}
3103```
3104
31052. Show relative line numbers in the gutter, including wrapped lines in the counting:
3106
3107```json [settings]
3108{
3109  "relative_line_numbers": "wrapped"
3110}
3111```
3112
31132. Do not use relative line numbers:
3114
3115```json [settings]
3116{
3117  "relative_line_numbers": "disabled"
3118}
3119```
3120
3121## Remove Trailing Whitespace On Save
3122
3123- Description: Whether or not to remove any trailing whitespace from lines of a buffer before saving it.
3124- Setting: `remove_trailing_whitespace_on_save`
3125- Default: `true`
3126
3127**Options**
3128
3129`boolean` values
3130
3131## Resize All Panels In Dock
3132
3133- Description: Whether to resize all the panels in a dock when resizing the dock. Can be a combination of "left", "right" and "bottom".
3134- Setting: `resize_all_panels_in_dock`
3135- Default: `["left"]`
3136
3137**Options**
3138
3139List of strings containing any combination of:
3140
3141- `"left"`: Resize left dock panels together
3142- `"right"`: Resize right dock panels together
3143- `"bottom"`: Resize bottom dock panels together
3144
3145## Restore on File Reopen
3146
3147- Description: Whether to attempt to restore previous file's state when opening it again. The state is stored per pane.
3148- Setting: `restore_on_file_reopen`
3149- Default: `true`
3150
3151**Options**
3152
3153`boolean` values
3154
3155## Restore on Startup
3156
3157- Description: Controls session restoration on startup.
3158- Setting: `restore_on_startup`
3159- Default: `last_session`
3160
3161**Options**
3162
31631. Restore all workspaces that were open when quitting Zed:
3164
3165```json [settings]
3166{
3167  "restore_on_startup": "last_session"
3168}
3169```
3170
31712. Restore the workspace that was closed last:
3172
3173```json [settings]
3174{
3175  "restore_on_startup": "last_workspace"
3176}
3177```
3178
31793. Always start with an empty editor:
3180
3181```json [settings]
3182{
3183  "restore_on_startup": "empty_tab"
3184}
3185```
3186
31874. Always start with the welcome launchpad:
3188
3189```json [settings]
3190{
3191  "restore_on_startup": "launchpad"
3192}
3193```
3194
3195## Scroll Beyond Last Line
3196
3197- Description: Whether the editor will scroll beyond the last line
3198- Setting: `scroll_beyond_last_line`
3199- Default: `"one_page"`
3200
3201**Options**
3202
32031. Scroll one page beyond the last line by one page:
3204
3205```json [settings]
3206{
3207  "scroll_beyond_last_line": "one_page"
3208}
3209```
3210
32112. The editor will scroll beyond the last line by the same amount of lines as `vertical_scroll_margin`:
3212
3213```json [settings]
3214{
3215  "scroll_beyond_last_line": "vertical_scroll_margin"
3216}
3217```
3218
32193. The editor will not scroll beyond the last line:
3220
3221```json [settings]
3222{
3223  "scroll_beyond_last_line": "off"
3224}
3225```
3226
3227**Options**
3228
3229`boolean` values
3230
3231## Scroll Sensitivity
3232
3233- Description: Scroll sensitivity multiplier. This multiplier is applied to both the horizontal and vertical delta values while scrolling.
3234- Setting: `scroll_sensitivity`
3235- Default: `1.0`
3236
3237**Options**
3238
3239Positive `float` values
3240
3241### Fast Scroll Sensitivity
3242
3243- 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.
3244- Setting: `fast_scroll_sensitivity`
3245- Default: `4.0`
3246
3247**Options**
3248
3249Positive `float` values
3250
3251### Horizontal Scroll Margin
3252
3253- Description: The number of characters to keep on either side when scrolling with the mouse
3254- Setting: `horizontal_scroll_margin`
3255- Default: `5`
3256
3257**Options**
3258
3259Non-negative `integer` values
3260
3261### Vertical Scroll Margin
3262
3263- Description: The number of lines to keep above/below the cursor when scrolling with the keyboard
3264- Setting: `vertical_scroll_margin`
3265- Default: `3`
3266
3267**Options**
3268
3269Non-negative `integer` values
3270
3271## Search
3272
3273- Description: Search options to enable by default when opening new project and buffer searches.
3274- Setting: `search`
3275- Default:
3276
3277```json [settings]
3278"search": {
3279  "button": true,
3280  "whole_word": false,
3281  "case_sensitive": false,
3282  "include_ignored": false,
3283  "regex": false,
3284  "center_on_match": false
3285},
3286```
3287
3288### Button
3289
3290- Description: Whether to show the project search button in the status bar.
3291- Setting: `button`
3292- Default: `true`
3293
3294### Whole Word
3295
3296- Description: Whether to only match on whole words.
3297- Setting: `whole_word`
3298- Default: `false`
3299
3300### Case Sensitive
3301
3302- Description: Whether to match case sensitively. This setting affects both
3303  searches and editor actions like "Select Next Occurrence", "Select Previous
3304  Occurrence", and "Select All Occurrences".
3305- Setting: `case_sensitive`
3306- Default: `false`
3307
3308### Include Ignore
3309
3310- Description: Whether to include gitignored files in search results.
3311- Setting: `include_ignored`
3312- Default: `false`
3313
3314### Regex
3315
3316- Description: Whether to interpret the search query as a regular expression.
3317- Setting: `regex`
3318- Default: `false`
3319
3320### Center On Match
3321
3322- Description: Whether to center the cursor on each search match when navigating.
3323- Setting: `center_on_match`
3324- Default: `false`
3325
3326## Search Wrap
3327
3328- Description: If `search_wrap` is disabled, search result do not wrap around the end of the file
3329- Setting: `search_wrap`
3330- Default: `true`
3331
3332## Center on Match
3333
3334- Description: If `center_on_match` is enabled, the editor will center the cursor on the current match when searching.
3335- Setting: `center_on_match`
3336- Default: `false`
3337
3338## Seed Search Query From Cursor
3339
3340- Description: When to populate a new search's query based on the text under the cursor.
3341- Setting: `seed_search_query_from_cursor`
3342- Default: `always`
3343
3344**Options**
3345
33461. `always` always populate the search query with the word under the cursor
33472. `selection` only populate the search query when there is text selected
33483. `never` never populate the search query
3349
3350## Use Smartcase Search
3351
3352- 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. \
3353  This applies to both in-file searches and project-wide searches.
3354- Setting: `use_smartcase_search`
3355- Default: `false`
3356
3357**Options**
3358
3359`boolean` values
3360
3361Examples:
3362
3363- Searching for "function" would match "function", "Function", "FUNCTION", etc.
3364- Searching for "Function" would only match "Function", not "function" or "FUNCTION"
3365
3366## Show Call Status Icon
3367
3368- Description: Whether or not to show the call status icon in the status bar.
3369- Setting: `show_call_status_icon`
3370- Default: `true`
3371
3372**Options**
3373
3374`boolean` values
3375
3376## Completions
3377
3378- Description: Controls how completions are processed for this language.
3379- Setting: `completions`
3380- Default:
3381
3382```json [settings]
3383{
3384  "completions": {
3385    "words": "fallback",
3386    "words_min_length": 3,
3387    "lsp": true,
3388    "lsp_fetch_timeout_ms": 0,
3389    "lsp_insert_mode": "replace_suffix"
3390  }
3391}
3392```
3393
3394### Words
3395
3396- Description: Controls how words are completed. For large documents, not all words may be fetched for completion.
3397- Setting: `words`
3398- Default: `fallback`
3399
3400**Options**
3401
34021. `enabled` - Always fetch document's words for completions along with LSP completions
34032. `fallback` - Only if LSP response errors or times out, use document's words to show completions
34043. `disabled` - Never fetch or complete document's words for completions (word-based completions can still be queried via a separate action)
3405
3406### Min Words Query Length
3407
3408- Description: Minimum number of characters required to automatically trigger word-based completions.
3409  Before that value, it's still possible to trigger the words-based completion manually with the corresponding editor command.
3410- Setting: `words_min_length`
3411- Default: `3`
3412
3413**Options**
3414
3415Positive integer values
3416
3417### LSP
3418
3419- Description: Whether to fetch LSP completions or not.
3420- Setting: `lsp`
3421- Default: `true`
3422
3423**Options**
3424
3425`boolean` values
3426
3427### LSP Fetch Timeout (ms)
3428
3429- Description: When fetching LSP completions, determines how long to wait for a response of a particular server. When set to 0, waits indefinitely.
3430- Setting: `lsp_fetch_timeout_ms`
3431- Default: `0`
3432
3433**Options**
3434
3435`integer` values representing milliseconds
3436
3437### LSP Insert Mode
3438
3439- Description: Controls what range to replace when accepting LSP completions.
3440- Setting: `lsp_insert_mode`
3441- Default: `replace_suffix`
3442
3443**Options**
3444
34451. `insert` - Replaces text before the cursor, using the `insert` range described in the LSP specification
34462. `replace` - Replaces text before and after the cursor, using the `replace` range described in the LSP specification
34473. `replace_subsequence` - Behaves like `"replace"` if the text that would be replaced is a subsequence of the completion text, and like `"insert"` otherwise
34484. `replace_suffix` - Behaves like `"replace"` if the text after the cursor is a suffix of the completion, and like `"insert"` otherwise
3449
3450## Show Completions On Input
3451
3452- Description: Whether or not to show completions as you type.
3453- Setting: `show_completions_on_input`
3454- Default: `true`
3455
3456**Options**
3457
3458`boolean` values
3459
3460## Show Completion Documentation
3461
3462- Description: Whether to display inline and alongside documentation for items in the completions menu.
3463- Setting: `show_completion_documentation`
3464- Default: `true`
3465
3466**Options**
3467
3468`boolean` values
3469
3470## Show Edit Predictions
3471
3472- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowEditPrediction`.
3473- Setting: `show_edit_predictions`
3474- Default: `true`
3475
3476**Options**
3477
3478`boolean` values
3479
3480## Show Whitespaces
3481
3482- Description: Whether or not to render whitespace characters in the editor.
3483- Setting: `show_whitespaces`
3484- Default: `selection`
3485
3486**Options**
3487
34881. `all`
34892. `selection`
34903. `none`
34914. `boundary`
3492
3493## Whitespace Map
3494
3495- Description: Specify the characters used to render whitespace when show_whitespaces is enabled.
3496- Setting: `whitespace_map`
3497- Default:
3498
3499```json [settings]
3500{
3501  "whitespace_map": {
3502    "space": "•",
3503    "tab": "→"
3504  }
3505}
3506```
3507
3508## Soft Wrap
3509
3510- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
3511- Setting: `soft_wrap`
3512- Default: `none`
3513
3514**Options**
3515
35161. `none` to avoid wrapping generally, unless the line is too long
35172. `prefer_line` (deprecated, same as `none`)
35183. `editor_width` to wrap lines that overflow the editor width
35194. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
35205. `bounded` to wrap lines at the minimum of `editor_width` and `preferred_line_length`
3521
3522## Show Wrap Guides
3523
3524- 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.
3525- Setting: `show_wrap_guides`
3526- Default: `true`
3527
3528**Options**
3529
3530`boolean` values
3531
3532## Use On Type Format
3533
3534- Description: Whether to use additional LSP queries to format (and amend) the code after every "trigger" symbol input, defined by LSP server capabilities
3535- Setting: `use_on_type_format`
3536- Default: `true`
3537
3538**Options**
3539
3540`boolean` values
3541
3542## Use Auto Surround
3543
3544- 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 ().
3545- Setting: `use_auto_surround`
3546- Default: `true`
3547
3548**Options**
3549
3550`boolean` values
3551
3552## Use System Path Prompts
3553
3554- 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.
3555- Setting: `use_system_path_prompts`
3556- Default: `true`
3557
3558**Options**
3559
3560`boolean` values
3561
3562## Use System Prompts
3563
3564- 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.
3565- Setting: `use_system_prompts`
3566- Default: `true`
3567
3568**Options**
3569
3570`boolean` values
3571
3572## Wrap Guides (Vertical Rulers)
3573
3574- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
3575- Setting: `wrap_guides`
3576- Default: []
3577
3578**Options**
3579
3580List of `integer` column numbers
3581
3582## Tab Size
3583
3584- Description: The number of spaces to use for each tab character.
3585- Setting: `tab_size`
3586- Default: `4`
3587
3588**Options**
3589
3590`integer` values
3591
3592## Tasks
3593
3594- Description: Configuration for tasks that can be run within Zed
3595- Setting: `tasks`
3596- Default:
3597
3598```json [settings]
3599{
3600  "tasks": {
3601    "variables": {},
3602    "enabled": true,
3603    "prefer_lsp": false
3604  }
3605}
3606```
3607
3608**Options**
3609
3610- `variables`: Custom variables for task configuration
3611- `enabled`: Whether tasks are enabled
3612- `prefer_lsp`: Whether to prefer LSP-provided tasks over Zed language extension ones
3613
3614## Telemetry
3615
3616- Description: Control what info is collected by Zed.
3617- Setting: `telemetry`
3618- Default:
3619
3620```json [settings]
3621"telemetry": {
3622  "diagnostics": true,
3623  "metrics": true
3624},
3625```
3626
3627**Options**
3628
3629### Diagnostics
3630
3631- Description: Setting for sending debug-related data, such as crash reports.
3632- Setting: `diagnostics`
3633- Default: `true`
3634
3635**Options**
3636
3637`boolean` values
3638
3639### Metrics
3640
3641- Description: Setting for sending anonymized usage data, such what languages you're using Zed with.
3642- Setting: `metrics`
3643- Default: `true`
3644
3645**Options**
3646
3647`boolean` values
3648
3649## Terminal
3650
3651- Description: Configuration for the terminal.
3652- Setting: `terminal`
3653- Default:
3654
3655```json [settings]
3656{
3657  "terminal": {
3658    "alternate_scroll": "off",
3659    "blinking": "terminal_controlled",
3660    "copy_on_select": false,
3661    "keep_selection_on_copy": true,
3662    "dock": "bottom",
3663    "default_width": 640,
3664    "default_height": 320,
3665    "detect_venv": {
3666      "on": {
3667        "directories": [".env", "env", ".venv", "venv"],
3668        "activate_script": "default"
3669      }
3670    },
3671    "env": {},
3672    "font_family": null,
3673    "font_features": null,
3674    "font_size": null,
3675    "line_height": "comfortable",
3676    "minimum_contrast": 45,
3677    "option_as_meta": false,
3678    "button": true,
3679    "shell": "system",
3680    "scroll_multiplier": 3.0,
3681    "toolbar": {
3682      "breadcrumbs": false
3683    },
3684    "working_directory": "current_project_directory",
3685    "scrollbar": {
3686      "show": null
3687    }
3688  }
3689}
3690```
3691
3692### Terminal: Dock
3693
3694- Description: Control the position of the dock
3695- Setting: `dock`
3696- Default: `bottom`
3697
3698**Options**
3699
3700`"bottom"`, `"left"` or `"right"`
3701
3702### Terminal: Alternate Scroll
3703
3704- 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.
3705- Setting: `alternate_scroll`
3706- Default: `off`
3707
3708**Options**
3709
37101. Default alternate scroll mode to off
3711
3712```json [settings]
3713{
3714  "terminal": {
3715    "alternate_scroll": "off"
3716  }
3717}
3718```
3719
37202. Default alternate scroll mode to on
3721
3722```json [settings]
3723{
3724  "terminal": {
3725    "alternate_scroll": "on"
3726  }
3727}
3728```
3729
3730### Terminal: Blinking
3731
3732- Description: Set the cursor blinking behavior in the terminal
3733- Setting: `blinking`
3734- Default: `terminal_controlled`
3735
3736**Options**
3737
37381. Never blink the cursor, ignore the terminal mode
3739
3740```json [settings]
3741{
3742  "terminal": {
3743    "blinking": "off"
3744  }
3745}
3746```
3747
37482. Default the cursor blink to off, but allow the terminal to turn blinking on
3749
3750```json [settings]
3751{
3752  "terminal": {
3753    "blinking": "terminal_controlled"
3754  }
3755}
3756```
3757
37583. Always blink the cursor, ignore the terminal mode
3759
3760```json [settings]
3761{
3762  "terminal": {
3763    "blinking": "on"
3764  }
3765}
3766```
3767
3768### Terminal: Copy On Select
3769
3770- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
3771- Setting: `copy_on_select`
3772- Default: `false`
3773
3774**Options**
3775
3776`boolean` values
3777
3778**Example**
3779
3780```json [settings]
3781{
3782  "terminal": {
3783    "copy_on_select": true
3784  }
3785}
3786```
3787
3788### Terminal: Cursor Shape
3789
3790- Description: Controls the visual shape of the cursor in the terminal. When not explicitly set, it defaults to a block shape.
3791- Setting: `cursor_shape`
3792- Default: `null` (defaults to block)
3793
3794**Options**
3795
37961. A block that surrounds the following character
3797
3798```json [settings]
3799{
3800  "terminal": {
3801    "cursor_shape": "block"
3802  }
3803}
3804```
3805
38062. A vertical bar
3807
3808```json [settings]
3809{
3810  "terminal": {
3811    "cursor_shape": "bar"
3812  }
3813}
3814```
3815
38163. An underline / underscore that runs along the following character
3817
3818```json [settings]
3819{
3820  "terminal": {
3821    "cursor_shape": "underline"
3822  }
3823}
3824```
3825
38264. A box drawn around the following character
3827
3828```json [settings]
3829{
3830  "terminal": {
3831    "cursor_shape": "hollow"
3832  }
3833}
3834```
3835
3836### Terminal: Keep Selection On Copy
3837
3838- Description: Whether or not to keep the selection in the terminal after copying text.
3839- Setting: `keep_selection_on_copy`
3840- Default: `true`
3841
3842**Options**
3843
3844`boolean` values
3845
3846**Example**
3847
3848```json [settings]
3849{
3850  "terminal": {
3851    "keep_selection_on_copy": false
3852  }
3853}
3854```
3855
3856### Terminal: Env
3857
3858- 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
3859- Setting: `env`
3860- Default: `{}`
3861
3862**Example**
3863
3864```json [settings]
3865{
3866  "terminal": {
3867    "env": {
3868      "ZED": "1",
3869      "KEY": "value1:value2"
3870    }
3871  }
3872}
3873```
3874
3875### Terminal: Font Size
3876
3877- Description: What font size to use for the terminal. When not set defaults to matching the editor's font size
3878- Setting: `font_size`
3879- Default: `null`
3880
3881**Options**
3882
3883`integer` values
3884
3885```json [settings]
3886{
3887  "terminal": {
3888    "font_size": 15
3889  }
3890}
3891```
3892
3893### Terminal: Font Family
3894
3895- Description: What font to use for the terminal. When not set, defaults to matching the editor's font.
3896- Setting: `font_family`
3897- Default: `null`
3898
3899**Options**
3900
3901The name of any font family installed on the user's system
3902
3903```json [settings]
3904{
3905  "terminal": {
3906    "font_family": "Berkeley Mono"
3907  }
3908}
3909```
3910
3911### Terminal: Font Features
3912
3913- Description: What font features to use for the terminal. When not set, defaults to matching the editor's font features.
3914- Setting: `font_features`
3915- Default: `null`
3916- Platform: macOS and Windows.
3917
3918**Options**
3919
3920See Buffer Font Features
3921
3922```json [settings]
3923{
3924  "terminal": {
3925    "font_features": {
3926      "calt": false
3927      // See Buffer Font Features for more features
3928    }
3929  }
3930}
3931```
3932
3933### Terminal: Line Height
3934
3935- Description: Set the terminal's line height.
3936- Setting: `line_height`
3937- Default: `standard`
3938
3939**Options**
3940
39411. Use a line height that's `comfortable` for reading, 1.618.
3942
3943```json [settings]
3944{
3945  "terminal": {
3946    "line_height": "comfortable"
3947  }
3948}
3949```
3950
39512. Use a `standard` line height, 1.3. This option is useful for TUIs, particularly if they use box characters. (default)
3952
3953```json [settings]
3954{
3955  "terminal": {
3956    "line_height": "standard"
3957  }
3958}
3959```
3960
39613.  Use a custom line height.
3962
3963```json [settings]
3964{
3965  "terminal": {
3966    "line_height": {
3967      "custom": 2
3968    }
3969  }
3970}
3971```
3972
3973### Terminal: Minimum Contrast
3974
3975- 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.
3976- Setting: `minimum_contrast`
3977- Default: `45`
3978
3979**Options**
3980
3981`integer` values from 0 to 106. Common recommended values:
3982
3983- `0`: No contrast adjustment
3984- `45`: Minimum for large fluent text (default)
3985- `60`: Minimum for other content text
3986- `75`: Minimum for body text
3987- `90`: Preferred for body text
3988
3989```json [settings]
3990{
3991  "terminal": {
3992    "minimum_contrast": 45
3993  }
3994}
3995```
3996
3997### Terminal: Option As Meta
3998
3999- Description: Re-interprets the option keys to act like a 'meta' key, like in Emacs.
4000- Setting: `option_as_meta`
4001- Default: `false`
4002
4003**Options**
4004
4005`boolean` values
4006
4007```json [settings]
4008{
4009  "terminal": {
4010    "option_as_meta": true
4011  }
4012}
4013```
4014
4015### Terminal: Shell
4016
4017- Description: What shell to use when launching the terminal.
4018- Setting: `shell`
4019- Default: `system`
4020
4021**Options**
4022
40231. Use the system's default terminal configuration (usually the `/etc/passwd` file).
4024
4025```json [settings]
4026{
4027  "terminal": {
4028    "shell": "system"
4029  }
4030}
4031```
4032
40332. A program to launch:
4034
4035```json [settings]
4036{
4037  "terminal": {
4038    "shell": {
4039      "program": "sh"
4040    }
4041  }
4042}
4043```
4044
40453. A program with arguments:
4046
4047```json [settings]
4048{
4049  "terminal": {
4050    "shell": {
4051      "with_arguments": {
4052        "program": "/bin/bash",
4053        "args": ["--login"]
4054      }
4055    }
4056  }
4057}
4058```
4059
4060## Terminal: Detect Virtual Environments {#terminal-detect_venv}
4061
4062- 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.
4063- Setting: `detect_venv`
4064- Default:
4065
4066```json [settings]
4067{
4068  "terminal": {
4069    "detect_venv": {
4070      "on": {
4071        // Default directories to search for virtual environments, relative
4072        // to the current working directory. We recommend overriding this
4073        // in your project's settings, rather than globally.
4074        "directories": [".env", "env", ".venv", "venv"],
4075        // Can also be `csh`, `fish`, and `nushell`
4076        "activate_script": "default"
4077      }
4078    }
4079  }
4080}
4081```
4082
4083Disable with:
4084
4085```json [settings]
4086{
4087  "terminal": {
4088    "detect_venv": "off"
4089  }
4090}
4091```
4092
4093### Terminal: Scroll Multiplier
4094
4095- Description: The multiplier for scrolling speed in the terminal when using mouse wheel or trackpad.
4096- Setting: `scroll_multiplier`
4097- Default: `1.0`
4098
4099**Options**
4100
4101Positive floating point values. Values less than or equal to 0 will be clamped to a minimum of 0.01.
4102
4103**Example**
4104
4105```json
4106{
4107  "terminal": {
4108    "scroll_multiplier": 5.0
4109  }
4110}
4111```
4112
4113## Terminal: Toolbar
4114
4115- Description: Whether or not to show various elements in the terminal toolbar.
4116- Setting: `toolbar`
4117- Default:
4118
4119```json [settings]
4120{
4121  "terminal": {
4122    "toolbar": {
4123      "breadcrumbs": false
4124    }
4125  }
4126}
4127```
4128
4129**Options**
4130
4131At the moment, only the `breadcrumbs` option is available, it controls displaying of the terminal title that can be changed via `PROMPT_COMMAND`.
4132
4133If the terminal title is empty, the breadcrumbs won't be shown.
4134
4135The shell running in the terminal needs to be configured to emit the title.
4136
4137Example command to set the title: `echo -e "\e]2;New Title\007";`
4138
4139### Terminal: Button
4140
4141- Description: Control to show or hide the terminal button in the status bar
4142- Setting: `button`
4143- Default: `true`
4144
4145**Options**
4146
4147`boolean` values
4148
4149```json [settings]
4150{
4151  "terminal": {
4152    "button": false
4153  }
4154}
4155```
4156
4157### Terminal: Working Directory
4158
4159- Description: What working directory to use when launching the terminal.
4160- Setting: `working_directory`
4161- Default: `"current_project_directory"`
4162
4163**Options**
4164
41651. Use the current file's project directory. Fallback to the first project directory strategy if unsuccessful.
4166
4167```json [settings]
4168{
4169  "terminal": {
4170    "working_directory": "current_project_directory"
4171  }
4172}
4173```
4174
41752. Use the first project in this workspace's directory. Fallback to using this platform's home directory.
4176
4177```json [settings]
4178{
4179  "terminal": {
4180    "working_directory": "first_project_directory"
4181  }
4182}
4183```
4184
41853. Always use this platform's home directory if it can be found.
4186
4187```json [settings]
4188{
4189  "terminal": {
4190    "working_directory": "always_home"
4191  }
4192}
4193```
4194
41954. 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.
4196
4197```json [settings]
4198{
4199  "terminal": {
4200    "working_directory": {
4201      "always": {
4202        "directory": "~/zed/projects/"
4203      }
4204    }
4205  }
4206}
4207```
4208
4209### Terminal: Path Hyperlink Regexes
4210
4211- 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).
4212- Setting: `path_hyperlink_regexes`
4213- Default:
4214
4215```json [settings]
4216{
4217  "terminal": {
4218    "path_hyperlink_regexes": [
4219      // Python-style diagnostics
4220      "File \"(?<path>[^\"]+)\", line (?<line>[0-9]+)",
4221      // Common path syntax with optional line, column, description, trailing punctuation, or
4222      // surrounding symbols or quotes
4223      [
4224        "(?x)",
4225        "# optionally starts with 0-2 opening prefix symbols",
4226        "[({\\[<]{0,2}",
4227        "# which may be followed by an opening quote",
4228        "(?<quote>[\"'`])?",
4229        "# `path` is the shortest sequence of any non-space character",
4230        "(?<link>(?<path>[^ ]+?",
4231        "    # which may end with a line and optionally a column,",
4232        "    (?<line_column>:+[0-9]+(:[0-9]+)?|:?\\([0-9]+([,:][0-9]+)?\\))?",
4233        "))",
4234        "# which must be followed by a matching quote",
4235        "(?(<quote>)\\k<quote>)",
4236        "# and optionally a single closing symbol",
4237        "[)}\\]>]?",
4238        "# if line/column matched, may be followed by a description",
4239        "(?(<line_column>):[^ 0-9][^ ]*)?",
4240        "# which may be followed by trailing punctuation",
4241        "[.,:)}\\]>]*",
4242        "# and always includes trailing whitespace or end of line",
4243        "([ ]+|$)"
4244      ]
4245    ]
4246  }
4247}
4248```
4249
4250### Terminal: Path Hyperlink Timeout (ms)
4251
4252- Description: Maximum time to search for a path hyperlink. When set to 0, path hyperlinks are disabled.
4253- Setting: `path_hyperlink_timeout_ms`
4254- Default: `1`
4255
4256## REPL
4257
4258- Description: Repl settings.
4259- Setting: `repl`
4260- Default:
4261
4262```json [settings]
4263"repl": {
4264  // Maximum number of columns to keep in REPL's scrollback buffer.
4265  // Clamped with [20, 512] range.
4266  "max_columns": 128,
4267  // Maximum number of lines to keep in REPL's scrollback buffer.
4268  // Clamped with [4, 256] range.
4269  "max_lines": 32
4270},
4271```
4272
4273## Theme
4274
4275- 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.
4276- Setting: `theme`
4277- Default: `One Dark`
4278
4279### Theme Object
4280
4281- Description: Specify the theme using an object that includes the `mode`, `dark`, and `light` themes.
4282- Setting: `theme`
4283- Default:
4284
4285```json [settings]
4286"theme": {
4287  "mode": "system",
4288  "dark": "One Dark",
4289  "light": "One Light"
4290},
4291```
4292
4293### Mode
4294
4295- Description: Specify theme mode.
4296- Setting: `mode`
4297- Default: `system`
4298
4299**Options**
4300
43011. Set the theme to dark mode
4302
4303```json [settings]
4304{
4305  "mode": "dark"
4306}
4307```
4308
43092. Set the theme to light mode
4310
4311```json [settings]
4312{
4313  "mode": "light"
4314}
4315```
4316
43173. Set the theme to system mode
4318
4319```json [settings]
4320{
4321  "mode": "system"
4322}
4323```
4324
4325### Dark
4326
4327- Description: The name of the dark Zed theme to use for the UI.
4328- Setting: `dark`
4329- Default: `One Dark`
4330
4331**Options**
4332
4333Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4334
4335### Light
4336
4337- Description: The name of the light Zed theme to use for the UI.
4338- Setting: `light`
4339- Default: `One Light`
4340
4341**Options**
4342
4343Run the {#action theme_selector::Toggle} action in the command palette to see a current list of valid themes names.
4344
4345## Title Bar
4346
4347- Description: Whether or not to show various elements in the title bar
4348- Setting: `title_bar`
4349- Default:
4350
4351```json [settings]
4352"title_bar": {
4353  "show_branch_icon": false,
4354  "show_branch_name": true,
4355  "show_project_items": true,
4356  "show_onboarding_banner": true,
4357  "show_user_picture": true,
4358  "show_user_menu": true,
4359  "show_sign_in": true,
4360  "show_menus": false
4361}
4362```
4363
4364**Options**
4365
4366- `show_branch_icon`: Whether to show the branch icon beside branch switcher in the titlebar
4367- `show_branch_name`: Whether to show the branch name button in the titlebar
4368- `show_project_items`: Whether to show the project host and name in the titlebar
4369- `show_onboarding_banner`: Whether to show onboarding banners in the titlebar
4370- `show_user_picture`: Whether to show user picture in the titlebar
4371- `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.)
4372- `show_sign_in`: Whether to show the sign in button in the titlebar
4373- `show_menus`: Whether to show the menus in the titlebar
4374
4375## Vim
4376
4377- Description: Whether or not to enable vim mode.
4378- Setting: `vim_mode`
4379- Default: `false`
4380
4381## When Closing With No Tabs
4382
4383- Description: Whether the window should be closed when using 'close active item' on a window with no tabs
4384- Setting: `when_closing_with_no_tabs`
4385- Default: `"platform_default"`
4386
4387**Options**
4388
43891. Use platform default behavior:
4390
4391```json [settings]
4392{
4393  "when_closing_with_no_tabs": "platform_default"
4394}
4395```
4396
43972. Always close the window:
4398
4399```json [settings]
4400{
4401  "when_closing_with_no_tabs": "close_window"
4402}
4403```
4404
44053. Never close the window:
4406
4407```json [settings]
4408{
4409  "when_closing_with_no_tabs": "keep_window_open"
4410}
4411```
4412
4413## Project Panel
4414
4415- Description: Customize project panel
4416- Setting: `project_panel`
4417- Default:
4418
4419```json [settings]
4420{
4421  "project_panel": {
4422    "button": true,
4423    "default_width": 240,
4424    "dock": "left",
4425    "entry_spacing": "comfortable",
4426    "file_icons": true,
4427    "folder_icons": true,
4428    "git_status": true,
4429    "indent_size": 20,
4430    "auto_reveal_entries": true,
4431    "auto_fold_dirs": true,
4432    "drag_and_drop": true,
4433    "scrollbar": {
4434      "show": null
4435    },
4436    "sticky_scroll": true,
4437    "show_diagnostics": "all",
4438    "indent_guides": {
4439      "show": "always"
4440    },
4441    "sort_mode": "directories_first",
4442    "hide_root": false,
4443    "hide_hidden": false,
4444    "starts_open": true,
4445    "auto_open": {
4446      "on_create": true,
4447      "on_paste": true,
4448      "on_drop": true
4449    }
4450  }
4451}
4452```
4453
4454### Dock
4455
4456- Description: Control the position of the dock
4457- Setting: `dock`
4458- Default: `left`
4459
4460**Options**
4461
44621. Default dock position to left
4463
4464```json [settings]
4465{
4466  "dock": "left"
4467}
4468```
4469
44702. Default dock position to right
4471
4472```json [settings]
4473{
4474  "dock": "right"
4475}
4476```
4477
4478### Entry Spacing
4479
4480- Description: Spacing between worktree entries
4481- Setting: `entry_spacing`
4482- Default: `comfortable`
4483
4484**Options**
4485
44861. Comfortable entry spacing
4487
4488```json [settings]
4489{
4490  "entry_spacing": "comfortable"
4491}
4492```
4493
44942. Standard entry spacing
4495
4496```json [settings]
4497{
4498  "entry_spacing": "standard"
4499}
4500```
4501
4502### Git Status
4503
4504- Description: Indicates newly created and updated files
4505- Setting: `git_status`
4506- Default: `true`
4507
4508**Options**
4509
45101. Default enable git status
4511
4512```json [settings]
4513{
4514  "git_status": true
4515}
4516```
4517
45182. Default disable git status
4519
4520```json [settings]
4521{
4522  "git_status": false
4523}
4524```
4525
4526### Default Width
4527
4528- Description: Customize default width taken by project panel
4529- Setting: `default_width`
4530- Default: `240`
4531
4532**Options**
4533
4534`float` values
4535
4536### Auto Reveal Entries
4537
4538- Description: Whether to reveal it in the project panel automatically, when a corresponding project entry becomes active. Gitignored entries are never auto revealed.
4539- Setting: `auto_reveal_entries`
4540- Default: `true`
4541
4542**Options**
4543
45441. Enable auto reveal entries
4545
4546```json [settings]
4547{
4548  "auto_reveal_entries": true
4549}
4550```
4551
45522. Disable auto reveal entries
4553
4554```json [settings]
4555{
4556  "auto_reveal_entries": false
4557}
4558```
4559
4560### Auto Fold Dirs
4561
4562- Description: Whether to fold directories automatically when directory has only one directory inside.
4563- Setting: `auto_fold_dirs`
4564- Default: `true`
4565
4566**Options**
4567
45681. Enable auto fold dirs
4569
4570```json [settings]
4571{
4572  "auto_fold_dirs": true
4573}
4574```
4575
45762. Disable auto fold dirs
4577
4578```json [settings]
4579{
4580  "auto_fold_dirs": false
4581}
4582```
4583
4584### Indent Size
4585
4586- Description: Amount of indentation (in pixels) for nested items.
4587- Setting: `indent_size`
4588- Default: `20`
4589
4590### Indent Guides: Show
4591
4592- Description: Whether to show indent guides in the project panel.
4593- Setting: `indent_guides`
4594- Default:
4595
4596```json [settings]
4597"indent_guides": {
4598  "show": "always"
4599}
4600```
4601
4602**Options**
4603
46041. Show indent guides in the project panel
4605
4606```json [settings]
4607{
4608  "indent_guides": {
4609    "show": "always"
4610  }
4611}
4612```
4613
46142. Hide indent guides in the project panel
4615
4616```json [settings]
4617{
4618  "indent_guides": {
4619    "show": "never"
4620  }
4621}
4622```
4623
4624### Scrollbar: Show
4625
4626- 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.
4627- Setting: `scrollbar`
4628- Default:
4629
4630```json [settings]
4631"scrollbar": {
4632  "show": null
4633}
4634```
4635
4636**Options**
4637
46381. Show scrollbar in the project panel
4639
4640```json [settings]
4641{
4642  "scrollbar": {
4643    "show": "always"
4644  }
4645}
4646```
4647
46482. Hide scrollbar in the project panel
4649
4650```json [settings]
4651{
4652  "scrollbar": {
4653    "show": "never"
4654  }
4655}
4656```
4657
4658### Sort Mode
4659
4660- Description: Sort order for entries in the project panel
4661- Setting: `sort_mode`
4662- Default: `directories_first`
4663
4664**Options**
4665
46661. Show directories first, then files
4667
4668```json [settings]
4669{
4670  "sort_mode": "directories_first"
4671}
4672```
4673
46742. Mix directories and files together
4675
4676```json [settings]
4677{
4678  "sort_mode": "mixed"
4679}
4680```
4681
46823. Show files first, then directories
4683
4684```json [settings]
4685{
4686  "sort_mode": "files_first"
4687}
4688```
4689
4690### Auto Open
4691
4692- Description: Control whether files are opened automatically after different creation flows in the project panel.
4693- Setting: `auto_open`
4694- Default:
4695
4696```json [settings]
4697"auto_open": {
4698  "on_create": true,
4699  "on_paste": true,
4700  "on_drop": true
4701}
4702```
4703
4704**Options**
4705
4706- `on_create`: Whether to automatically open newly created files in the editor.
4707- `on_paste`: Whether to automatically open files after pasting or duplicating them.
4708- `on_drop`: Whether to automatically open files dropped from external sources.
4709
4710## Agent
4711
4712Visit [the Configuration page](./ai/configuration.md) under the AI section to learn more about all the agent-related settings.
4713
4714## Collaboration Panel
4715
4716- Description: Customizations for the collaboration panel.
4717- Setting: `collaboration_panel`
4718- Default:
4719
4720```json [settings]
4721{
4722  "collaboration_panel": {
4723    "button": true,
4724    "dock": "left",
4725    "default_width": 240
4726  }
4727}
4728```
4729
4730**Options**
4731
4732- `button`: Whether to show the collaboration panel button in the status bar
4733- `dock`: Where to dock the collaboration panel. Can be `left` or `right`
4734- `default_width`: Default width of the collaboration panel
4735
4736## Debugger
4737
4738- Description: Configuration for debugger panel and settings
4739- Setting: `debugger`
4740- Default:
4741
4742```json [settings]
4743{
4744  "debugger": {
4745    "stepping_granularity": "line",
4746    "save_breakpoints": true,
4747    "dock": "bottom",
4748    "button": true
4749  }
4750}
4751```
4752
4753See the [debugger page](./debugger.md) for more information about debugging support within Zed.
4754
4755## Git Panel
4756
4757- Description: Setting to customize the behavior of the git panel.
4758- Setting: `git_panel`
4759- Default:
4760
4761```json [settings]
4762{
4763  "git_panel": {
4764    "button": true,
4765    "dock": "left",
4766    "default_width": 360,
4767    "status_style": "icon",
4768    "fallback_branch_name": "main",
4769    "sort_by_path": false,
4770    "collapse_untracked_diff": false,
4771    "scrollbar": {
4772      "show": null
4773    }
4774  }
4775}
4776```
4777
4778**Options**
4779
4780- `button`: Whether to show the git panel button in the status bar
4781- `dock`: Where to dock the git panel. Can be `left` or `right`
4782- `default_width`: Default width of the git panel
4783- `status_style`: How to display git status. Can be `label_color` or `icon`
4784- `fallback_branch_name`: What branch name to use if `init.defaultBranch` is not set
4785- `sort_by_path`: Whether to sort entries in the panel by path or by status (the default)
4786- `collapse_untracked_diff`: Whether to collapse untracked files in the diff panel
4787- `scrollbar`: When to show the scrollbar in the git panel
4788
4789## Git Hosting Providers
4790
4791- Description: Register self-hosted GitHub, GitLab, or Bitbucket instances so commit hashes, issue references, and permalinks resolve to the right host.
4792- Setting: `git_hosting_providers`
4793- Default: `[]`
4794
4795**Options**
4796
4797Each entry accepts:
4798
4799- `provider`: One of `github`, `gitlab`, or `bitbucket`
4800- `name`: Display name for the instance
4801- `base_url`: Base URL, e.g. `https://git.example.corp`
4802
4803You can define these in user or project settings; project settings are merged on top of user settings.
4804
4805```json [settings]
4806{
4807  "git_hosting_providers": [
4808    {
4809      "provider": "github",
4810      "name": "BigCorp GitHub",
4811      "base_url": "https://git.example.corp"
4812    }
4813  ]
4814}
4815```
4816
4817## Outline Panel
4818
4819- Description: Customize outline Panel
4820- Setting: `outline_panel`
4821- Default:
4822
4823```json [settings]
4824"outline_panel": {
4825  "button": true,
4826  "default_width": 300,
4827  "dock": "left",
4828  "file_icons": true,
4829  "folder_icons": true,
4830  "git_status": true,
4831  "indent_size": 20,
4832  "auto_reveal_entries": true,
4833  "auto_fold_dirs": true,
4834  "indent_guides": {
4835    "show": "always"
4836  },
4837  "scrollbar": {
4838    "show": null
4839  }
4840}
4841```
4842
4843## Calls
4844
4845- Description: Customize behavior when participating in a call
4846- Setting: `calls`
4847- Default:
4848
4849```json [settings]
4850"calls": {
4851  // Join calls with the microphone live by default
4852  "mute_on_join": false,
4853  // Share your project when you are the first to join a channel
4854  "share_on_join": false
4855},
4856```
4857
4858## Colorize Brackets
4859
4860- Description: Whether to use tree-sitter bracket queries to detect and colorize the brackets in the editor (also known as "rainbow brackets").
4861- Setting: `colorize_brackets`
4862- Default: `false`
4863
4864**Options**
4865
4866`boolean` values
4867
4868The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides.
4869
4870## Unnecessary Code Fade
4871
4872- Description: How much to fade out unused code.
4873- Setting: `unnecessary_code_fade`
4874- Default: `0.3`
4875
4876**Options**
4877
4878Float values between `0.0` and `0.9`, where:
4879
4880- `0.0` means no fading (unused code looks the same as used code)
4881- `0.9` means maximum fading (unused code is very faint but still visible)
4882
4883**Example**
4884
4885```json [settings]
4886{
4887  "unnecessary_code_fade": 0.5
4888}
4889```
4890
4891## UI Font Family
4892
4893- Description: The name of the font to use for text in the UI.
4894- Setting: `ui_font_family`
4895- Default: `.ZedSans`. This currently aliases to [IBM Plex](https://www.ibm.com/plex/).
4896
4897**Options**
4898
4899The 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).
4900
4901## UI Font Features
4902
4903- Description: The OpenType features to enable for text in the UI.
4904- Setting: `ui_font_features`
4905- Default:
4906
4907```json [settings]
4908"ui_font_features": {
4909  "calt": false
4910}
4911```
4912
4913- Platform: macOS and Windows.
4914
4915**Options**
4916
4917Zed supports all OpenType features that can be enabled or disabled for a given UI font, as well as setting values for font features.
4918
4919For example, to disable font ligatures, add the following to your settings:
4920
4921```json [settings]
4922{
4923  "ui_font_features": {
4924    "calt": false
4925  }
4926}
4927```
4928
4929You can also set other OpenType features, like setting `cv01` to `7`:
4930
4931```json [settings]
4932{
4933  "ui_font_features": {
4934    "cv01": 7
4935  }
4936}
4937```
4938
4939## UI Font Fallbacks
4940
4941- Description: The font fallbacks to use for text in the UI.
4942- Setting: `ui_font_fallbacks`
4943- Default: `null`
4944- Platform: macOS and Windows.
4945
4946**Options**
4947
4948For example, to use `Nerd Font` as a fallback, add the following to your settings:
4949
4950```json [settings]
4951{
4952  "ui_font_fallbacks": ["Nerd Font"]
4953}
4954```
4955
4956## UI Font Size
4957
4958- Description: The default font size for text in the UI.
4959- Setting: `ui_font_size`
4960- Default: `16`
4961
4962**Options**
4963
4964`integer` values from `6` to `100` pixels (inclusive)
4965
4966## UI Font Weight
4967
4968- Description: The default font weight for text in the UI.
4969- Setting: `ui_font_weight`
4970- Default: `400`
4971
4972**Options**
4973
4974`integer` values between `100` and `900`
4975
4976## Settings Profiles
4977
4978- 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`.
4979- Setting: `profiles`
4980- Default: `{}`
4981
4982In your `settings.json` file, add the `profiles` object.
4983Each 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.
4984
4985Example:
4986
4987```json [settings]
4988"profiles": {
4989  "Presenting (Dark)": {
4990    "agent_buffer_font_size": 18.0,
4991    "buffer_font_size": 18.0,
4992    "theme": "One Dark",
4993    "ui_font_size": 18.0
4994  },
4995  "Presenting (Light)": {
4996    "agent_buffer_font_size": 18.0,
4997    "buffer_font_size": 18.0,
4998    "theme": "One Light",
4999    "ui_font_size": 18.0
5000  },
5001  "Writing": {
5002    "agent_buffer_font_size": 15.0,
5003    "buffer_font_size": 15.0,
5004    "theme": "Catppuccin Frappé - No Italics",
5005    "ui_font_size": 15.0,
5006    "tab_bar": { "show": false },
5007    "toolbar": { "breadcrumbs": false }
5008  }
5009}
5010```
5011
5012To preview and enable a settings profile, open the command palette via {#kb command_palette::Toggle} and search for `settings profile selector: toggle`.
5013
5014## An example configuration:
5015
5016```json [settings]
5017// ~/.config/zed/settings.json
5018{
5019  "theme": "cave-light",
5020  "tab_size": 2,
5021  "preferred_line_length": 80,
5022  "soft_wrap": "none",
5023
5024  "buffer_font_size": 18,
5025  "buffer_font_family": ".ZedMono",
5026
5027  "autosave": "on_focus_change",
5028  "format_on_save": "off",
5029  "vim_mode": false,
5030  "projects_online_by_default": true,
5031  "terminal": {
5032    "font_family": "FiraCode Nerd Font Mono",
5033    "blinking": "off"
5034  },
5035  "languages": {
5036    "C": {
5037      "format_on_save": "on",
5038      "formatter": "language_server",
5039      "preferred_line_length": 64,
5040      "soft_wrap": "preferred_line_length"
5041    }
5042  }
5043}
5044```