Skip to content

docs: add zed editor doc to workspace-access #16242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/images/zed/zed-ssh-open-remote.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
},
Expand Down
80 changes: 80 additions & 0 deletions docs/user-guides/workspace-access/zed.md
Original file line number Diff line number Diff line change
@@ -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:

<!-- copied from docs/install/cli.md - make changes there -->

<div class="tabs">

### 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove this section. It's only needed for running coder server. Sorry for not noticing it early.

I can drop a Follow up.

> 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
```

</div>

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)

<blockquote class="admonition note">

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).

</blockquote>
Loading