Remote HPC development from VS Code - no file syncing, no manual setup.
VS Code Marketplace · Quick Start · Contributing
CyberShuttle is a VS Code extension that lets you work locally while computation runs on a remote HPC cluster or VM. It automatically mounts your workspace on the remote machine through a secure Dev Tunnel - no file syncing, no manual setup. Select a target, launch a session, and your project is ready to use on the remote host.
CyberShuttle reads your ~/.ssh/config and lists all configured remote targets - HPC clusters, cloud VMs, or any machine with SSH access. Sign in with a Microsoft account to enable secure tunneling.
When a SLURM scheduler is detected, CyberShuttle queries available partitions, accounts, memory limits, GPUs, and walltime options. Configure jobs from a visual form directly in the sidebar. For plain SSH hosts, connect directly with no extra configuration.
Launch a session with one click. Your current VS Code workspace is automatically mounted on the remote machine - no file copying, no rsync, no git push/pull. Click Connect to open a new VS Code window on the remote target with your local project files ready to use.
When a session's walltime expires, restart it directly from the sidebar. CyberShuttle remembers your previous configuration.
Browse directories on any connected remote host from the VS Code sidebar. Your local workspace is already mounted and ready in the remote window.
| Concept | Description |
|---|---|
| Workspace Mounting | Your local project directory is mounted on the remote machine via a secure tunnel. No files are copied or synced. |
| Dev Tunnel | A Microsoft Dev Tunnel provides the secure connection between your local VS Code and the remote compute node. |
| linkspan | A lightweight agent deployed to the remote host that manages the VS Code Server and Dev Tunnel on the compute node. |
| Session | A SLURM job (or direct SSH connection) running linkspan on the remote machine. Sessions can be launched, monitored, restarted, and reattached from the sidebar. |
- Open VS Code
- Go to Extensions (
Cmd+Shift+X) - Search for CyberShuttle
- Click Install
To build and install the extension locally for development:
git clone https://github.com/cyber-shuttle/CS-Bridge.git
cd CS-Bridge
npm run devThis installs dependencies, compiles TypeScript, packages the .vsix, and installs it into VS Code. The CyberShuttle icon will appear in your Activity Bar.
- Click the CyberShuttle icon in the Activity Bar
- Sign in with your Microsoft account
- Select a remote target from the dropdown
- Configure resources (SLURM clusters show partition, memory, GPU, and walltime options)
- Click Launch to start your session
- Click Connect - a new VS Code window opens on the remote machine with your workspace mounted
| Requirement | Details |
|---|---|
| VS Code | 1.98 or later |
| SSH Config | At least one remote host in ~/.ssh/config |
| Microsoft Account | Free account for secure tunnel authentication |
| Remote Host | Any machine with SSH access (HPC cluster, cloud VM, etc.) |
| Internet on Remote | Required for first-time session setup |
Local VS Code Remote HPC Cluster
┌───────────────────────┐ ┌────────────────────────────┐
│ CyberShuttle sidebar │──── SSH ────▶│ SLURM scheduler │
│ (webview UI) │ │ │
│ │ │ Compute Node: │
│ SSH ControlMaster │ │ ┌────────────────────┐ │
│ (connection pool) │ │ │ linkspan │ │
│ │ │ │ ├─ VS Code Server │ │
│ Persistent shells │ │ │ └─ Dev Tunnel ─────┼───┼──▶ devtunnels.ms
│ (file browser, │ │ └────────────────────┘ │
│ job monitoring) │ └────────────────────────────┘
└───────────────────────┘
│
▼
Remote-SSH window
(connects via tunnel)
For full architecture details, source layout, and development setup, see CONTRIBUTING.md.
CyberShuttle collects anonymous usage data to improve the extension. No personal files, code, or identifying information is collected. Data is only sent with your explicit consent, which you can grant or revoke at any time in Settings > CyberShuttle > Telemetry.
Contributions are welcome. See CONTRIBUTING.md for development setup, architecture details, and guidelines.