Skip to content

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 11 commits into from
Apr 1, 2025
10 changes: 10 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,16 @@
"title": "Zed",
"description": "Access your workspace with Zed",
"path": "./user-guides/workspace-access/zed.md"
},
{
"title": "Cursor",
"description": "Access your workspace with Cursor",
"path": "./user-guides/workspace-access/cursor.md"
},
{
"title": "Windsurf",
"description": "Access your workspace with Windsurf",
"path": "./user-guides/workspace-access/windsurf.md"
}
]
},
Expand Down
67 changes: 67 additions & 0 deletions docs/user-guides/workspace-access/cursor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# 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**.

> [!NOTE]
> If you have any suggestions or experience any issues, please
> [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
> [our Discord channel](https://discord.gg/coder).
13 changes: 13 additions & 0 deletions docs/user-guides/workspace-access/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,19 @@ desktop client and VSCode in the browser with [code-server](#code-server).

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

## Cursor

[Cursor](https://cursor.sh/) is an IDE built on VS Code with enhanced AI capabilities.
Cursor connects using the Coder extension.

Read more about [using Cursor with your workspace](./cursor.md).

## Windsurf

[Windsurf](./windsurf.md) is Codeium's code editor designed for AI-assisted development.
Windsurf connects using the Coder extension.


## JetBrains IDEs

We support JetBrains IDEs using
Expand Down
54 changes: 54 additions & 0 deletions docs/user-guides/workspace-access/windsurf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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

Use the Coder extension to connect to your workspaces through SSH.

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.

## 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**.

> [!NOTE]
> If you have any suggestions or experience any issues, please
> [create a GitHub issue](https://github.com/coder/coder/issues/new?title=docs%3A+windsurf+request+title+here&labels=["customer-reported","docs"]&body=please+enter+your+request+here) or share in
> [our Discord channel](https://discord.gg/coder).
Loading