Skip to main content

code-server

Introduction to code-server​

code-server is a tool that allows you to run Visual Studio Code on a remote server and access it through a web browser. It provides a full-featured development environment that can be accessed from anywhere, making it ideal for remote development, collaboration, and working on high-performance computing (HPC) systems.

With code-server, you can use all the features of Visual Studio Code, including extensions, debugging, and terminal access, directly in your browser. It is lightweight, secure, and easy to set up. For more details, visit the official code-server documentation.

Using code-server with Modules​

To use code-server on the terrabyte HPC system, load the code-server module with the following command:

module load code_server

Once loaded, you can start code-server to access Visual Studio Code in your browser. Below are some examples of common operations:

Usage Examples​

Example 1: Start code-server​

To start code-server and specify a port:

code-server --bind-addr 0.0.0.0:8080

Example 2: Access code-server in Your Browser​

After starting code-server, open your web browser and navigate to:

http://<server-ip>:8080

Replace <server-ip> with the IP address of the server where code-server is running.

Example 3: Use a Password for Authentication​

To set a password for accessing code-server:

export PASSWORD="your_password"
code-server --bind-addr 0.0.0.0:8080

Example 4: Install Extensions​

To install Visual Studio Code extensions, use the built-in Extensions view in the browser interface or run:

code-server --install-extension <extension-id>

Example 5: Stop code-server​

To stop code-server, press Ctrl+C in the terminal where it is running.

For additional usage instructions and configuration details, refer to the code-server documentation.