This crate lets you write extensions for Zed in Rust.

You'll need an extension.toml file at the root of your extension directory, with the following structure:

id = "my-extension"
name = "My Extension"
description = "..."
version = "0.0.1"
schema_version = 1
authors = ["Your Name <you@example.com>"]
repository = "https://github.com/your/extension-repository"

Zed extensions are packaged as WebAssembly files. In your Cargo.toml, you'll need to set your crate-type accordingly:

[dependencies]
zed_extension_api = "0.6.0"

[lib]
crate-type = ["cdylib"]

To define your extension, create a type that implements the Extension trait, and register it.

use zed_extension_api as zed;

struct MyExtension {
    // ... state
}

impl zed::Extension for MyExtension {
    // ...
}

zed::register_extension!(MyExtension);

To run your extension in Zed as you're developing it:

• Make sure you have Rust installed
• Have the wasm32-wasip2 target installed (rustup target add wasm32-wasip2)
• Open the extensions view using the zed: extensions action in the command palette.
• Click the Install Dev Extension button in the top right
• Choose the path to your extension directory.

Extensions created using newer versions of the Zed extension API won't be compatible with older versions of Zed.

Here is the compatibility of the zed_extension_api with versions of Zed: