Zed

https://zed.dev/docs/
Admin
Zed is a powerful multiplayer code editor designed for collaborative development with built-in AI...
Tokens:372,434
Snippets:4,661
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Scala with Coursier (cs setup)

Source: https://zed.dev/docs/languages/scala

Install Scala using the Coursier command-line tool. Run `cs setup` after installing Coursier via Homebrew.

```bash
brew install coursier/formulas/coursier && cs setup
```

--------------------------------

### Install local build

Source: https://zed.dev/docs/development/linux

Installs a local build on your machine. This builds zed and the cli in release mode, installs the binary at ~/.local/bin/zed, and installs .desktop files to ~/.local/share.

```bash
./script/install-linux
```

--------------------------------

### Visual Studio components for Build Tools only setup

Source: https://zed.dev/docs/development/windows

Required Visual Studio components when using only the Build Tools. Ensure these are installed to compile Zed. Export via Visual Studio Installer > More > Export configuration.

```json
{
  "version": "1.0",
  "components": [
    "Microsoft.VisualStudio.Component.Roslyn.Compiler",
    "Microsoft.Component.MSBuild",
    "Microsoft.VisualStudio.Component.CoreBuildTools",
    "Microsoft.VisualStudio.Workload.MSBuildTools",
    "Microsoft.VisualStudio.Component.Windows10SDK",
    "Microsoft.VisualStudio.Component.VC.CoreBuildTools",
    "Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
    "Microsoft.VisualStudio.Component.VC.Redist.14.Latest",
    "Microsoft.VisualStudio.Component.Windows11SDK.26100",
    "Microsoft.VisualStudio.Component.VC.CMake.Project",
    "Microsoft.VisualStudio.Component.TextTemplating",
    "Microsoft.VisualStudio.Component.VC.CoreIde",
    "Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
    "Microsoft.VisualStudio.Workload.VCTools",
    "Microsoft.VisualStudio.Component.VC.Runtimes.x86.x64.Spectre"
  ],
  "extensions": []
}
```

--------------------------------

### Visual Studio components for full IDE setup

Source: https://zed.dev/docs/development/windows

Required Visual Studio components when using the full IDE. Ensure these are installed to compile Zed. Export via Visual Studio Installer > More > Export configuration.

```json
{
  "version": "1.0",
  "components": [
    "Microsoft.VisualStudio.Component.CoreEditor",
    "Microsoft.VisualStudio.Workload.CoreEditor",
    "Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
    "Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions.CMake",
    "Microsoft.VisualStudio.Component.VC.CMake.Project",
    "Microsoft.VisualStudio.Component.Windows11SDK.26100",
    "Microsoft.VisualStudio.Component.VC.Runtimes.x86.x64.Spectre"
  ],
  "extensions": []
}
```

--------------------------------

### Install PHP and check PATH

Source: https://zed.dev/docs/languages/php

Install PHP on various platforms and verify its presence in PATH. The PHP extension requires PHP to be installed and available in your PATH.

```bash
# macOS via Homebrew
brew install php

# Debian/Ubuntu
sudo apt-get install php-cli

# CentOS 8+/RHEL
sudo dnf install php-cli

# Arch Linux
sudo pacman -S php

# check PHP path
## macOS and Linux
which php

## Windows
where php
```

--------------------------------

### Start LM Studio API server

Source: https://zed.dev/docs/ai/use-a-local-model

Starts the LM Studio API server.

```bash
lms server start
```

--------------------------------

### Minimal SKILL.md example

Source: https://zed.dev/docs/ai/skills

Minimal SKILL.md example with YAML frontmatter and Markdown instructions.

```markdown
---
name: my-skill
description: What this skill does and when to use it.
---

## Instructions

Step-by-step instructions for the agent...
```

--------------------------------

### Install Almond REPL (coursier launch)

Source: https://zed.dev/docs/languages/scala

Launch and install the Almond Scala REPL using Coursier. This command installs the kernel for Jupyter.

```bash
coursier launch --use-bootstrap almond -- --install
```

--------------------------------

### Install Zed on macOS, Windows, and Linux

Source: https://zed.dev/docs/migrate/pycharm

Install Zed on macOS via Homebrew, on Windows via winget, and on Linux via the installation script. After installation, launch Zed from the terminal with `zed .` to open the current directory.

```bash
brew install --cask zed
```

```bash
winget install Zed.Zed
```

```bash
curl -f https://zed.dev/install.sh | sh
```

--------------------------------

### Check sql-formatter installation and version

Source: https://zed.dev/docs/languages/sql

