CLEAR Integrated Development Environments (IDE) Guide

IntelliJ IDEA

IntelliJ IDEA is a JetBrains integrated development environment commonly used for Java and other software development projects.

Remote Access to CLEAR

When configuring IntelliJ IDEA for remote development on CLEAR, you may need to use SSH public/private key authentication if the IDE's remote SSH workflow does not support the interactive Duo authentication required for standard CLEAR logins.

For instructions on configuring SSH keys, see the SSH Public/Private Key Instructions.

IDE versions and remote development features change over time. Consult the current JetBrains documentation for information about configuring IntelliJ IDEA remote development and SSH connections.

CLion

CLion is a JetBrains integrated development environment designed primarily for C and C++ development.

Remote Access to CLEAR

When configuring CLion for remote development on CLEAR, you may need to use SSH public/private key authentication if the IDE's remote SSH workflow does not support the interactive Duo authentication required for standard CLEAR logins.

For instructions on configuring SSH keys, see the SSH Public/Private Key Instructions.

IDE versions and remote development features change over time. Consult the current JetBrains documentation for information about configuring CLion remote development and SSH connections.

Visual Studio Code Remote Development

Visual Studio Code can be configured to use the CLEAR systems as a remote development environment through SSH. This allows you to edit files and use development tools on CLEAR while working through the Visual Studio Code interface on your local computer.

Note: Visual Studio Code Remote SSH requires an OpenSSH-compatible SSH client. PuTTY cannot be used directly as the SSH client for the configuration described in this guide.

Windows users who do not already have OpenSSH installed should review the Microsoft OpenSSH installation documentation.

Visual Studio Code version 1.86 and later introduced updated minimum Linux requirements. For additional information, see the Visual Studio Code minimum Linux requirements update.

This guide is provided as an aid for users who choose to use Visual Studio Code with CLEAR. Visual Studio Code is not required for accessing or developing software on the CLEAR systems.

SSH Access to CLEAR

SSH Requirements

You will need an OpenSSH-compatible SSH client on your local computer. OpenSSH is available for Windows, macOS, and Linux.

To verify that SSH is available, open a terminal or command prompt and run:

ssh

If SSH is installed, you should see command usage information.

Authentication

The Visual Studio Code Remote SSH workflow described in this guide uses your Rice NetID credentials and Duo authentication.

SSH public/private key authentication may also be available for appropriate configurations. For information about SSH keys, see the SSH Public/Private Key Instructions.

CLEAR Servers

The CLEAR environment consists of multiple Linux systems. For general access, connect to:

ssh.clear.rice.edu

When connecting from a terminal, you can use:

ssh <NetID>@ssh.clear.rice.edu

Replace <NetID> with your Rice NetID.

Depending on the CLEAR configuration, connecting through ssh.clear.rice.edu may place you on an available login system. You may also connect to a specific CLEAR system when appropriate for your coursework or project.

Install Visual Studio Code

Visual Studio Code installation varies depending on your operating system. Download and install the appropriate version from the Visual Studio Code download page.

Start Visual Studio Code

After installing Visual Studio Code, start the application using your operating system's application menu or shortcut.

If the code command has been configured on your local system, you may also be able to start Visual Studio Code from a terminal with:

code

The Visual Studio Code application will open with an interface similar to the following:

The interface contains menus and activity controls along the top and left side of the application. The main area is used for editors, terminals, settings, and other development tools.

Install the Remote - SSH Extension

To connect Visual Studio Code to CLEAR, install the Remote - SSH extension.

Select the Extensions icon in Visual Studio Code:

The Extensions view will open and display available and installed extensions.

In the Extensions Marketplace search field, search for:

Remote - SSH

You should see results similar to the following:

Select the Microsoft Remote - SSH extension.

Select Install to install the extension.

Configure Remote - SSH for CLEAR

After installing the Remote - SSH extension, open its settings. You can access the settings through the extension's management controls or through the Visual Studio Code Settings interface.

Select Extension Settings. The Remote SSH settings will open in Visual Studio Code.

Show Login Terminal

Locate the following setting:

Remote.SSH: Show Login Terminal

Enable this setting so that interactive authentication prompts can be displayed during the SSH login process.

Remote Server Listen On Socket

Locate the following setting:

Remote.SSH: Remote Server Listen On Socket

Enable this setting for the CLEAR remote connection configuration.

Lockfiles in Tmp

Locate the following setting:

Remote.SSH: Lockfiles in Tmp

Enable this setting so that Remote SSH lock files are stored in /tmp on the remote CLEAR system.

After completing the configuration, close the Settings tab.

Connect to CLEAR Using Remote SSH

To begin a remote connection, open the Visual Studio Code Remote menu. Depending on your Visual Studio Code version, this may appear as a remote connection indicator in the lower-left corner of the application.

Select Connect to Host and enter:

<NetID>@ssh.clear.rice.edu

Replace <NetID> with your Rice NetID.

If Visual Studio Code asks you to select the remote operating system, select:

Linux

On the first connection, SSH may ask you to confirm the remote host key.

Verify that you are connecting to the intended CLEAR host before accepting a new host key. If prompted and the host information is correct, enter:

yes

Follow the displayed SSH authentication prompts. Depending on the current Rice authentication workflow, you may be prompted for your Rice NetID credentials and Duo authentication.

Complete the authentication prompts until Visual Studio Code establishes the remote connection. Additional authentication prompts may appear while Visual Studio Code establishes the Remote SSH connection.

If a terminal associated with the Remote SSH connection indicates that it must remain open, do not close that terminal while you are using the remote session.

Additional terminal sessions can be opened within Visual Studio Code as needed.

When You Are Finished

When you are finished using the remote development environment, disconnect from the remote host normally through Visual Studio Code.

If you need to explicitly stop the VS Code Server running on the CLEAR host, open the Visual Studio Code Command Palette:

Ctrl + Shift + P

Search for and select the appropriate Remote SSH command to stop or uninstall the VS Code Server from the remote host. The exact command name may vary depending on your installed version of the Remote - SSH extension.

If needed, you can check your CLEAR session for remaining VS Code Server processes:

ps -ealf | grep -v grep | grep .vscode-server | grep <NetID>

Replace <NetID> with your Rice NetID.

Troubleshooting

If you experience problems with Visual Studio Code Remote SSH, review the Visual Studio Code Remote Development troubleshooting documentation.

When troubleshooting a CLEAR connection, verify the following:

• OpenSSH is installed and working on your local computer.
• You can connect to CLEAR using SSH outside of Visual Studio Code.
• You are using your correct Rice NetID.
• You can successfully complete the required authentication process.
• The Remote - SSH extension is installed and enabled.
• The CLEAR-specific Remote SSH settings described above are configured correctly.

Additional Documentation

• Visual Studio Code Documentation
• Visual Studio Code Basics
• Visual Studio Code User Guide
• Visual Studio Code Remote Development