Zed

https://github.com/zed-industries/zed
Admin
Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators...
Tokens:451,743
Snippets:3,885
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Low-Level Server with Prompts and stdio

Source: https://github.com/zed-industries/zed/blob/main/crates/agent/src/tools/evals/fixtures/zode/prompt.md

A complete low-level server example that implements prompt listing and retrieval, then runs over stdio. It demonstrates the full setup including InitializationOptions and the run loop.

```python
import mcp.server.stdio
import mcp.types as types
from mcp.server.lowlevel import NotificationOptions, Server
from mcp.server.models import InitializationOptions

# Create a server instance
server = Server("example-server")


@server.list_prompts()
async def handle_list_prompts() -> list[types.Prompt]:
    return [
        types.Prompt(
            name="example-prompt",
            description="An example prompt template",
            arguments=[
                types.PromptArgument(
                    name="arg1", description="Example argument", required=True
                )
            ],
        )
    ]


@server.get_prompt()
async def handle_get_prompt(
    name: str, arguments: dict[str, str] | None
) -> types.GetPromptResult:
    if name != "example-prompt":
        raise ValueError(f"Unknown prompt: {name}")

    return types.GetPromptResult(
        description="Example prompt",
        messages=[
            types.PromptMessage(
                role="user",
                content=types.TextContent(type="text", text="Example prompt text"),
            )
        ],
    )


async def run():
    async with mcp.server.stdio.stdio_server() as (read_stream, write_stream):
        await server.run(
            read_stream,
            write_stream,
            InitializationOptions(
                server_name="example",
                server_version="0.1.0",
                capabilities=server.get_capabilities(
                    notification_options=NotificationOptions(),
                    experimental_capabilities={},
                ),
            ),
        )


if __name__ == "__main__":
    import asyncio

    asyncio.run(run())
```

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

### Scala setup commands

Source: https://github.com/zed-industries/zed/blob/main/docs/src/repl.md

Commands to install Scala via Coursier and set up the Almond REPL kernel.

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

```sh
brew install --cask temurin
```

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

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

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

### Serve the GPUI web gallery with trunk serve

Source: https://github.com/zed-industries/zed/blob/main/crates/gpui/examples/README.md

Start the standalone web gallery server. Requires Trunk and a browser with WebGPU or WebGL2 support. Open http://localhost:8080/ to choose an example.

```sh
cd crates/gpui_web/examples/hello_web
trunk serve
```

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

### Launch Zed from project directory

Source: https://github.com/zed-industries/zed/blob/main/docs/src/languages/ocaml.md

Run this command from your project directory to start Zed with OCaml support. Requires the Zed CLI to be installed and available in your PATH.

```sh
zed .
```

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

### Run a GPUI example with cargo run

Source: https://github.com/zed-industries/zed/blob/main/crates/gpui/examples/README.md

Run a GPUI example from the Zed repository root. Replace hello_world with the name of another example.

```sh
cargo run -p gpui --example hello_world
```

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

### Install local development build with ./script/install-linux

Source: https://github.com/zed-industries/zed/blob/main/docs/src/development/linux.md

