Skip to content

docs: add zed as coder_app to open from workspace with a hotlink #17236

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 4 commits into from
Apr 7, 2025
Merged
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
13 changes: 13 additions & 0 deletions docs/user-guides/workspace-access/zed.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,19 @@ Use the Coder CLI to log in and configure SSH, then connect to your workspace wi
zed ssh://coder.workspace-name
```

1. Connect via a coder_app workspace icon and SSH hotlink:

```hcl
resource "coder_app" "zed" {
agent_id = coder_agent.main.id
slug = "slug"
display_name = "Zed"
external = true
url = "zed://ssh/coder.${data.coder_workspace.me.name}"
icon = "/icon/zed.svg"
}
```
Comment on lines +65 to +76
Copy link
Member

@matifali matifali Apr 6, 2025

Choose a reason for hiding this comment

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

As this is terraform code, it should go somewhere into the https://coder.com/docs/admin/templates/extending-templates section. User guides are for developers with member roles who may not have template admin roles to actually add something to a template.

Copy link
Contributor

Choose a reason for hiding this comment

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

good call, @matifali - I'll take care of that


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)
Expand Down