Detailed changes
@@ -1,15 +1,14 @@
# Summary
-# General
+# Getting Started
- [Getting Started](./getting-started.md)
-- [System Requirements](./system-requirements.md)
-- [Accounts](./accounts.md)
-- [Linux](./linux.md)
-- [Windows](./windows.md)
+- [Installation](./installation.md)
+ - [Update](./update.md)
+ - [Uninstall](./uninstall.md)
+- [Authenticate](./authentication.md)
- [Telemetry](./telemetry.md)
- [Troubleshooting](./troubleshooting.md)
-- [Additional Learning Materials](./additional-learning-materials.md)
# Configuration
@@ -31,6 +30,8 @@
# Using Zed
- [Multibuffers](./multibuffers.md)
+- [Command Palette](./command-palette.md)
+- [Command-line Interface](./command-line-interface.md)
- [Outline Panel](./outline-panel.md)
- [Code Completions](./completions.md)
- [Channels](./channels.md)
@@ -43,6 +44,11 @@
- [Environment Variables](./environment.md)
- [REPL](./repl.md)
+# Platform Support
+
+- [Windows](./windows.md)
+- [Linux](./linux.md)
+
# AI
- [Overview](./ai/overview.md)
@@ -3,7 +3,7 @@
When using AI in Zed, you can configure multiple dimensions:
1. Which LLM providers you can use
- - Zed's hosted models, which require [authentication](../accounts.md) and [subscription](./subscription.md)
+ - Zed's hosted models, which require [authentication](../authentication.md) and [subscription](./subscription.md)
- [Using your own API keys](./llm-providers.md), which do not
- Using [external agents like Claude Code](./external-agents.md), which do not
2. [Model parameters and usage](./agent-settings.md#model-settings)
@@ -3,7 +3,7 @@
Edit Prediction is Zed's mechanism for predicting the code you want to write through AI.
Each keystroke sends a new request to the edit prediction provider, which returns individual or multi-line suggestions that can be quickly accepted by pressing `tab`.
-The default provider is [Zeta, a proprietary open source and open dataset model](https://huggingface.co/zed-industries/zeta), which [requires being signed into Zed](../accounts.md#what-features-require-signing-in).
+The default provider is [Zeta, a proprietary open source and open dataset model](https://huggingface.co/zed-industries/zeta), which [requires being signed into Zed](../authentication.md#what-features-require-signing-in).
Alternatively, you can use other providers like [GitHub Copilot](#github-copilot) (or [Enterprise](#github-copilot-enterprise)) or [Supermaven](#supermaven).
@@ -4,7 +4,7 @@
For costs and more information on pricing, visit [Zed’s pricing page](https://zed.dev/pricing).
-Please note that if you’re interested in just using Zed as the world’s fastest editor, with no AI or subscription features, you can always do so for free, without [authentication](../accounts.md).
+Please note that if you’re interested in just using Zed as the world’s fastest editor, with no AI or subscription features, you can always do so for free, without [authentication](../authentication.md).
## Usage {#usage}
@@ -16,7 +16,7 @@ It is entirely possible to use Zed, including Zed's AI capabilities, without sha
- [AI Improvement](./ai-improvement.md): Zed's opt-in-only approach to data collection for AI improvement, whether our Agentic offering or Edit Predictions.
-- [Accounts](../accounts.md): When and why you'd need to authenticate into Zed, how to do so, and what scope we need from you.
+- [Accounts](../authentication.md): When and why you'd need to authenticate into Zed, how to do so, and what scope we need from you.
## Legal Links
@@ -1,11 +1,11 @@
-# Accounts
+# Authenticate with Zed
-Signing in to Zed is not a requirement. You can use most features you'd expect in a code editor without ever doing so. We'll outline the few features that do require signing in, and how to do so, here.
+Signing in to Zed is not required. You can use most features you'd expect in a code editor without ever doing so. We'll outline the few features that do require signing in, and how to do so, here.
## What Features Require Signing In?
1. All real-time [collaboration features](./collaboration.md).
-2. [LLM-powered features](./ai/overview.md), if you are using Zed as the provider of your LLM models. Alternatively, you can [bring and configure your own API keys](./ai/llm-providers.md#use-your-own-keys) if you'd prefer, and avoid having to sign in.
+2. [LLM-powered features](./ai/overview.md), if you are using Zed as the provider of your LLM models. To use AI without signing in, you can [bring and configure your own API keys](./ai/llm-providers.md#use-your-own-keys).
## Signing In
@@ -0,0 +1,18 @@
+# Command-line Interface
+
+Zed has a CLI, on Linux this should come with the distribution's Zed package (binary name can vary from distribution to distribution, `zed` will be used later for brevity).
+For macOS, the CLI comes in the same package with the editor binary, and could be installed into the system with the `cli: install` Zed command which will create a symlink to the `/usr/local/bin/zed`.
+It can also be built from source out of the `cli` crate in this repository.
+
+Use `zed --help` to see the full list of capabilities.
+General highlights:
+
+- Opening another empty Zed window: `zed`
+
+- Opening a file or directory in Zed: `zed /path/to/entry` (use `-n` to open in the new window)
+
+- Reading from stdin: `ps axf | zed -`
+
+- Starting Zed with logs in the terminal: `zed --foreground`
+
+- Uninstalling Zed and all its related files: `zed --uninstall`
@@ -0,0 +1,9 @@
+# Command Palette
+
+The Command Palette is the main way to access pretty much any functionality that's available in Zed. Its keybinding is the first one you should make yourself familiar with. To open it, hit: {#kb command_palette::Toggle}.
+
+
+
+Try it! Open the Command Palette and type in `new file`. You should see the list of commands being filtered down to `workspace: new file`. Hit return and you end up with a new buffer.
+
+Any time you see instructions that include commands of the form `zed: ...` or `editor: ...` and so on that means you need to execute them in the Command Palette.
@@ -4,14 +4,12 @@ Zed is designed to be configured: we want to fit your workflow and preferences e
In addition to the settings described here, you may also want to change your [theme](./themes.md), configure your [key bindings](./key-bindings.md), set up [tasks](./tasks.md) or install [extensions](https://github.com/zed-industries/extensions).
-## Settings Window
+## Settings Editor
-You can browse through many of the supported settings by using the settings window, which can be opened with the {#kb zed::OpenSettings} keybinding, or through the `zed: open settings` action in the command palette.
+You can browse through many of the supported settings via the Settings Editor, which can be opened with the {#kb zed::OpenSettings} keybinding, or through the `zed: open settings` action in the command palette. Through it, you can customize your local, user settings as well as project settings.
-Through it, you can customize your local, user settings as well as project settings.
-
-> Note that not all settings that Zed supports are available through the UI yet.
-> Some more intricate ones—for example, language formatters—can only be changed through the JSON settings file.
+> Note that not all settings that Zed supports are available through the Settings Editor yet.
+> Some more intricate ones, such as language formatters, can only be changed through the JSON settings file {#kb: zed::OpenSettingsFile}.
## User Settings File
@@ -29,8 +27,8 @@ Whatever you have added to your user settings file gets merged with any local co
### Default Settings
-When visiting the settings UI, the values you see set are the default ones.
-You can also verify all of them in JSON form by running {#action zed::OpenDefaultSettings} from the command palette.
+In the Settings Editor, the values you see set are the default ones.
+You can also verify them in JSON by running {#action zed::OpenDefaultSettings} from the command palette.
Extensions that provide language servers may also provide default settings for those language servers.
@@ -67,9 +65,9 @@ They are merged into the base configuration with settings from these keys taking
With this configuration, Stable keeps all base preferences, Preview switches to `zed-dark`, and Nightly enables Vim mode with a different theme.
-Changing settings via the UI will always apply the change across all channels.
+Changing settings in the Settings Editorwill always apply the change across all channels.
----
+# Settings
Find below an extensive run-through of many supported settings by Zed.
@@ -1,94 +1,19 @@
# Getting Started
-Welcome to Zed! We are excited to have you. Here is a jumping-off point to getting started.
+Welcome to Zed! We are excited to have you. Zed is a powerful multiplayer code editor designed to stay out of your way and help you build what's next.
-## Download Zed
+## Key Features
-### macOS
+- [Smooth Editing](./configuring-zed.md): Built in Rust, Zed is responsive and intuitive, with a minimalistic aesthetic and pixel-level editing controls.
+- [Agentic Editing](./ai/overview.md): Use Zed's hosted models to collaborate with agents directly in an IDE. You can also plug into a third-party agent or bring your own keys.
+- [Debugger](./debugger.md): Debug your code in seconds, not hours, with minimal setup required.
+- [Remote Development](./remote-development.md): Offload the heavy lifting to the cloud, so you can focus on writing code.
+- [Extensions](./extensions.md): Leverage Zed's extensions to customize how you work.
-Get the latest stable builds via [the download page](https://zed.dev/download). If you want to download our preview build, you can find it on its [releases page](https://zed.dev/releases/preview). After the first manual installation, Zed will periodically check for install updates.
+## Join the Zed Community
-You can also install Zed stable via Homebrew:
+Zed is proudly open source, and we get better with every contribution. Join us on GitHub or in Discord to contribute code, report bugs, or suggest features.
-```sh
-brew install --cask zed
-```
-
-As well as Zed preview:
-
-```sh
-brew install --cask zed@preview
-```
-
-### Windows
-
-Get the latest stable builds via [the download page](https://zed.dev/download). If you want to download our preview build, you can find it on its [releases page](https://zed.dev/releases/preview). After the first manual installation, Zed will periodically check for install updates.
-
-### Linux
-
-For most Linux users, the easiest way to install Zed is through our installation script:
-
-```sh
-curl -f https://zed.dev/install.sh | sh
-```
-
-If you'd like to help us test our new features, you can also install our preview build:
-
-```sh
-curl -f https://zed.dev/install.sh | ZED_CHANNEL=preview sh
-```
-
-This script supports `x86_64` and `AArch64`, as well as common Linux distributions: Ubuntu, Arch, Debian, RedHat, CentOS, Fedora, and more.
-
-If Zed is installed using this installation script, it can be uninstalled at any time by running the shell command `zed --uninstall`. The shell will then prompt you whether you'd like to keep your preferences or delete them. After making a choice, you should see a message that Zed was successfully uninstalled.
-
-If this script is insufficient for your use case, you run into problems running Zed, or there are errors in uninstalling Zed, please see our [Linux-specific documentation](./linux.md).
-
-## Command Palette
-
-The Command Palette is the main way to access pretty much any functionality that's available in Zed. Its keybinding is the first one you should make yourself familiar with. To open it, hit: {#kb command_palette::Toggle}.
-
-
-
-Try it! Open the Command Palette and type in `new file`. You should see the list of commands being filtered down to `workspace: new file`. Hit return and you end up with a new buffer.
-
-Any time you see instructions that include commands of the form `zed: ...` or `editor: ...` and so on that means you need to execute them in the Command Palette.
-
-## CLI
-
-Zed has a CLI, on Linux this should come with the distribution's Zed package (binary name can vary from distribution to distribution, `zed` will be used later for brevity).
-For macOS, the CLI comes in the same package with the editor binary, and could be installed into the system with the `cli: install` Zed command which will create a symlink to the `/usr/local/bin/zed`.
-It can also be built from source out of the `cli` crate in this repository.
-
-Use `zed --help` to see the full list of capabilities.
-General highlights:
-
-- Opening another empty Zed window: `zed`
-
-- Opening a file or directory in Zed: `zed /path/to/entry` (use `-n` to open in the new window)
-
-- Reading from stdin: `ps axf | zed -`
-
-- Starting Zed with logs in the terminal: `zed --foreground`
-
-- Uninstalling Zed and all its related files: `zed --uninstall`
-
-## Configure Zed
-
-To make Zed feel more like home, you can use the {#kb zed::OpenSettings} keybinding to open the settings window.
-In there, you can browse through many of the customization points, including common ones like formatting settings, fonts, per-language settings, and many more.
-
-Note that, however, some settings can't yet be changed through the settings window and can only be set through the JSON file, which you can access through the {#kb zed::OpenSettingsFile} keybinding.
-
-You can also check all supported settings in the [Configuring Zed](./configuring-zed.md) documentation.
-
-## Configure AI in Zed
-
-Zed smoothly integrates LLMs in multiple ways across the editor.
-Visit [the AI overview page](./ai/overview.md) to learn how to quickly get started with LLMs on Zed.
-
-## Set up your key bindings
-
-To edit your custom keymap and add or remap bindings, you can either use {#kb zed::OpenKeymap} to spawn the Zed Keymap Editor ({#action zed::OpenKeymap}) or you can directly open your Zed Keymap json (`~/.config/zed/keymap.json`) with {#action zed::OpenKeymap}.
-
-To access the default key binding set, open the Command Palette with {#kb command_palette::Toggle} and search for "zed: open default keymap". See [Key Bindings](./key-bindings.md) for more info.
+- [Join Discord](https://discord.com/invite/zedindustries)
+- [GitHub Discussions](https://github.com/zed-industries/zed/discussions)
+- [Zed Reddit](https://www.reddit.com/r/ZedEditor)
@@ -1,6 +1,48 @@
-# System Requirements
+# Installing Zed
-## Apple
+## Download Zed
+
+### macOS
+
+Get the latest stable builds via [the download page](https://zed.dev/download). If you want to download our preview build, you can find it on its [releases page](https://zed.dev/releases/preview). After the first manual installation, Zed will periodically check for install updates.
+
+You can also install Zed stable via Homebrew:
+
+```sh
+brew install --cask zed
+```
+
+As well as Zed preview:
+
+```sh
+brew install --cask zed@preview
+```
+
+### Windows
+
+Get the latest stable builds via [the download page](https://zed.dev/download). If you want to download our preview build, you can find it on its [releases page](https://zed.dev/releases/preview). After the first manual installation, Zed will periodically check for install updates.
+
+### Linux
+
+For most Linux users, the easiest way to install Zed is through our installation script:
+
+```sh
+curl -f https://zed.dev/install.sh | sh
+```
+
+If you'd like to help us test our new features, you can also install our preview build:
+
+```sh
+curl -f https://zed.dev/install.sh | ZED_CHANNEL=preview sh
+```
+
+This script supports `x86_64` and `AArch64`, as well as common Linux distributions: Ubuntu, Arch, Debian, RedHat, CentOS, Fedora, and more.
+
+If Zed is installed using this installation script, it can be uninstalled at any time by running the shell command `zed --uninstall`. The shell will then prompt you whether you'd like to keep your preferences or delete them. After making a choice, you should see a message that Zed was successfully uninstalled.
+
+If this script is insufficient for your use case, you run into problems running Zed, or there are errors in uninstalling Zed, please see our [Linux-specific documentation](./linux.md).
+
+## System Requirements
### macOS
@@ -17,7 +59,7 @@ Zed supports the follow macOS releases:
The macOS releases labelled "Partially Supported" (Big Sur and Catalina) do not support screen sharing via Zed Collaboration. These features use the [LiveKit SDK](https://livekit.io) which relies upon [ScreenCaptureKit.framework](https://developer.apple.com/documentation/screencapturekit/) only available on macOS 12 (Monterey) and newer.
-### Mac Hardware
+**Mac Hardware**
Zed supports machines with Intel (x86_64) or Apple (aarch64) processors that meet the above macOS requirements:
@@ -30,7 +72,7 @@ Zed supports machines with Intel (x86_64) or Apple (aarch64) processors that mee
- iMac Pro (all models)
- Mac Studio (all models)
-## Linux
+### Linux
Zed supports 64bit Intel/AMD (x86_64) and 64Bit ARM (aarch64) processors.
@@ -40,7 +82,7 @@ Zed requires a Vulkan 1.3 driver, and the following desktop portals:
- `org.freedesktop.portal.OpenURI`
- `org.freedesktop.portal.Secret`, or `org.freedesktop.Secrets`
-## Windows
+### Windows
Zed supports the follow Windows releases:
| Version | Microsoft Status | Zed Status |
@@ -48,7 +90,7 @@ Zed supports the follow Windows releases:
| Windows 11 (all releases) | Supported | Supported |
| Windows 10 (64-bit) | Supported | Supported |
-### Windows Hardware
+**Windows Hardware**
Zed supports machines with Intel or AMD 64-bit (x86_64) processors that meet the above Windows requirements:
@@ -57,10 +99,10 @@ Zed supports machines with Intel or AMD 64-bit (x86_64) processors that meet the
- Graphics: A GPU that supports DirectX 11 (most PCs from 2012+).
- Driver: Current NVIDIA/AMD/Intel driver (not the Microsoft Basic Display Adapter).
-## FreeBSD
+### FreeBSD
Not yet available as an official download. Can be built [from source](./development/freebsd.md).
-## Web
+### Web
Not supported at this time. See our [Platform Support issue](https://github.com/zed-industries/zed/issues/5391).
@@ -0,0 +1 @@
+# Quick Start
@@ -29,7 +29,7 @@ The remote machine must be able to run Zed's server. The following platforms sho
- macOS Catalina or later (Intel or Apple Silicon)
- Linux (x86_64 or arm64, we do not yet support 32-bit platforms)
-- Windows is not yet supported.
+- Windows is not yet supported as a remote server, but Windows can be used as a local machine to connect to remote servers.
## Configuration
@@ -87,6 +87,28 @@ If you use the command line to open a connection to a host by doing `zed ssh://1
Additionally it's worth noting that while you can pass a password on the command line `zed ssh://user:password@host/~`, we do not support writing a password to your settings file. If you're connecting repeatedly to the same host, you should configure key-based authentication.
+## Remote Development on Windows (SSH)
+
+Zed on Windows supports SSH remoting and will prompt for credentials when needed.
+
+If you encounter authentication issues, confirm that your SSH key agent is running (e.g., ssh-agent or your Git client's agent) and that ssh.exe is on PATH.
+
+### Troubleshooting SSH on Windows
+
+When prompted for credentials, use the graphical askpass dialog. If it doesn't appear, check for credential manager conflicts and that GUI prompts aren't blocked by your terminal.
+
+## WSL Support
+
+Zed supports opening folders inside of WSL natively on Windows.
+
+### Opening a local folder in WSL
+
+To open a local folder inside a WSL container, use the `projects: open in wsl` action and select the folder you want to open. You will be presented with a list of available WSL distributions to open the folder in.
+
+### Opening a folder already in WSL
+
+To open a folder that's already located inside of a WSL container, use the `projects: open wsl` action and select the WSL distribution. The distribution will be added to the `Remote Projects` window where you will be able to open the folder.
+
## Port forwarding
If you'd like to be able to connect to ports on your remote server from your local machine, you can configure port forwarding in your settings file. This is particularly useful for developing websites so you can load the site in your browser while working.
@@ -0,0 +1,113 @@
+# Uninstall
+
+This guide covers how to uninstall Zed on different operating systems.
+
+## macOS
+
+### Standard Installation
+
+If you installed Zed by downloading it from the website:
+
+1. Quit Zed if it's running
+2. Open Finder and go to your Applications folder
+3. Drag Zed to the Trash (or right-click and select "Move to Trash")
+4. Empty the Trash
+
+### Homebrew Installation
+
+If you installed Zed using Homebrew, use the following command:
+
+```sh
+brew uninstall --cask zed
+```
+
+Or for the preview version:
+
+```sh
+brew uninstall --cask zed@preview
+```
+
+### Removing User Data (Optional)
+
+To completely remove all Zed configuration files and data:
+
+1. Open Finder
+2. Press `Cmd + Shift + G` to open "Go to Folder"
+3. Delete the following directories if they exist:
+ - `~/Library/Application Support/Zed`
+ - `~/Library/Saved Application State/dev.zed.Zed.savedState`
+ - `~/Library/Logs/Zed`
+ - `~/Library/Caches/dev.zed.Zed`
+
+## Linux
+
+### Standard Uninstall
+
+If Zed was installed using the default installation script, run:
+
+```sh
+zed --uninstall
+```
+
+You'll be prompted whether to keep or delete your preferences. After making a choice, you should see a message that Zed was successfully uninstalled.
+
+If the `zed` command is not found in your PATH, try:
+
+```sh
+$HOME/.local/bin/zed --uninstall
+```
+
+or:
+
+```sh
+$HOME/.local/zed.app/bin/zed --uninstall
+```
+
+### Package Manager
+
+If you installed Zed using a package manager (such as Flatpak, Snap, or a distribution-specific package manager), consult that package manager's documentation for uninstallation instructions.
+
+### Manual Removal
+
+If the uninstall command fails or Zed was installed to a custom location, you can manually remove:
+
+- Installation directory: `~/.local/zed.app` (or your custom installation path)
+- Binary symlink: `~/.local/bin/zed`
+- Configuration and data: `~/.config/zed`
+
+## Windows
+
+### Standard Installation
+
+1. Quit Zed if it's running
+2. Open Settings (Windows key + I)
+3. Go to "Apps" > "Installed apps" (or "Apps & features" on Windows 10)
+4. Search for "Zed"
+5. Click the three dots menu next to Zed and select "Uninstall"
+6. Follow the prompts to complete the uninstallation
+
+Alternatively, you can:
+
+1. Open the Start menu
+2. Right-click on Zed
+3. Select "Uninstall"
+
+### Removing User Data (Optional)
+
+To completely remove all Zed configuration files and data:
+
+1. Press `Windows key + R` to open Run
+2. Type `%APPDATA%` and press Enter
+3. Delete the `Zed` folder if it exists
+4. Press `Windows key + R` again, type `%LOCALAPPDATA%` and press Enter
+5. Delete the `Zed` folder if it exists
+
+## Troubleshooting
+
+If you encounter issues during uninstallation:
+
+- **macOS/Windows**: Ensure Zed is completely quit before attempting to uninstall. Check Activity Manager (macOS) or Task Manager (Windows) for any running Zed processes.
+- **Linux**: If the uninstall script fails, check the error message and consider manual removal of the directories listed above.
+- **All platforms**: If you want to start fresh while keeping Zed installed, you can delete the configuration directories instead of uninstalling the application entirely.
+
+For additional help, see our [Linux-specific documentation](./linux.md) or visit the [Zed community](https://zed.dev/community).
@@ -0,0 +1,21 @@
+# Update Zed
+
+Zed is designed to keep itself up to date automatically. You can always update this behavior in your settings.
+
+## Auto-updates
+
+By default, Zed checks for updates and installs them automatically the next time you restart the app. You’ll always be running the latest version with no extra steps.
+
+If an update is available, Zed will download it in the background and apply it on restart.
+
+## How to check your current version
+
+To check which version of Zed you're using:
+
+Open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Linux/Windows).
+
+Type and select `zed: about`. A modal will appear with your version information.
+
+## How to control update behavior
+
+If you want to turn off auto-updates, open the Settings Editor (Cmd ,) and find `Auto Update` under General Settings.
@@ -15,17 +15,9 @@ Your settings and extensions live in your user profile. When uninstalling, you c
## Remote Development (SSH)
-Zed supports SSH remoting on Windows and will prompt for credentials when needed.
+Zed supports remote development on Windows through both SSH and WSL. You can connect to remote servers via SSH or work with files inside WSL distributions directly from Zed.
-If you encounter authentication issues, confirm that your SSH key agent is running (e.g., ssh-agent or your Git client’s agent) and that ssh.exe is on PATH.
-
-## WSL Support
-
-Zed supports opening folders inside of WSL natively.
-
-To open a local folder inside a WSL container use the `projects: open in wsl` action and select the folder you want to open, after which you will be presented with a list of available WSL distributions to open the folder in.
-
-To open a folder that's already located inside of a WSL container use the `projects: open wsl` action and select the WSL distribution, after which you the distro will be added to the `Remote Projects` window where you will be able to open the folder, see [Remote Development](./remote-development.md)
+For detailed instructions on setting up and using remote development features, including SSH configuration, WSL setup, and troubleshooting, see the [Remote Development documentation](./remote-development.md).
## Troubleshooting