Skip to content

Commit 48b60bd

Browse files
EdwardAngertEdwardAngert
committed
draft cursor doc
1 parent e8d5f98 commit 48b60bd

File tree

4 files changed

+109
-0
lines changed

4 files changed

+109
-0
lines changed

‎docs/manifest.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,16 @@
166166
"title": "Zed",
167167
"description": "Access your workspace with Zed",
168168
"path": "./user-guides/workspace-access/zed.md"
169+
},
170+
{
171+
"title": "Cursor",
172+
"description": "Access your workspace with Cursor",
173+
"path": "./user-guides/workspace-access/cursor.md"
174+
},
175+
{
176+
"title": "Windsurf",
177+
"description": "Access your workspace with Windsurf",
178+
"path": "./user-guides/workspace-access/windsurf.md"
169179
}
170180
]
171181
},

‎docs/user-guides/workspace-access/cursor.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Cursor
2+
3+
[Cursor](https://cursor.sh/) is a modern IDE built on top of VS Code with enhanced AI capabilities.
4+
5+
## Connect to Coder via SSH
6+
7+
Cursor can connect to a Coder workspace using SSH:
8+
9+
1. [Install Cursor](https://cursor.sh/) on your local machine
10+
1. Install the Coder CLI:
11+
12+
<!-- copied from docs/install/cli.md - make changes there -->
13+
14+
<div class="tabs">
15+
16+
### Linux/macOS
17+
18+
Our install script is the fastest way to install Coder on Linux/macOS:
19+
20+
```sh
21+
curl -L https://coder.com/install.sh | sh
22+
```
23+
24+
Refer to [GitHub releases](https://github.com/coder/coder/releases) for
25+
alternate installation methods (e.g. standalone binaries, system packages).
26+
27+
### Windows
28+
29+
Use [GitHub releases](https://github.com/coder/coder/releases) to download the
30+
Windows installer (`.msi`) or standalone binary (`.exe`).
31+
32+
![Windows setup wizard](../../images/install/windows-installer.png)
33+
34+
Alternatively, you can use the
35+
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
36+
package manager to install Coder:
37+
38+
```powershell
39+
winget install Coder.Coder
40+
```
41+
42+
</div>
43+
44+
Consult the [Coder CLI documentation](../../install/cli.md) for more options.
45+
46+
1. Log in to your Coder deployment and authenticate when prompted:
47+
48+
```shell
49+
coder login coder.example.com
50+
```
51+
52+
1. Configure Coder SSH:
53+
54+
```shell
55+
coder config-ssh
56+
```
57+
58+
1. List your available workspaces:
59+
60+
```shell
61+
coder list
62+
```
63+
64+
1. Open Cursor
65+
66+
1. Download [Open Remote - SSH](https://open-vsx.org/extension/jeanp413/open-remote-ssh).
67+
68+
1. Download the [latest vscode-coder extension](https://github.com/coder/vscode-coder/releases/latest).
69+
70+
1. Open the Command Palette (<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>) and search for `vsix`.
71+
72+
1. Select **Extensions: Install from VSIX** and select the extensions you downloaded.
73+
74+
1. Select **Connect via SSH** and enter the workspace name as `coder.workspace-name`.
75+
76+
1. After you connect, select **Open Folder** and you can start working on your files.
77+
78+
> [!NOTE]
79+
> If you have any suggestions or experience any issues, please
80+
> [create a GitHub issue](https://github.com/coder/coder/issues/new?title=docs%3A+cursor+request+title+here&labels=["customer-reported","docs"]&body=please+enter+your+request+here) or share in
81+
> [our Discord channel](https://discord.gg/coder).

‎docs/user-guides/workspace-access/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ desktop client and VSCode in the browser with [code-server](#code-server).
8080

8181
Read more details on [using VSCode in your workspace](./vscode.md).
8282

83+
## Cursor
84+
85+
[Cursor](https://cursor.sh/) is an IDE built on VS Code with enhanced AI capabilities.
86+
Cursor connects using SSH and provides AI-assisted development features.
87+
88+
Read more about [using Cursor with your workspace](./cursor.md).
89+
8390
## JetBrains IDEs
8491

8592
We support JetBrains IDEs using
@@ -94,6 +101,7 @@ IDEs are supported for remote development:
94101
- RubyMine
95102
- WebStorm
96103
- [JetBrains Fleet](./jetbrains.md#jetbrains-fleet)
104+
- [Windsurf](./windsurf.md)
97105

98106
Read our [docs on JetBrains Gateway](./jetbrains.md) for more information on
99107
connecting your JetBrains IDEs.
@@ -119,6 +127,8 @@ Supported IDEs:
119127
- RStudio
120128
- Airflow
121129
- File Browser
130+
- [Cursor](./cursor.md)
131+
- [Windsurf](./windsurf.md)
122132

123133
Our [Module Registry](https://registry.coder.com/modules) also hosts a variety
124134
of tools for extending the capability of your workspace. If you have a request

‎docs/user-guides/workspace-access/windsurf.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Windsurf
2+
3+
[Windsurf](https://www.jetbrains.com/windsurf/) is JetBrains and Codeium's collaborative code editor designed for AI-powered development. It combines JetBrains's IDE technology with Codeium's AI capabilities in a lightweight, browser-first experience.
4+
5+
> [!NOTE]
6+
> If you have any suggestions or experience any issues, please
7+
> [create a GitHub issue](https://github.com/coder/coder/issues) or share in
8+
> [our Discord channel](https://discord.gg/coder).

0 commit comments

Comments
 (0)