Skip to content

Commit 037dbc8

Browse files
docs: add new cursor and windsurf docs (#17092)
closes #16919 - [x] cursor doc - [x] windsurf doc from #16919 (comment): - add to access-workspace - link to module(s) - how to windsurf with ssh - temp: install vsix manually (Windsurf) - from <https://github.com/coder/vscode-coder> - log in first - search extensions for Coder - ask your admin to add a module: https://registry.coder.com/modules/cursor --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: M Atif Ali <atif@coder.com>
1 parent fcac4ab commit 037dbc8

File tree

5 files changed

+145
-0
lines changed

5 files changed

+145
-0
lines changed
Loading

docs/manifest.json

+10
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
},
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Cursor
2+
3+
[Cursor](https://cursor.sh/) is a modern IDE built on top of VS Code with enhanced AI capabilities.
4+
5+
Follow this guide to use Cursor to access your Coder workspaces.
6+
7+
If your team uses Cursor regularly, ask your Coder administrator to add a [Cursor module](https://registry.coder.com/modules/cursor) to your template.
8+
9+
## Install Cursor
10+
11+
Cursor can connect to a Coder workspace using the Coder extension:
12+
13+
1. [Install Cursor](https://docs.cursor.com/get-started/installation) on your local machine.
14+
15+
1. Open Cursor and log in or [create a Cursor account](https://authenticator.cursor.sh/sign-up)
16+
if you don't have one already.
17+
18+
## Install the Coder extension
19+
20+
1. You can install the Coder extension through the Marketplace built in to Cursor or manually.
21+
22+
<div class="tabs">
23+
24+
## Extension Marketplace
25+
26+
1. Search for Coder from the Extensions Pane and select **Install**.
27+
28+
1. Coder Remote uses the **Remote - SSH extension** to connect.
29+
30+
You can find it in the **Extension Pack** tab of the Coder extension.
31+
32+
## Manually
33+
34+
1. Download the [latest vscode-coder extension](https://github.com/coder/vscode-coder/releases/latest) `.vsix` file.
35+
36+
1. Drag the `.vsix` file into the extensions pane of Cursor.
37+
38+
Alternatively:
39+
40+
1. Open the Command Palette
41+
(<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>)
42+
and search for `vsix`.
43+
44+
1. Select **Extensions: Install from VSIX** and select the vscode-coder extension you downloaded.
45+
46+
</div>
47+
48+
1. Coder Remote uses the **Remote - SSH extension** to connect.
49+
50+
You can find it in the **Extension Pack** tab of the Coder extension.
51+
52+
## Open a workspace in Cursor
53+
54+
1. From the Cursor Command Palette
55+
(<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>),
56+
enter `coder` and select **Coder: Login**.
57+
58+
1. Follow the prompts to login and copy your session token.
59+
60+
Paste the session token in the **Paste your API key** box in Cursor.
61+
62+
1. Select **Open Workspace** or use the Command Palette to run **Coder: Open Workspace**.

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

+12
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,18 @@ 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 the Coder extension.
87+
88+
Read more about [using Cursor with your workspace](./cursor.md).
89+
90+
## Windsurf
91+
92+
[Windsurf](./windsurf.md) is Codeium's code editor designed for AI-assisted development.
93+
Windsurf connects using the Coder extension.
94+
8395
## JetBrains IDEs
8496

8597
We support JetBrains IDEs using
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Windsurf
2+
3+
[Windsurf](https://codeium.com/windsurf) is Codeium's code editor designed for AI-assisted
4+
development.
5+
6+
Follow this guide to use Windsurf to access your Coder workspaces.
7+
8+
If your team uses Windsurf regularly, ask your Coder administrator to add Windsurf as a workspace application in your template.
9+
10+
## Install Windsurf
11+
12+
Windsurf can connect to your Coder workspaces via SSH:
13+
14+
1. [Install Windsurf](https://docs.codeium.com/windsurf/getting-started) on your local machine.
15+
16+
1. Open Windsurf and select **Get started**.
17+
18+
Import your settings from another IDE, or select **Start fresh**.
19+
20+
1. Complete the setup flow and log in or [create a Codeium account](https://codeium.com/windsurf/signup)
21+
if you don't have one already.
22+
23+
## Install the Coder extension
24+
25+
![Coder extension in Windsurf](../../images/user-guides/ides/windsurf-coder-extension.png)
26+
27+
1. You can install the Coder extension through the Marketplace built in to Windsurf or manually.
28+
29+
<div class="tabs">
30+
31+
## Extension Marketplace
32+
33+
1. Search for Coder from the Extensions Pane and select **Install**.
34+
35+
## Manually
36+
37+
1. Download the [latest vscode-coder extension](https://github.com/coder/vscode-coder/releases/latest) `.vsix` file.
38+
39+
1. Drag the `.vsix` file into the extensions pane of Windsurf.
40+
41+
Alternatively:
42+
43+
1. Open the Command Palette
44+
(<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>)
45+
and search for `vsix`.
46+
47+
1. Select **Extensions: Install from VSIX** and select the vscode-coder extension you downloaded.
48+
49+
</div>
50+
51+
## Open a workspace in Windsurf
52+
53+
1. From the Windsurf Command Palette
54+
(<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>),
55+
enter `coder` and select **Coder: Login**.
56+
57+
1. Follow the prompts to login and copy your session token.
58+
59+
Paste the session token in the **Coder API Key** dialogue in Windsurf.
60+
61+
1. Windsurf prompts you to open a workspace, or you can use the Command Palette to run **Coder: Open Workspace**.

0 commit comments

Comments
 (0)