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.

Sign up for GitHub

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

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
96a24b6
add zed doc to workspace-access
EdwardAngert Jan 23, 2025
5c21309
Merge remote-tracking branch 'origin/main' into 366-zed
EdwardAngert Jan 24, 2025
332dba0
adjust steps and add screenshot
EdwardAngert Jan 24, 2025
12fdb5c
h3 install tab headings
EdwardAngert Jan 24, 2025
108cf07
fix windows-installer.png link
EdwardAngert Jan 24, 2025
d9c5686
fix typo
EdwardAngert Jan 24, 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
5 changes: 5 additions & 0 deletions docs/manifest.json
View file
Open in desktop
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
36 changes: 36 additions & 0 deletions docs/user-guides/workspace-access/zed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 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:

```shell
curl -L https://coder.com/install.sh | sh
```

1. Log in and configure Coder SSH:

```shell
coder login coder.example.com
coder config-ssh
```

1. Connect via SSH with the Host set to `coder.workspace-name`:

<!-- screenshot placeholder
![Fleet Connect to Coder](../../images/fleet/ssh-connect-to-coder.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