Prerequisites

Local host with Visual Studio Code (VSCode) and
ssh
installed
Remote Linux target with an
sshd
server installed and running
Remote Linux target with the Intel
®
oneAPI Base Toolkit (Base Kit) installed

Set oneAPI Environment Variables on the Remote Host

Log in to your remote Linux target using
ssh
and install the oneAPI Base Toolkit onto that target system.
To get started, you need to install only the oneAPI Base Toolkit on your remote Linux target; you can install additional oneAPI toolkits either now or at a later time.
Configure your remote Linux target so that the oneAPI development environment script (
setvars.sh
) runs when VSCode initiates a remote connection.
Visual Studio Code does not currently provide a mechanism to automatically run scripts on your remote Linux target when it "remotes into" your target system (for example, running
setvars.sh
remotely). There are a variety of ways to get around this issue, only one of which is presented here. See the Bash Startup Files man page for more options.
Add the following shell script lines to your remote Linux system's
/etc/profile
script. This location (or in an
/etc/profile.d/
script) will ensure that all users of your remote Linux target development system will run the
setvars.sh
environment script when they connect remotely using Visual Studio Code:
if [ -z "$SSH_TTY" ] && [ -n "$SSH_CLIENT" ]; then
    . /opt/intel/inteloneapi/setvars.sh &>/dev/null
fi
The above assumes that you have installed your oneAPI toolkits on your remote Linux target in the default "root/sudo" installation location (
/opt/intel/inteloneapi/
). If you have installed the oneAPI tools in a different location on your remote Linux system, you will have to adjust the path to
setvars.sh
.
The script shown above
will not
execute the
setvars.sh
script when you
ssh
into your remote Linux system or if you are using it directly with a terminal session. Remove the first and third lines if you want it to execute for such interactive terminal sessions. See Configure Your CPU or GPU System for more details regarding configuration of the oneAPI environment on a Linux system.

Configure Visual Studio Code on Your Local Host

Install the
Remote - SSH
extension by Microsoft. Click the
Extensions
icon and search for "Remote-SSH" in the search bar.

Click
install
. After installation, you see
Remote – SSH
in the
Installed Extensions
list.

Connect to Your Remote Linux Target

Click the
remote-ssh
icon located in the lower left corner of your VSCode window. A
remote-ssh commands
palette appears near the top of the VSCode window. Select
Remote-SSH: Connect to Host
in that command palette.

The first connection to your remote Linux target may require a minute or longer to download and install the necessary VSCode backend tools to your remote system. Subsequent connections to the remote system are generally faster. VSCode will indicate the installation process in the lower-right corner of your VSCode window.
Enter the username and an IP address or valid hostname for your remote Linux target, using the same format you would use for an SSH connection into that system, and then press
Enter
. In the image below, the username is
ubuntu
.

A new VSCode window opens and is connected to the remote host. If you do not have an SSH key-pair set up for this connection, you will be prompted to enter a password for your remote Linux target.

If you see errors about bad SSH file permissions when connecting, see fixing SSH file permission errors. If your connection is hanging, you may need to enable TCP forwarding or respond to a server prompt. See Tips and Tricks for details.
Once logged in, add the
C/C++ extension
to your remote VSCode instance. This extension is required to debug a remote session using the VSCode debug interface.

Create a New oneAPI Project

Disconnect from a Remote Host

Kill Remote VSCode Server

Open the VSCode command palette (
View
Command Palette
).
Enter
remote
in the command palette dialog box.
Select
Remote-SSH: Kill VS Code Server on Host
.