diff --git a/docs/images/user-guides/ides/windsurf-coder-extension.png b/docs/images/user-guides/ides/windsurf-coder-extension.png new file mode 100644 index 0000000000..90636dadfa Binary files /dev/null and b/docs/images/user-guides/ides/windsurf-coder-extension.png differ diff --git a/docs/manifest.json b/docs/manifest.json index b51ce67284..d6d7920522 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -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" } ] }, diff --git a/docs/user-guides/workspace-access/cursor.md b/docs/user-guides/workspace-access/cursor.md new file mode 100644 index 0000000000..7891d832f7 --- /dev/null +++ b/docs/user-guides/workspace-access/cursor.md @@ -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. + +
+ + ## 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 + (Ctrl+Shift+P or Cmd+Shift+P) + and search for `vsix`. + + 1. Select **Extensions: Install from VSIX** and select the vscode-coder extension you downloaded. + +
+ +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 +(Ctrl+Shift+P or Cmd+Shift+P), +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**. diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md index 91d50fe27e..7d9adb7425 100644 --- a/docs/user-guides/workspace-access/index.md +++ b/docs/user-guides/workspace-access/index.md @@ -80,6 +80,18 @@ 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 diff --git a/docs/user-guides/workspace-access/windsurf.md b/docs/user-guides/workspace-access/windsurf.md new file mode 100644 index 0000000000..f356dc28c0 --- /dev/null +++ b/docs/user-guides/workspace-access/windsurf.md @@ -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 + +![Coder extension in Windsurf](../../images/user-guides/ides/windsurf-coder-extension.png) + +1. You can install the Coder extension through the Marketplace built in to Windsurf or manually. + +
+ + ## 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 + (Ctrl+Shift+P or Cmd+Shift+P) + 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 +(Ctrl+Shift+P or Cmd+Shift+P), +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**.