Verify that sql-formatter is installed and accessible in your PATH, and check its version. Run these commands after installation.

```bash
which sql-formatter
sql-formatter --version
```

--------------------------------

### Install and launch Zed

Source: https://zed.dev/docs/migrate/vs-code

Install Zed on macOS via Homebrew, on Linux via the installation script, and launch Zed from the terminal to open the current directory.

```bash
brew install --cask zed
```

```bash
curl -f https://zed.dev/install.sh | sh
```

```bash
zed .
```

--------------------------------

### Install Zed on Linux via script

Source: https://zed.dev/docs/installation

Installs Zed on Linux using the official installation script.

```bash
curl -f https://zed.dev/install.sh | sh
```

--------------------------------

### Install Zed via winget

Source: https://zed.dev/docs/installation

Installs Zed on Windows using winget.

```bash
winget install -e --id ZedIndustries.Zed
```

--------------------------------

### Example extension directory structure

Source: https://zed.dev/docs/extensions/developing-extensions

Example directory structure of an extension that provides all capabilities.

```text
my-extension/
  extension.toml
  Cargo.toml
  src/
    lib.rs
  languages/
    my-language/
      config.toml
      highlights.scm
  themes/
    my-theme.json
  snippets/
    snippets.json
    rust.json
```

--------------------------------

### Install system libraries

Source: https://zed.dev/docs/development/linux

Installs the necessary system libraries for building Zed on Linux. Alternatively, you can install the libraries manually by referring to the list of required packages in the script/linux file.

```bash
script/linux
```

--------------------------------

### Start Ollama server

Source: https://zed.dev/docs/ai/use-a-local-model

Starts the Ollama server from the command line, typically on Linux or from a shell.

```bash
ollama serve
```

--------------------------------

### Install Zed from .tar.gz and symlink binary

Source: https://zed.dev/docs/linux

Downloads the pre-built .tar.gz and places the zed binary on your PATH by extracting to ~/.local and symlinking to ~/.local/bin.

```bash
mkdir -p ~/.local
# extract zed to ~/.local/zed.app/
tar -xvf <path/to/download>.tar.gz -C ~/.local
# link the zed binary to ~/.local/bin (or another directory in your $PATH)
ln -sf ~/.local/zed.app/bin/zed ~/.local/bin/zed
```

--------------------------------

### Custom file_types mapping

Source: https://zed.dev/docs/configuring-zed.html

Example that interprets all .c files as C++, files named MyLockFile as TOML, and files starting with Dockerfile as Dockerfile.

```json
{
  "file_types": {
    "C++": ["c"],
    "TOML": ["MyLockFile"],
    "Dockerfile": ["Dockerfile*"]
  }
}
```

--------------------------------

### Configure Poolside for Zed with pool acp setup

Source: https://zed.dev/docs/ai/external-agents

Run this command after installing the Poolside Agent CLI to configure Zed for Poolside. It always writes to ~/.config/zed/settings.json on macOS and on Linux without a custom XDG_CONFIG_HOME; on Windows or with a custom config directory, use the registry install or manual configuration instead. Zed detects the settings change automatically, so no restart is needed.

```bash
pool acp setup --editor zed
```

--------------------------------

### Install Zed preview on Linux

Source: https://zed.dev/docs/installation

Installs the preview build of Zed on Linux using the ZED_CHANNEL environment variable.

```bash
curl -f https://zed.dev/install.sh | ZED_CHANNEL=preview sh
```

--------------------------------

### Example task file with auto-generated labels

Source: https://zed.dev/docs/tasks

Shows a tasks.json file with npm and shell tasks that omit the label field. Zed generates labels like 'npm: start' and uses the command string for shell tasks.

```json
{
  "version": "2.0.0",
  "tasks": [
    {
      "type": "npm",
      "script": "start"
    },
    {
      "type": "shell",
      "command": "cargo build --release"
    }
  ]
}
```

--------------------------------

### Zed debug config with inline build task

Source: https://zed.dev/docs/debugger

Debug configuration that runs a build task before the debugger starts. The `build` field contains a Zed task with `command` and `args`; useful for setting up the environment or running setup steps.

```json
[
  {
    "label": "Build Binary",
    "adapter": "CodeLLDB",
    "program": "path_to_program",
    "request": "launch",
    "build": {
      "command": "make",
      "args": ["build", "-j8"]
    }
  }
]
```

--------------------------------

### Install sql-formatter

Source: https://zed.dev/docs/languages/sql

Install the sql-formatter CLI globally via npm. Required before configuring Zed to use it as the SQL formatter.

```bash
npm install -g sql-formatter
```

--------------------------------

