Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
7b299c1
Update table of contents for getting started. Add new installation page.
katie-z-geer Oct 20, 2025
16242ef
Updates to get-started. Remove /system-reqs page because it's now within
katie-z-geer Oct 20, 2025
3e184a3
Remove extra sections here
katie-z-geer Oct 20, 2025
d94a5ff
Move CLI and command palette sections into Using Zed
katie-z-geer Oct 28, 2025
aaee4eb
Add detail to update section
katie-z-geer Oct 28, 2025
a18c989
Finish update section
katie-z-geer Oct 28, 2025
06f8699
Move remote dev section from windows.md to remote development.md.
katie-z-geer Oct 28, 2025
f13e460
Small updates to authenticate
katie-z-geer Oct 28, 2025
daf3e25
Add uninstall, removed quick start
katie-z-geer Oct 28, 2025
3fdef8b
Add uninstall
katie-z-geer Oct 28, 2025
164890a
Incorporate settings updates from Danilo
katie-z-geer Oct 28, 2025
90f46f6
Keybinding updates
katie-z-geer Oct 28, 2025
06304e0
Merge branch 'main' into docs-intro-reorganize
katie-z-geer Oct 28, 2025
3d52e83
Update path references to /accounts.md to be to /authentication.md
katie-z-geer Oct 28, 2025
bf4b0e9
fomat
katie-z-geer Oct 28, 2025
03fc272
Merge branch 'docs-intro-reorganize' of https://github.com/zed-indust…
katie-z-geer Oct 28, 2025
d225b46
undo random file change
katie-z-geer Oct 28, 2025
e3a7268
Remove addl learning materials from nav
katie-z-geer Oct 28, 2025
0b683b3
light nav update
katie-z-geer Oct 28, 2025
a9e11a1
format
katie-z-geer Oct 28, 2025
0d3509c
url update in edit-prediction
katie-z-geer Oct 28, 2025
0083aab
fix links in new getting-started
katie-z-geer Oct 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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)
Expand All @@ -43,6 +44,11 @@
- [Environment Variables](./environment.md)
- [REPL](./repl.md)

# Platform Support

- [Windows](./windows.md)
- [Linux](./linux.md)

# AI

- [Overview](./ai/overview.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/ai/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/ai/edit-prediction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/ai/plans-and-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
2 changes: 1 addition & 1 deletion docs/src/ai/privacy-and-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/src/accounts.md → docs/src/authentication.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
18 changes: 18 additions & 0 deletions docs/src/command-line-interface.md
Original file line number Diff line number Diff line change
@@ -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`
9 changes: 9 additions & 0 deletions docs/src/command-palette.md
Original file line number Diff line number Diff line change
@@ -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}.

![The opened Command Palette](https://zed.dev/img/features/command-palette.jpg)

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.
18 changes: 8 additions & 10 deletions docs/src/configuring-zed.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
99 changes: 12 additions & 87 deletions docs/src/getting-started.md
Original file line number Diff line number Diff line change
@@ -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}.

![The opened Command Palette](https://zed.dev/img/features/command-palette.jpg)

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)
58 changes: 50 additions & 8 deletions docs/src/system-requirements.md → docs/src/installation.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:

Expand All @@ -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.

Expand All @@ -40,15 +82,15 @@ 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 |
| ------------------------- | ------------------ | ------------------- |
| 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:

Expand All @@ -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).
1 change: 1 addition & 0 deletions docs/src/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Quick Start
Loading