-
Notifications
You must be signed in to change notification settings - Fork 5.5k
docs(remote): document using WSL over SSH #9203
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
base: main
Are you sure you want to change the base?
Conversation
Documents the ability to connect to a WSL distribution over an existing SSH connection, introduced in VS Code 1.89. The content is added to the WSL Remote documentation and is based on existing release notes and behavior. Documentation-only change.
ntrogh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DakotaB75 Please apply requested changes. In general, keep the updates concise and don't introduce unnecessary explanations and subsections.
|
|
||
| Starting with VS Code 1.89, it is possible to connect to a WSL distribution over an existing SSH connection. | ||
|
|
||
| This workflow is useful when you are already connected to a remote machine using **Remote - SSH** and want to work inside a WSL environment hosted on that machine. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drop this line for conciseness
|
|
||
| This workflow is useful when you are already connected to a remote machine using **Remote - SSH** and want to work inside a WSL environment hosted on that machine. | ||
|
|
||
| #### Prerequisites |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drop the prereqs section
| - Remote - SSH extension | ||
| - WSL installed and configured on the remote machine | ||
|
|
||
| #### Connect to WSL over SSH |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this heading to keep everything under the main H3 heading
|
|
||
| #### Connect to WSL over SSH | ||
|
|
||
| 1. Connect to the remote machine using **Remote - SSH**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 1. Connect to the remote machine using **Remote - SSH**. | |
| 1. Connect to the remote machine using the [Remote - SSH extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh). |
| #### Connect to WSL over SSH | ||
|
|
||
| 1. Connect to the remote machine using **Remote - SSH**. | ||
| 2. Open the Command Palette (`kbstyle(F1)`) and run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 2. Open the Command Palette (`kbstyle(F1)`) and run: | |
| 2. Run the **WSL: Connect to WSL using Distro** command from the Command Palette (`kb(workbench.action.showCommands)`). |
| 1. Connect to the remote machine using **Remote - SSH**. | ||
| 2. Open the Command Palette (`kbstyle(F1)`) and run: | ||
|
|
||
| **Remote-WSL: Connect to WSL using SSH** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| **Remote-WSL: Connect to WSL using SSH** |
| **Remote-WSL: Connect to WSL using SSH** | ||
|
|
||
| 3. Select the target WSL distribution. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, select the remote WSL in the Remote Explorer view.
|
|
||
| VS Code will open a new window connected to the selected WSL environment over the existing SSH session. | ||
|
|
||
| This setup combines **Remote - SSH** and **Remote - WSL**, enabling a seamless development experience with Linux tooling inside WSL while working on a remote host. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drop this line
Documents the ability to connect to a WSL distribution over an existing SSH connection, introduced in VS Code 1.89.
The content is added to the WSL Remote documentation and is based on existing release notes and behavior.
Documentation-only change.
Fixes #7320