### Add Poolside as a Custom Agent in Zed settings

Source: https://zed.dev/docs/ai/external-agents

Manual configuration for Poolside as a Custom Agent in Zed. Requires the Poolside Agent CLI installed and `pool` on your PATH. Add this to your Zed settings file when the automatic setup command is not suitable (e.g., Windows or custom config directory).

```json
{
  "agent_servers": {
    "Poolside": {
      "command": "pool",
      "args": ["acp"],
      "type": "custom"
    }
  }
}
```

--------------------------------

### Key sequence and modifier examples

Source: https://zed.dev/docs/key-bindings

Demonstrates key sequences (space-separated keypresses) and modifier usage. Includes comments showing the matched input for each binding, such as 'cmd-k cmd-s' matching ⌘-k then ⌘-s.

```json
{
  "bindings": {
    "cmd-k cmd-s": "zed::OpenKeymap", // matches ⌘-k then ⌘-s
    "space e": "editor::ShowCompletions", // type space then e
    "ç": "editor::ShowCompletions", // matches ⌥-c
    "shift shift": "file_finder::Toggle" // matches pressing and releasing shift twice
  }
}
```

--------------------------------

### Install Deno Jupyter kernel

Source: https://zed.dev/docs/repl

Installs the Deno Jupyter kernel after installing Deno.

```bash
deno jupyter --install
```

--------------------------------

### Verify ocamllsp installation

Source: https://zed.dev/docs/languages/ocaml

Run this command in your terminal to verify that ocamllsp is installed. If you see a help message, the installation is successful; otherwise, revisit the installation instructions for ocamllsp.

```shell
ocamllsp --help
```

--------------------------------

### Install FreeBSD dependencies with script/freebsd

Source: https://zed.dev/docs/development/freebsd

Run the provided script to install necessary system packages and rustup on FreeBSD. Inspect the script first if you prefer to perform the steps manually.

```bash
script/freebsd
```

--------------------------------

### Example context tree in editor and project panel

Source: https://zed.dev/docs/key-bindings

Shows the active context tree in an editor and in the project panel. The first example includes attributes like os, keyboard_layout, mode, extension, and vim_mode; the second shows a Dock with ProjectPanel. Use the `dev: open key context view` command to see the current context tree.

```text
Workspace os=macos keyboard_layout=com.apple.keylayout.QWERTY
  Pane
    Editor mode=full extension=md vim_mode=insert
```

```text
Workspace os=macos
  Dock
    ProjectPanel not_editing
```

--------------------------------

### Example Zed settings.json configuration

Source: https://zed.dev/docs/configuring-zed.html

Example of a full `settings.json` file for Zed, located at `~/.config/zed/settings.json`. It shows global settings like theme, tab size, font, autosave, and terminal options, plus language-specific overrides for C.

```json
// ~/.config/zed/settings.json
{
  "theme": "cave-light",
  "tab_size": 2,
  "preferred_line_length": 80,
  "soft_wrap": "none",

  "buffer_font_size": 18,
  "buffer_font_family": ".ZedMono",

  "autosave": "on_focus_change",
  "format_on_save": "off",
  "vim_mode": false,
  "terminal": {
    "font_family": "FiraCode Nerd Font Mono",
    "blinking": "off"
  },
  "languages": {
    "C": {
      "format_on_save": "on",
      "formatter": "language_server",
      "preferred_line_length": 64,
      "soft_wrap": "bounded"
    }
  }
}
```

--------------------------------

### Configure clangd with .clangd file

Source: https://zed.dev/docs/languages/cpp

Example `.clangd` file for extra clangd configuration, adding an include directory and setting strict diagnostics for missing and unused includes.

```yaml
# yaml-language-server: $schema=https://json.schemastore.org/clangd.json
CompileFlags:
  Add:
    - "--include-directory=/path/to/include"
Diagnostics:
  MissingIncludes: Strict
  UnusedIncludes: Strict
```

--------------------------------

### Install Python with Homebrew

Source: https://zed.dev/docs/languages/python

Install Python using Homebrew on macOS. Requires Homebrew to be installed and available in your shell.

```bash
brew install python
```

--------------------------------

### Install Zed preview via Homebrew

Source: https://zed.dev/docs/installation

Installs the preview version of Zed on macOS using Homebrew.

```bash
brew install --cask zed@preview
```

--------------------------------

### Install heaptrack and profile Zed with cargo heaptrack

Source: https://zed.dev/docs/development/linux

Install heaptrack and its cargo wrapper, then build and run Zed with the profiler attached. When the Zed instance exits, terminal output includes a command to run heaptrack_interpret to convert the *.raw.zst profile to a *.zst file for viewing in heaptrack_gui.

