Zed: Difference between revisions

== LSP support ==

<translate>

Zed downloads language servers into <code>~/.local/share/zed/languages/</code>, which is read-only on NixOS. Instead, use declarative methods to supply LSP binaries.

</translate>

<translate>

Check <strong>LSP Logs → Server Info</strong> to confirm which binaries are running. Prefer language servers packaged in Nixpkgs so that dependencies are resolved within the Nix store.

</translate>

==== Nix-ld (recommended) ====

<translate>

Enable [[FAQ#I've downloaded a binary, but I can't run it, what can I do?|<code>nix-ld</code>]] so prebuilt language servers can resolve dynamic libraries without wrapping.

</translate>

==== FHS wrapper ====

<translate>

Use <code>pkgs.zed-editor.fhsWithPackages</code> to extend the FHS environment with additional system libraries when a language server requires them.

</translate>

{{code|lang=nix|line=no|1=pkgs.zed-editor.fhsWithPackages (pkgs: with pkgs; [ openssl zlib ])}}

<translate>

Remember that language servers started inside the wrapper do not automatically inherit tools from ad-hoc shells; include every dependency declaratively.

</translate>

==== Bring your own LSP servers ====

<translate>

Newer versions of Zed can detect LSP servers installed in <code>PATH</code> and prefer local versions over automatically downloaded ones. Install LSP servers globally or provide them through nix shell.

</translate>

<translate>

Nixpkgs versions of tools may be required for development on NixOS, especially for the C/C++ ecosystem. Check <strong>LSP Logs → Server Info</strong> to see which binaries are running.

</translate>

<translate>

If automatic detection doesn't work, specify the path manually in your Zed configuration:

</translate>

}}

<translate>

Adjust the path for each language server you manage. The example above assumes rust-analyzer is installed in your system profile.

</translate>

== Remote server ==

<translate>

Zed uploads a versioned remote server binary to <code>~/.zed_server</code> on the target host. The Nixpkgs package exposes the matching binary via the <code>remote_server</code> output.

</translate>

<translate>

When you connect to a remote machine, the client either downloads a matching server binary from upstream or pushes a local copy if <code>"upload_binary_over_ssh": true</code> is enabled. Connections fail if the versions diverge.

</translate>

};}}

<translate>

The <code>recursive = true;</code> setting keeps the directory writable while symlinking individual binaries, allowing Zed to add new versions when needed. This is necessary because the <code>~/.zed_server</code> folder is also used when external clients connect to the current system as a remote.

</translate>

<translate>

Alternatively, use Home Manager's built-in option for simpler setup:

</translate>

};}}

<translate>

To restrict remote clients to a specific server version, set <code>recursive = false;</code> to make the entire folder read-only. Zed refuses to connect if it cannot provision the required binary, so document the restriction for collaborators.

</translate>

{{code|lang=bash|line=no|1=$ vulkaninfo --summary}}

<translate>

Run the command above to check your Vulkan support before launching Zed. Install <code>vulkan-tools</code> if the command is not available. On non-NixOS systems, you may need to wrap Zed with <code>nixGLVulkan</code> from the nixGL package.

</translate>

}}

<translate>

Declaratively listing extensions ensures they are installed automatically on new systems while still allowing additional extensions to be added interactively.

</translate>

==== Synchronise settings across machines ====

<translate>

Store the entire <code>~/.config/zed</code> directory in a version-controlled dotfiles repo or manage it with Home Manager to keep settings consistent across hosts.

</translate>

==== Zed fails to start without Vulkan ====

<translate>

If the GUI refuses to launch, confirm that <code>vulkan-tools</code> reports a working ICD. Use <code>nixGL</code> or vendor packages that supply Vulkan drivers for your GPU.

</translate>

==== Remote collaboration disconnects ====

<translate>

Ensure the remote server binary matches the client version. Re-run <code>home-manager switch</code> or update the symlink in <code>~/.zed_server</code> if the versions diverge after an update.

</translate>

==== Language server missing binaries ====

<translate>

When Zed reports missing tools, add the required executables to <code>programs.zed-editor.extraPackages</code> or wrap the server using <code>pkgs.writeShellApplication</code>.

</translate>

== See also ==

* <translate>

[[Home Manager]] – Manage Zed configuration declaratively

</translate>

* <translate>

[[Graphics#Vulkan]] – Set up Vulkan on NixOS systems

</translate>

* <translate>

[https://search.nixos.org/options?query=zed-editor NixOS options search for Zed]

</translate>