-
Notifications
You must be signed in to change notification settings - Fork 928
docs: add new cursor and windsurf docs #17092
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
11 commits
Select commit
Hold shift + click to select a range
48b60bd
draft cursor doc
EdwardAngert 1abc2b6
Update docs/user-guides/workspace-access/windsurf.md
EdwardAngert 86d39b8
windsurf doc
EdwardAngert 9acc1b9
expand cursor w coder extension
EdwardAngert e95fc3b
complete windsurf; edit cursor steps
EdwardAngert 139d64b
remove cli steps; add cursor/windsurf sections
EdwardAngert 2fd804e
Apply suggestions from code review
EdwardAngert 5b8f2ce
make lint/fmt
EdwardAngert d5eeff8
coder ext in marketplace
EdwardAngert 8427d47
add extension screenshot
EdwardAngert 22a5c0b
Merge branch 'main' into 16919-cursor-windsurf
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,62 @@ | ||
# Cursor | ||
|
||
[Cursor](https://cursor.sh/) is a modern IDE built on top of VS Code with enhanced AI capabilities. | ||
|
||
Follow this guide to use Cursor to access your Coder workspaces. | ||
|
||
If your team uses Cursor regularly, ask your Coder administrator to add a [Cursor module](https://registry.coder.com/modules/cursor) to your template. | ||
|
||
## Install Cursor | ||
|
||
Cursor can connect to a Coder workspace using the Coder extension: | ||
|
||
1. [Install Cursor](https://docs.cursor.com/get-started/installation) on your local machine. | ||
|
||
1. Open Cursor and log in or [create a Cursor account](https://authenticator.cursor.sh/sign-up) | ||
if you don't have one already. | ||
|
||
## Install the Coder extension | ||
|
||
1. You can install the Coder extension through the Marketplace built in to Cursor or manually. | ||
|
||
<div class="tabs"> | ||
|
||
## Extension Marketplace | ||
|
||
1. Search for Coder from the Extensions Pane and select **Install**. | ||
|
||
1. Coder Remote uses the **Remote - SSH extension** to connect. | ||
|
||
You can find it in the **Extension Pack** tab of the Coder extension. | ||
|
||
## Manually | ||
|
||
1. Download the [latest vscode-coder extension](https://github.com/coder/vscode-coder/releases/latest) `.vsix` file. | ||
|
||
1. Drag the `.vsix` file into the extensions pane of Cursor. | ||
|
||
Alternatively: | ||
|
||
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`. | ||
|
||
1. Select **Extensions: Install from VSIX** and select the vscode-coder extension you downloaded. | ||
|
||
</div> | ||
|
||
1. Coder Remote uses the **Remote - SSH extension** to connect. | ||
|
||
You can find it in the **Extension Pack** tab of the Coder extension. | ||
|
||
## Open a workspace in Cursor | ||
|
||
1. From the Cursor Command Palette | ||
(<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>), | ||
enter `coder` and select **Coder: Login**. | ||
|
||
1. Follow the prompts to login and copy your session token. | ||
|
||
Paste the session token in the **Paste your API key** box in Cursor. | ||
|
||
1. Select **Open Workspace** or use the Command Palette to run **Coder: Open Workspace**. |
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,61 @@ | ||
# Windsurf | ||
|
||
[Windsurf](https://codeium.com/windsurf) is Codeium's code editor designed for AI-assisted | ||
development. | ||
|
||
Follow this guide to use Windsurf to access your Coder workspaces. | ||
|
||
If your team uses Windsurf regularly, ask your Coder administrator to add Windsurf as a workspace application in your template. | ||
|
||
## Install Windsurf | ||
|
||
Windsurf can connect to your Coder workspaces via SSH: | ||
|
||
1. [Install Windsurf](https://docs.codeium.com/windsurf/getting-started) on your local machine. | ||
|
||
1. Open Windsurf and select **Get started**. | ||
|
||
Import your settings from another IDE, or select **Start fresh**. | ||
|
||
1. Complete the setup flow and log in or [create a Codeium account](https://codeium.com/windsurf/signup) | ||
if you don't have one already. | ||
|
||
## Install the Coder extension | ||
|
||
 | ||
|
||
1. You can install the Coder extension through the Marketplace built in to Windsurf or manually. | ||
|
||
<div class="tabs"> | ||
|
||
## Extension Marketplace | ||
|
||
1. Search for Coder from the Extensions Pane and select **Install**. | ||
|
||
## Manually | ||
|
||
1. Download the [latest vscode-coder extension](https://github.com/coder/vscode-coder/releases/latest) `.vsix` file. | ||
|
||
1. Drag the `.vsix` file into the extensions pane of Windsurf. | ||
|
||
Alternatively: | ||
|
||
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`. | ||
|
||
1. Select **Extensions: Install from VSIX** and select the vscode-coder extension you downloaded. | ||
|
||
</div> | ||
|
||
## Open a workspace in Windsurf | ||
|
||
1. From the Windsurf Command Palette | ||
(<kdb>Ctrl</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb> or <kdb>Cmd</kdb>+<kdb>Shift</kdb>+<kdb>P</kdb>), | ||
enter `coder` and select **Coder: Login**. | ||
|
||
1. Follow the prompts to login and copy your session token. | ||
|
||
Paste the session token in the **Coder API Key** dialogue in Windsurf. | ||
|
||
1. Windsurf prompts you to open a workspace, or you can use the Command Palette to run **Coder: Open Workspace**. |
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.
Uh oh!
There was an error while loading. Please reload this page.