Louis Knight-Webb e8ff40d5a4 Remote host + username opening for VSCode based IDEs (#1134) ...

* feat: add remote VSCode SSH support for remote server deployments

Add support for opening VSCode via SSH when Vibe Kanban is running on a remote server.
This allows users accessing the web UI through a tunnel to open projects/tasks in their
local VSCode which connects to the remote server via SSH.

Backend changes:
- Add remote_ssh_host and remote_ssh_user fields to EditorConfig (v3)
- Create config v8 with migration from v7
- Modify EditorConfig.open_file() to return URL when remote mode is enabled
- Update API routes to return OpenEditorResponse with optional URL
- Generate vscode:// URL scheme for remote SSH connections

Frontend changes:
- Update API client to handle OpenEditorResponse type
- Modify hooks to open URLs in new tabs when returned
- Add UI fields in settings for remote SSH configuration

When remote_ssh_host is configured, clicking "Open in VSCode" generates a URL like:
vscode://vscode-remote/ssh-remote+user@host/path/to/project

This works for both project-level and task-level editor opening.

* feat: extend remote SSH support to Cursor and Windsurf editors

Extend the remote SSH feature to support Cursor and Windsurf editors,
which are VSCode forks that use the same remote SSH protocol.

Changes:
- Update EditorConfig.open_file() to generate cursor:// and windsurf:// URLs
- Show SSH configuration fields in settings for all three VSCode-based editors
- Use same vscode-remote SSH URL pattern for all three editors

When remote_ssh_host is configured, supported editors generate URLs like:
- vscode://vscode-remote/ssh-remote+user@host/path
- cursor://vscode-remote/ssh-remote+user@host/path
- windsurf://vscode-remote/ssh-remote+user@host/path

* fix: address clippy linting issues

- Fix uninlined format args in v3.rs
- Add allow attributes for re-exported types in v5-v7

* docs: add remote SSH configuration documentation

Add comprehensive documentation for the remote SSH editor feature:

- Expand Editor Integration section in global-settings.mdx
  - Document when to use remote SSH (tunnels, systemctl services, remote deployments)
  - Explain configuration fields (remote_ssh_host, remote_ssh_user)
  - Detail how the feature works with protocol URLs
  - List prerequisites for SSH access and VSCode Remote-SSH extension
  - Support for VSCode, Cursor, and Windsurf editors

- Add Remote Deployment section to README.md
  - Quick guide for setting up remote SSH access
  - Link to detailed documentation
  - Include in feature list

This documentation helps users understand and configure the remote SSH
feature when running Vibe Kanban on remote servers accessed via browser.

* remove package-lock in favour of pnpm lock

* rollback config version increment

* re-impl remote URL

* Update i18n for general settings (vibe-kanban 4a1a3ae1)

frontend/src/pages/settings/GeneralSettings.tsx

Find any strings here that haven't been i18n'd and i18n them

* add line number/col to the end of vscode-remote file paths

* handle response url when opening file in ide from DiffCard

* update remote-ssh guidance in readme

* add image to global settings docs

---------

Co-authored-by: Stephan Fitzpatrick <stephan@knowsuchagency.com>
Co-authored-by: Britannio Jarrett <britanniojarrett@gmail.com>

2025-10-31 12:39:58 +00:00

133 KiB

2168x916px

Raw History