-
Notifications
You must be signed in to change notification settings - Fork 877
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
96a24b6
add zed doc to workspace-access
EdwardAngert 5c21309
Merge remote-tracking branch 'origin/main' into 366-zed
EdwardAngert 332dba0
adjust steps and add screenshot
EdwardAngert 12fdb5c
h3 install tab headings
EdwardAngert 108cf07
fix windows-installer.png link
EdwardAngert d9c5686
fix typo
EdwardAngert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
> 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`). | ||
|
||
 | ||
|
||
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: | ||
|
||
 | ||
|
||
<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> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.