diff --git a/docs/images/zed/zed-ssh-open-remote.png b/docs/images/zed/zed-ssh-open-remote.png new file mode 100644 index 0000000000000..08b2f59e19e93 Binary files /dev/null and b/docs/images/zed/zed-ssh-open-remote.png differ diff --git a/docs/manifest.json b/docs/manifest.json index a21d7583cc357..a596cbd6e5409 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -150,6 +150,11 @@ "title": "Web IDEs and Coder Apps", "description": "Access your workspace with IDEs in the browser", "path": "./user-guides/workspace-access/web-ides.md" + }, + { + "title": "Zed", + "description": "Access your workspace with Zed", + "path": "./user-guides/workspace-access/zed.md" } ] }, diff --git a/docs/user-guides/workspace-access/zed.md b/docs/user-guides/workspace-access/zed.md new file mode 100644 index 0000000000000..14a02e08a611f --- /dev/null +++ b/docs/user-guides/workspace-access/zed.md @@ -0,0 +1,80 @@ +# Zed + +[Zed](https://zed.dev/) is an [open-source](https://github.com/zed-industries/zed) +multiplayer code editor from the creators of Atom and Tree-sitter. + +## Use Zed to connect to Coder via SSH + +Use the Coder CLI to log in and configure SSH, then connect to your workspace with Zed: + +1. [Install Zed](https://zed.dev/docs/) +1. Install Coder CLI: + + + +
+ + ### Linux/macOS + + Our install script is the fastest way to install Coder on Linux/macOS: + + ```sh + curl -L https://coder.com/install.sh | sh + ``` + + Refer to [GitHub releases](https://github.com/coder/coder/releases) for + alternate installation methods (e.g. standalone binaries, system packages). + + ### Windows + + > **Important:** If you plan to use the built-in PostgreSQL database, you will + > need to ensure that the + > [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) + > is installed. + + Use [GitHub releases](https://github.com/coder/coder/releases) to download the + Windows installer (`.msi`) or standalone binary (`.exe`). + + ![Windows setup wizard](../../images/install/windows-installer.png) + + Alternatively, you can use the + [`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget) + package manager to install Coder: + + ```powershell + winget install Coder.Coder + ``` + +
+ + Consult the [Coder CLI documentation](../../install/cli.md) for more options. + +1. Log in to your Coder deployment and authenticate when prompted: + + ```shell + coder login coder.example.com + ``` + +1. Configure Coder SSH: + + ```shell + coder config-ssh + ``` + +1. Connect to the workspace via SSH: + + ```shell + zed ssh://coder.workspace-name + ``` + + Or use Zed's [Remote Development](https://zed.dev/docs/remote-development#setup) to connect to the workspace: + + ![Zed open remote project](../../images/zed/zed-ssh-open-remote.png) + +
+ +If you have any suggestions or experience any issues, please +[create a GitHub issue](https://github.com/coder/coder/issues) or share in +[our Discord channel](https://discord.gg/coder). + +