Installs a local development 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`.

```sh
./script/install-linux
```

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

### Minimal SKILL.md example

Source: https://github.com/zed-industries/zed/blob/main/docs/src/ai/skills.md

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 Zed manually on Linux and set up desktop integration

Source: https://github.com/zed-industries/zed/blob/main/docs/src/linux.md

Manual installation of Zed on Linux: extract the downloaded .tar.gz to ~/.local, then symlink the zed binary into a directory on your $PATH. The second block installs the .desktop file for XDG-compatible desktop environments and updates its Icon and Exec paths to point to the local installation.

```sh
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
```

```sh
install -D ~/.local/zed.app/share/applications/dev.zed.Zed.desktop -t ~/.local/share/applications
sed -i "s|Icon=zed|Icon=$HOME/.local/zed.app/share/icons/hicolor/512x512/apps/zed.png|g" ~/.local/share/applications/dev.zed.Zed.desktop
sed -i "s|Exec=zed|Exec=$HOME/.local/zed.app/bin/zed|g" ~/.local/share/applications/dev.zed.Zed.desktop
```

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

### Example configuration

Source: https://github.com/zed-industries/zed/blob/main/docs/src/configuring-zed.md

A comprehensive example of a user settings file showing theme, font, tab size, format on save, autosave, vim mode, terminal settings, and per-language overrides.

```json
{
  "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
    }
  }
}
```

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

### Debug task with embedded build command

Source: https://github.com/zed-industries/zed/blob/main/docs/src/debugger.md

Debug task with an embedded build task in the `build` field. The build task runs before the debugger starts, useful for setup steps. This example uses `make build -j8` as the build command.

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

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

### Download model and start LM Studio server

Source: https://github.com/zed-industries/zed/blob/main/docs/src/ai/use-a-local-model.md

Use the LM Studio CLI to download a model and start the API server. The first command fetches the qwen2.5-coder-7b model; the second starts the server that Zed connects to.

```sh
lms get qwen2.5-coder-7b
```

```sh
lms server start
```

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

### Install elm-review and elm-format

Source: https://github.com/zed-industries/zed/blob/main/docs/src/languages/elm.md

Install elm-review for linting and elm-format for automatic formatting. These commands are part of the Elm setup in Zed.

```sh
npm install elm-review --save-dev
```

```sh
npm install -g elm-format
```

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

### Custom file_types mapping example

Source: https://github.com/zed-industries/zed/blob/main/docs/src/reference/all-settings.md

Example of using 'file_types' to interpret all .c files as C++, a file named MyLockFile as TOML, and files starting with Dockerfile as Dockerfile.

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

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

### Install dependencies with script/freebsd

Source: https://github.com/zed-industries/zed/blob/main/docs/src/development/freebsd.md

Run the provided script to install necessary system packages and rustup. Alternatively, inspect the script and perform the steps manually.

```sh
script/freebsd
```

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

### Python global environment setup

Source: https://github.com/zed-industries/zed/blob/main/docs/src/repl.md

Commands to install ipykernel and register the current Python environment as a Jupyter kernel for use with Zed's REPL.

```sh
pip install ipykernel
python -m ipykernel install --user
```

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

### Initialize uv project and add MCP dependency

Source: https://github.com/zed-industries/zed/blob/main/crates/agent/src/tools/evals/fixtures/zode/prompt.md

Create a new uv-managed project and add the MCP Python SDK with CLI support. Run these commands in sequence to set up a project for building MCP servers or clients.

```bash
uv init mcp-server-demo
cd mcp-server-demo
```

```bash
uv add "mcp[cli]"
```

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

### Get usage from message.usage

Source: https://github.com/zed-industries/zed/blob/main/crates/agent/src/tools/evals/fixtures/zode/prompt.md

Access the exact usage for a given request through the usage response property. The example shows the Usage object with input_tokens and output_tokens fields.

```python
message = client.messages.create(...)
message.usage
# Usage(input_tokens=25, output_tokens=13)
```

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

### Project settings example (.zed/settings.json)

Source: https://github.com/zed-industries/zed/blob/main/docs/src/configuring-zed.md

Example of a project-level settings file that overrides user settings for a specific project. Sets tab_size, formatter, and format_on_save. Note that not all settings can be set at the project level; global settings like theme or vim_mode only work in user settings.

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

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

### Manual Poolside Custom Agent Configuration

Source: https://github.com/zed-industries/zed/blob/main/docs/src/ai/external-agents.md

Manually add Poolside as a Custom Agent in Zed's settings.json when the CLI setup is not suitable. Requires the Poolside Agent CLI installed and 'pool' on your PATH. This configuration is an alternative to the 'pool acp setup --editor zed' command.

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

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

### Per-release channel overrides example

Source: https://github.com/zed-industries/zed/blob/main/docs/src/configuring-zed.md

Example of using top-level channel keys (nightly, preview) to apply different settings for Stable, Preview, or Nightly builds. Stable uses One Dark with vim mode off, Preview uses Catppuccin Mocha with vim mode off, and Nightly uses Rosé Pine with vim mode on.

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

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

### Check setup and create Modal volume

Source: https://github.com/zed-industries/zed/blob/main/crates/eval_cli/zed_eval/README.md

Checks your setup and creates the Modal volume if needed. Use this to ensure the environment is ready before launching runs.

```sh
zed-eval doctor --create-volume
```

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

### Count tokens with client.beta.messages.count_tokens()

Source: https://github.com/zed-industries/zed/blob/main/crates/agent/src/tools/evals/fixtures/zode/prompt.md

Use the count_tokens method to get the token count for a message without creating it. It takes the same messages list as the .create() method. The example shows the input_tokens attribute returning 10.

```python
count = client.beta.messages.count_tokens(
    model="claude-3-5-sonnet-20241022",
    messages=[
        {"role": "user", "content": "Hello, world"}
    ]
)
count.input_tokens  # 10
```

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

### Install HLS with ghcup and verify wrapper

Source: https://github.com/zed-industries/zed/blob/main/docs/src/languages/haskell.md

Install haskell-language-server using ghcup, then verify the wrapper binary is available. Run these commands in a terminal.

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

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

### VS Code tasks.json with auto-generated labels

Source: https://github.com/zed-industries/zed/blob/main/docs/src/tasks.md

Example .vscode/tasks.json file with npm and shell tasks. When imported into Zed, labels are auto-generated: 'npm: start' for the npm task and 'cargo build --release' for the shell task. You can override the generated label by providing an explicit 'label' field.

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

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

### Change vim mode settings

Source: https://github.com/zed-industries/zed/blob/main/docs/src/vim.md

Example of changing vim mode settings: starts in insert mode, disables system clipboard, enables smartcase find and regex search, sets gdefault, toggles relative line numbers, sets highlight duration to 50 ms, and includes the custom digraph.

```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": "🧟‍♀️"
    }
  }
}
```

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

### Create a FastMCP server with a tool and resource

Source: https://github.com/zed-industries/zed/blob/main/crates/agent/src/tools/evals/fixtures/zode/prompt.md

Creates a FastMCP server named "Demo" with an addition tool and a dynamic greeting resource. Use this as the starting point for building an MCP server that exposes tools and resources to LLM applications.

```python
# server.py
from mcp.server.fastmcp import FastMCP

