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
Prev Previous commit
Next Next commit
remove cli steps; add cursor/windsurf sections
  • Loading branch information
EdwardAngert authored Mar 28, 2025
commit 139d64b3e135fd79244da2440463fa06642f5e3d
58 changes: 2 additions & 56 deletions docs/user-guides/workspace-access/cursor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,66 +6,12 @@ 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 and Coder CLI
## Install Cursor

Cursor can connect to a Coder workspace using SSH:
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. Install the Coder CLI:

<!-- copied from docs/install/cli.md - make changes there -->

<div class="tabs">

### Linux/macOS

Our install script is the fastest way to install Coder on Linux/macOS:

```sh
curl -L https://coder.com/install.sh | sh
```

Refer to [GitHub releases](https://github.com/coder/coder/releases) for
alternate installation methods (e.g. standalone binaries, system packages).

### Windows

Use [GitHub releases](https://github.com/coder/coder/releases) to download the
Windows installer (`.msi`) or standalone binary (`.exe`).

![Windows setup wizard](../../images/install/windows-installer.png)

Alternatively, you can use the
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
package manager to install Coder:

```powershell
winget install Coder.Coder
```

</div>

Consult the [Coder CLI documentation](../../install/cli.md) for more options.

1. Log in to your Coder deployment and authenticate when prompted:

```shell
coder login coder.example.com
```

1. Configure Coder SSH:

```shell
coder config-ssh
```

1. List your available workspaces:

```shell
coder list
```

1. Open Cursor and log in or [create a Cursor account](https://authenticator.cursor.sh/sign-up)
if you don't have one already.

Expand Down
11 changes: 7 additions & 4 deletions docs/user-guides/workspace-access/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,16 @@ 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 SSH and provides AI-assisted development features.
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 All @@ -101,7 +107,6 @@ IDEs are supported for remote development:
- RubyMine
- WebStorm
- [JetBrains Fleet](./jetbrains.md#jetbrains-fleet)
- [Windsurf](./windsurf.md)

Read our [docs on JetBrains Gateway](./jetbrains.md) for more information on
connecting your JetBrains IDEs.
Expand All @@ -127,8 +132,6 @@ Supported IDEs:
- RStudio
- Airflow
- File Browser
- [Cursor](./cursor.md)
- [Windsurf](./windsurf.md)

Our [Module Registry](https://registry.coder.com/modules) also hosts a variety
of tools for extending the capability of your workspace. If you have a request
Expand Down
56 changes: 1 addition & 55 deletions docs/user-guides/workspace-access/windsurf.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,66 +7,12 @@ 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 and Coder CLI
## 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. Install the Coder CLI:

<!-- copied from docs/install/cli.md - make changes there -->

<div class="tabs">

### Linux/macOS

Our install script is the fastest way to install Coder on Linux/macOS:

```sh
curl -L https://coder.com/install.sh | sh
```

Refer to [GitHub releases](https://github.com/coder/coder/releases) for
alternate installation methods (e.g. standalone binaries, system packages).

### Windows

Use [GitHub releases](https://github.com/coder/coder/releases) to download the
Windows installer (`.msi`) or standalone binary (`.exe`).

![Windows setup wizard](../../images/install/windows-installer.png)

Alternatively, you can use the
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
package manager to install Coder:

```powershell
winget install Coder.Coder
```

</div>

Consult the [Coder CLI documentation](../../install/cli.md) for more options.

1. Log in to your Coder deployment and authenticate when prompted:

```shell
coder login coder.example.com
```

1. Configure Coder SSH:

```shell
coder config-ssh
```

1. List your available workspaces:

```shell
coder list
```

1. Open Windsurf and select **Get started**.

Import your settings from another IDE, or select **Start fresh**.
Expand Down
Loading