This extension helps users allocate Slurm resources on a cluster and connect VS Code Remote-SSH through a compute node.
Key features:
One-click discovery of partitions, QoS/accounts (optional), modules, and free-resource hints.
Persistent or ephemeral sessions, with reconnect to existing allocations.
Automatic SSH include management for Remote-SSH (no manual host entries).
Resource validation hints and profile support for repeatable runs.
Module picker with paste, chips, and clear-all.
Optional remote folder open (leave blank for an empty window) + window targeting.
Optional local HTTP(S) proxy for outbound requests from compute nodes (proxies all non-loopback hosts).
Requirements
VS Code with Remote - SSH installed.
SSH authentication configured for the cluster (SSH config or agent; agent forwarding recommended).
Python 3.9+ available on the login nodes.
Bundled vscode-proxy.py auto-installed to ~/.slurm-connect/vscode-proxy.py on connect (can be disabled).
Windows note: Slurm Connect follows Remote-SSH's SSH client selection. If Remote-SSH picks Git's ssh.exe, the extension may prompt to switch to Windows OpenSSH so ssh-agent works reliably.
Quick start (users)
Install the extension.
Open the Slurm Connect view from the activity bar.
Select a login host (or pick from SSH config), username if needed, and an optional identity file.
Click Get cluster info, choose resources, then Connect.
While connecting, the button changes to Cancel so you can abort before Remote-SSH starts.
The extension will query the login host, write a Slurm Connect SSH include file, ensure your SSH config contains a small Slurm Connect Include block (with a note), and connect. It does not replace your SSH config; it only adds the managed block. On Windows, the Include path stays in its configured form (default ~/.ssh/slurm-connect.conf) for compatibility with both native and POSIX-style ssh clients. Local Slurm Connect logs are capped (currently 5 MB) to avoid unbounded growth.
Profiles store the values you edit in the Slurm Connect view (connection, resources, and advanced fields). The local proxy enable and proxy debug logging toggles are in the view; advanced local proxy settings and other global-only settings like the SSH host prefix, managed include path, session state directory, proxy auto-install, SSH query config, and SSH host key checking live in VS Code Settings under slurmConnect.
Docs
Usage and UI reference: docs/usage.md
Cluster info and free-resource filtering: docs/cluster-info.md
SSH and authentication (ssh-agent, step, additional options, proxy command): docs/ssh.md