# Create an MCP server
mcp = FastMCP("Demo")


# Add an addition tool
@mcp.tool()
def add(a: int, b: int) -> int:
    """Add two numbers"""
    return a + b


# Add a dynamic greeting resource
@mcp.resource("greeting://{name}")
def get_greeting(name: str) -> str:
    """Get a personalized greeting"""
    return f"Hello, {name}!"
```

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

### Configure custom file associations in settings.json

Source: https://github.com/zed-industries/zed/blob/main/docs/src/configuring-languages.md

Use the file_types setting in settings.json to map file extensions or names to specific languages. This example treats .c files as C++, recognizes MyLockFile as TOML, and applies Dockerfile syntax to any file starting with 'Dockerfile'. Glob patterns are supported for flexible matching.

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

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

### Install Zed stable via installation script

Source: https://github.com/zed-industries/zed/blob/main/docs/src/installation.md

Installs the latest stable version of Zed on Linux using the official installation script.

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

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

### Zed settings.json example

Source: https://github.com/zed-industries/zed/blob/main/docs/src/reference/all-settings.md

Example Zed settings file showing global options like theme, tab size, autosave, and per-language overrides for C. Place at ~/.config/zed/settings.json.

```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"
    }
  }
}
```

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

### Install Zed with Homebrew, winget, or curl

Source: https://github.com/zed-industries/zed/blob/main/docs/src/migrate/rustrover.md

Install Zed on macOS, Windows, and Linux using the respective package manager commands. The Homebrew command installs the cask version, winget installs the official package, and the curl command runs the installation script for Linux. Launch Zed with 'zed .' after installation.

```sh
brew install --cask zed
```

```sh
winget install Zed.Zed
```

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

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

### Install Python with Homebrew

Source: https://github.com/zed-industries/zed/blob/main/docs/src/languages/python.md

Installs Python using Homebrew on macOS. This is an alternative to the uv installer.

```bash
brew install python
```

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

### Run the cli crate with parameters

Source: https://github.com/zed-industries/zed/blob/main/crates/cli/README.md

Build and run the cli crate with the specified parameters, pointing to the built zed binary.

```bash
 cargo run -p cli -- --zed ./target/debug/zed.exe