```bash
$ sudo apt install heaptrack heaptrack-gui
$ cargo install cargo-heaptrack

```

```bash
$ cargo heaptrack -b zed

```

--------------------------------

### Start llama.cpp server

Source: https://zed.dev/docs/ai/use-a-local-model

Starts the llama.cpp server in router mode, loading models from the llama.cpp cache on demand.

```bash
llama serve
```

--------------------------------

### Install gopls with go install

Source: https://zed.dev/docs/languages/go

Install or update gopls to the latest version using the Go module tool. This is the recommended method over package managers.

```shell
go install golang.org/x/tools/gopls@latest
```

--------------------------------

### Convert zed.dwarf to a .dSYM bundle

Source: https://zed.dev/docs/development/macos

Create a .dSYM bundle from the downloaded zed.dwarf file so Spotlight can index it and `sample` can resolve symbols automatically.

```bash
mkdir -p Zed.dSYM/Contents/Resources/DWARF
cp zed.dwarf Zed.dSYM/Contents/Resources/DWARF/zed
```

--------------------------------

### Zed task configuration example

Source: https://zed.dev/docs/tasks

Example task configuration for Zed's integrated terminal. Shows all available task options with defaults and comments. Use this as a template for defining tasks in Zed.

```json
[
  {
    "label": "Example task",
    "command": "for i in {1..5}; do echo \"Hello $i/5\"; sleep 1; done",
    //"args": [],
    // Env overrides for the command, will be appended to the terminal's environment from the settings.
    "env": { "foo": "bar" },
    // Current working directory to spawn the command into, defaults to current project root.
    //"cwd": "/path/to/working/directory",
    // Whether to use a new terminal tab or reuse the existing one to spawn the process, defaults to `false`.
    "use_new_terminal": false,
    // Whether to allow multiple instances of the same task to be run, or rather wait for the existing ones to finish, defaults to `false`.
    "allow_concurrent_runs": false,
    // What to do with the terminal pane and tab, after the command was started:
    // * `always` — always show the task's pane, and focus the corresponding tab in it (default)
    // * `no_focus` — always show the task's pane, add the task's tab in it, but don't focus it
    // * `never` — do not alter focus, but still add/reuse the task's tab in its pane
    "reveal": "always",
    // What to do with the terminal pane and tab, after the command has finished:
    // * `never` — Do nothing when the command finishes (default)
    // * `always` — always hide the terminal tab, hide the pane also if it was the last tab in it
    // * `on_success` — hide the terminal tab on task success only, otherwise behaves similar to `always`
    "hide": "never",
    // Which shell to use when running a task inside the terminal.
    // May take 3 values:
    // 1. (default) Use the system's default terminal configuration in /etc/passwd
    //      "shell": "system"
    // 2. A program:
    //      "shell": {
    //        "program": "sh"
    //      }
    // 3. A program with arguments:
    //     "shell": {
    //         "with_arguments": {
    //           "program": "/bin/bash",
    //           "args": ["--login"]
    //         }
    //     }
    "shell": "system",
    // Whether to show the task line in the output of the spawned task, defaults to `true`.
    "show_summary": true,
    // Whether to show the command line in the output of the spawned task, defaults to `true`.
    "show_command": true,
    // Which edited buffers to save before running the task:
    // * `all` — save all edited buffers
    // * `current` — save currently active buffer only
    // * `none` — don't save any buffers
    "save": "none"
    // Represents the tags for inline runnable indicators, or spawning multiple tasks at once.
    // "tags": []
  }
]
```

--------------------------------

### Install HLS with ghcup

Source: https://zed.dev/docs/languages/haskell

Install haskell-language-server (HLS) via ghcup and verify the wrapper binary is available. Run these commands in a terminal after installing ghcup.

```shell
ghcup install hls
which haskell-language-server-wrapper
```

--------------------------------

### Example of changed Vim settings

Source: https://zed.dev/docs/vim

Shows a complete example of changing multiple Vim settings, including default mode, clipboard, smartcase find, regex search, gdefault, relative line numbers, highlight duration, and custom digraphs.

```json
{
  "vim": {
    "default_mode": "insert",
    "use_system_clipboard": "never",
    "use_smartcase_find": true,
    "use_regex_search": true,
    "gdefault": true,
    "toggle_relative_line_numbers": true,
    "highlight_on_yank_duration": 50,
    "custom_digraphs": {
      "fz": "🧟‍♀️"
    }
  }
}
```
Tokens:
Raw