Skip to repository content

tenant.openagents/omega

No repository description is available.

OpenAgents Git authority 2026-07-28T00:34:04.031Z Public web read
NIP-34 coordinate30617:7649603503856e5148d571eac2766b288a8ff1e9e35d380337a1d2b0015b4f92:omega
MaintainersHidden in public view
References2 branches · 1 tag
Read-only clonegit clone https://openagents.com/git/tenant.openagents/omega.git
Browse files

docs/.doc-examples/configuration.md

5.1 KB
<!-- GOLD STANDARD EXAMPLE: Configuration Documentation This example demonstrates documentation for settings and configuration. Key patterns to note: - Anchor IDs on all major sections - Opening paragraph explains what this guide covers - Multiple JSON examples with [settings] annotation - Platform-specific file paths - Proper callout formatting - "See Also" section at the end (not "What's Next") -->

title: Configuring Zed - Settings and Preferences description: Configure Zed with the Settings Editor, JSON files, and project-specific overrides. Covers all settings options.


Configuring Zed

This guide explains how Zed's settings system works, including the Settings Editor, JSON configuration files, and project-specific settings.

For visual customization (themes, fonts, icons), see Appearance.

Settings Editor {#settings-editor}

The Settings Editor ({#kb omega::OpenSettings}) is the primary way to configure Zed. It provides a searchable interface where you can browse available settings, see their current values, and make changes.

To open it:

  • Press {#kb omega::OpenSettings}
  • Or run {#action omega::OpenSettings} from the command palette

As you type in the search box, matching settings appear with descriptions and controls to modify them. Changes save automatically to your settings file.

Note: Not all settings are available in the Settings Editor yet. Some advanced options, like language formatters, require editing the JSON file directly.

Settings Files {#settings-files}

User Settings {#user-settings}

Your user settings apply globally across all projects. Open the file with {#kb omega::OpenSettingsFile} or run {#action omega::OpenSettingsFile} from the command palette.

The file is located at:

  • macOS: ~/.config/zed/settings.json
  • Linux: ~/.config/zed/settings.json (or $XDG_CONFIG_HOME/zed/settings.json)
  • Windows: %APPDATA%\Zed\settings.json

The syntax is JSON with support for // comments.

Default Settings {#default-settings}

To see all available settings with their default values, run {#action omega::OpenDefaultSettings} from the command palette. This opens a read-only reference you can use when editing your own settings.

Project Settings {#project-settings}

Override user settings for a specific project by creating a .zed/settings.json file in your project root. Run {#action omega::OpenProjectSettings} to create this file.

Project settings take precedence over user settings for that project only.

// .zed/settings.json
{
  "tab_size": 2,
  "formatter": "prettier",
  "format_on_save": "on"
}

You can also add settings files in subdirectories for more granular control.

Note: Not all settings can be set at the project level. Settings that affect the editor globally (like theme or vim_mode) only work in user settings. Project settings are limited to editor behavior and language tooling options like tab_size, formatter, and format_on_save.

How Settings Merge {#how-settings-merge}

Settings are applied in layers:

  1. Default settings — Zed's built-in defaults
  2. User settings — Your global preferences
  3. Project settings — Project-specific overrides

Later layers override earlier ones. For object settings (like terminal), properties merge rather than replace entirely.

Per-Release Channel Overrides {#release-channel-overrides}

Use different settings for Stable, Preview, or Nightly builds by adding top-level channel keys:

{
  "theme": "One Dark",
  "vim_mode": false,
  "nightly": {
    "theme": "Rosé Pine",
    "vim_mode": true
  },
  "preview": {
    "theme": "Catppuccin Mocha"
  }
}

With this configuration:

  • Stable uses One Dark with vim mode off
  • Preview uses Catppuccin Mocha with vim mode off
  • Nightly uses Rosé Pine with vim mode on

Changes made in the Settings Editor apply across all channels.

Settings Deep Links {#deep-links}

Zed supports deep links that open specific settings directly:

zed://settings/theme
zed://settings/vim_mode
zed://settings/buffer_font_size

These are useful for sharing configuration tips or linking from documentation.

Example Configuration {#example-configuration}

{
  "theme": {
    "mode": "system",
    "light": "One Light",
    "dark": "One Dark"
  },
  "buffer_font_family": "JetBrains Mono",
  "buffer_font_size": 14,
  "tab_size": 2,
  "format_on_save": "on",
  "autosave": "on_focus_change",
  "vim_mode": false,
  "terminal": {
    "font_family": "JetBrains Mono",
    "font_size": 14
  },
  "languages": {
    "Python": {
      "tab_size": 4
    }
  }
}

See Also {#see-also}

Served at tenant.openagents/omega Member data and write actions are omitted.