Remote Development With Visual Studio Code
- Version 15.x
- Version 14.x
- Version 13.x
- Version 12.x
- Older Versions
- Available for:
This guide explains how to use Teleport and Visual Studio Code's remote SSH extension.
To check version information, run the
tctl version and
tsh version commands.
Teleport Enterprise v13.3.9 git:api/14.0.0-gd1e081e go1.21tsh version
Teleport v13.3.9 go1.21Proxy version: 13.3.9Proxy: teleport.example.com
- OpenSSH client.
- Visual Studio Code with the Remote - SSH extension for the Remote - SSH extension.
- One or more Teleport agents running the Teleport SSH Service. If you have not yet done this, read the Server Access Getting Started Guide to learn how.
- Update the variables below with your environment's information to use our example commands directly.
Configure your local SSH client to access Teleport Nodes. Replace teleport.example.com with the address of your Teleport Proxy Service (e.g.,
mytenant.teleport.sh for Teleport Cloud users), and replace alice with your Teleport user.
log in to your proxy:tsh login --proxy teleport.example.com --user alice
generate the OpenSSH config for the proxy:tsh config --proxy teleport.example.com
Append the resulting configuration snippet into your SSH config file located in the path below:
If using PowerShell on Windows to write your SSH config, note that normal shell redirection may write the file with the incorrect encoding. To ensure it's written properly, try the following:
tsh.exe config | out-file .ssh\config -encoding utf8 -append
You should be able to connect to the desired node using following command, replacing
user with the username you would like to assume on the node.
The SSH config you generated earlier instructs your SSH client to run
tsh proxy ssh to access a Node in your Teleport cluster. However, running an
ssh command against the Teleport Proxy Service at
yourtenant.teleport.sh will result in an error.
Teleport's certificates expire fairly quickly, after which SSH attempts will fail with an error like the following:
[email protected]: Permission denied (publickey). ERROR: exit status 255 kex_exchange_identification: Connection closed by remote host
When you see this error, re-run
tsh login to refresh your local certificate.
Install the Remote - SSH extension in your local VS Code instance. A new "Window Indicator" (icon with two arrows) should appear in the bottom left of your VS Code window.
Prior to connecting with a host, set the
Remote.SSH: Use Local Server setting
to false in the extension setting. You can search for
@ext:ms-vscode-remote.remote-ssh to find the plugin-specific settings.
To connect, click on the icon with two arrows and select "Connect to Host...". Select "+ Add New SSH Host..."
For each host you wish to remotely develop on, add an entry like the following:
When prompted to choose which SSH Configuration file to update select the one we generated during Step 1.
This will write a new node into your SSH Configuration file. You can edit and manage all your nodes in this file.
Start a Remote Development session by either:
- Clicking "Connect" on the notification that opens after adding a new host.
- Clicking on the Window Indicator again and selecting "Connect to Host". You should see the host you just added and any others in your Configuration file in the drop down.
On first connect, you'll be prompted to configure the remote OS. Select the proper platform and VS Code will install its server-side component. When it completes, you should be left with a working editor:
The Window Indicator in the bottom left highlights the currently connected remote host.
It's possible to remotely develop on any OpenSSH host joined to a Teleport cluster so long as its host OS is supported by VS Code. Refer to the OpenSSH guide to configure the remote host to authenticate via Teleport certificates, after which the procedure outlined above can be used to connect to the host in VS Code.
This guide makes use of
tsh config; refer to the
dedicated guide for additional information.