```

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

### SKILL.md frontmatter and instructions example

Source: https://github.com/zed-industries/zed/blob/main/crates/agent_skills/builtin/create-skill/SKILL.md

Example of a SKILL.md file with required YAML frontmatter fields (name and description) and the instruction body. The name must match the containing directory name and follow the regex ^[a-z0-9]+(-[a-z0-9]+)*$.

```markdown
---
name: my-skill-name
description: A clear, specific description of what this skill does and when to use it.
---

# Skill Title

Instructions for the agent go here. Write them as if you're telling the agent
what to do when this skill is activated.
```

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

### Verify ocamllsp installation

Source: https://github.com/zed-industries/zed/blob/main/docs/src/languages/ocaml.md

Run this command in your terminal to confirm that the ocamllsp language server is installed. A help message indicates a successful installation; otherwise, revisit the installation instructions.

```sh
ocamllsp --help
```

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

### Create and run a GPUI application

Source: https://github.com/zed-industries/zed/blob/main/crates/gpui/README.md

Creates an Application with gpui_platform::application() and runs it with a callback that receives an App. Inside the callback you can open windows and register root views.

```rust
use gpui::*;

fn main() {
    gpui_platform::application().run(|cx: &mut App| {
        // ..
    });
}
```

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

### List installed extensions on Linux

Source: https://github.com/zed-industries/zed/blob/main/docs/src/reference/all-settings.md

Command to list installed extensions on Linux by listing the installation directory.

```sh
ls ~/.local/share/zed/extensions/installed
```

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

### List installed extensions on macOS

Source: https://github.com/zed-industries/zed/blob/main/docs/src/reference/all-settings.md

Command to list installed extensions on macOS by listing the installation directory.

```sh
ls ~/Library/Application\ Support/Zed/extensions/installed/
```

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

### Install Zed preview via ZED_CHANNEL

Source: https://github.com/zed-industries/zed/blob/main/docs/src/installation.md

Installs the preview build of Zed on Linux, which receives updates about a week ahead of stable.

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

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

### Configure restore_on_startup options

Source: https://github.com/zed-industries/zed/blob/main/docs/src/reference/all-settings.md

These settings control session restoration on startup. Each option sets the `restore_on_startup` setting to a different value: `last_session` restores all workspaces, `last_workspace` restores the most recently closed workspace, `empty_tab` starts with an empty editor, and `launchpad` starts with the welcome launchpad.

```json
{
  "restore_on_startup": "last_session"
}
```

```json
{
  "restore_on_startup": "last_workspace"
}
```

```json
{
  "restore_on_startup": "empty_tab"
}
```

```json
{
  "restore_on_startup": "launchpad"
}
```

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

### List installed extensions on Windows

Source: https://github.com/zed-industries/zed/blob/main/docs/src/reference/all-settings.md

PowerShell command to list installed extensions on Windows by listing the installation directory.

```pwsh
Get-ChildItem "$env:LOCALAPPDATA\Zed\extensions\installed" -Name
```

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

### Install MCP server in Claude Desktop

Source: https://github.com/zed-industries/zed/blob/main/crates/agent/src/tools/evals/fixtures/zode/prompt.md

Installs the server into Claude Desktop for immediate interaction. Run this command after creating the server.py file.

```bash
mcp install server.py
```

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

### Install gopls with go install

Source: https://github.com/zed-industries/zed/blob/main/docs/src/languages/go.md

Installs or updates gopls to the latest version using the Go module tool.

```sh
go install golang.org/x/tools/gopls@latest
```
Tokens:
Raw