Add guide for VS Code#987
Open
aowen-uwmad wants to merge 1 commit into
Open
Conversation
Documents how to connect to CHTC via VS Code, best practices, and troubleshooting.
xamberl
requested changes
Jun 19, 2026
xamberl
left a comment
xamberl
left a comment
Contributor
There was a problem hiding this comment.
Most of my comments are stylistic choices and links. Very comprehensive guide! 🥳
| - hpc | ||
| - htc | ||
| --- | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| ## Introduction |
Added for consistency with other guides.
Comment on lines
+17
to
+18
| {% capture content %} | ||
| - [Requirements](#requirements) |
Contributor
There was a problem hiding this comment.
Suggested change
| {% capture content %} | |
| - [Requirements](#requirements) | |
| {% capture content %} | |
| - [Introduction](#introduction) | |
| - [Requirements](#requirements) |
Added for consistency with other guides.
| - htc | ||
| --- | ||
|
|
||
| VS Code and similar "IDE" programs make it easy to develop and manage coding projects. |
Contributor
There was a problem hiding this comment.
Suggested change
| VS Code and similar "IDE" programs make it easy to develop and manage coding projects. | |
| VS Code and similar Integrated Development Environment (IDE) programs make it easy to develop and manage coding projects. |
|
|
||
| * VS Code or similar IDE installed on your local computer | ||
| * Login access to the HTC or HPC system (requires a [CHTC account](form.md)) | ||
| * How to use VS Code's "command palette" |
Contributor
There was a problem hiding this comment.
Suggested change
| * How to use VS Code's "command palette" |
IMO we can show them how to access it in the guide.
Comment on lines
+42
to
+45
| 1. Install the "Remote-SSH" extension | ||
| 2. Add access point as a new SSH host | ||
| 3. Login | ||
| 4. Login with the file viewer |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Install the "Remote-SSH" extension | |
| 2. Add access point as a new SSH host | |
| 3. Login | |
| 4. Login with the file viewer | |
| 1. [Install the "Remote-SSH" extension](#install-the-remote-ssh-extension) | |
| 2. [Add access point as a new SSH host](#add-access-point-as-a-new-ssh-host) | |
| 3. [Log in](#log-in) | |
| 4. [Log in with the file viewer](#log-in-with-the-file-viewer) |
Adding some links to the anchors will be nice!
Comment on lines
+217
to
+219
| | "Kill VS Code Server on Host" | Built-in command that attempts to login and automatically shut-down VS Code on the remote server | | ||
| | "Uninstall VS Code Server from Host" | Built-in command that attempts to login, shut-down, and uninstall VS Code on the remote server | | ||
| | Manual clean-up | You login with a plain terminal to shut-down and uninstall VS Code from the remote server | |
Contributor
There was a problem hiding this comment.
Suggested change
| | "Kill VS Code Server on Host" | Built-in command that attempts to login and automatically shut-down VS Code on the remote server | | |
| | "Uninstall VS Code Server from Host" | Built-in command that attempts to login, shut-down, and uninstall VS Code on the remote server | | |
| | Manual clean-up | You login with a plain terminal to shut-down and uninstall VS Code from the remote server | | |
| | ["Kill VS Code Server on Host"](#kill-vs-code-server-on-host) | Built-in command that attempts to login and automatically shut-down VS Code on the remote server | | |
| | "[Uninstall VS Code Server from Host"](#uninstall-vs-code-server-from-host) | Built-in command that attempts to login, shut-down, and uninstall VS Code on the remote server | | |
| | [Manual clean-up](#manual-clean-up) | You login with a plain terminal to shut-down and uninstall VS Code from the remote server | |
| ``` | ||
| {:.term} | ||
|
|
||
| This command looks for left-over processes from your VS Code on the server and then removes ("kill") them. |
Contributor
There was a problem hiding this comment.
Suggested change
| This command looks for left-over processes from your VS Code on the server and then removes ("kill") them. | |
| This command looks for leftover processes from your VS Code on the server and then removes ("kill") them. |
|
|
||
| If you have a lot of files in your directory on the access point, then VS Code may struggle to list and scan those files for the file viewer. | ||
|
|
||
| If this is causing you problems, here are some things to try: |
Contributor
There was a problem hiding this comment.
Suggested change
| If this is causing you problems, here are some things to try: | |
| If this is causing problems, here are some things to try: |
|
|
||
| * Reduce the number of files on the server. | ||
| * Open a specific directory in the file viewer, instead of the default home directory. ("Connect to host" then "Open Folder" and select a sub-directory in the dialog.) | ||
| * Configure VS Code to ignore the directories that contain a lot of files. |
Contributor
There was a problem hiding this comment.
Any instructions or links to how to do this?
|
|
||
| The facilitation team may be able to help you figure out the process, but keep in mind that we do not explicitly support these tools. | ||
|
|
||
| ## Related pages |
Contributor
There was a problem hiding this comment.
I'd also add the "AI Agents on CHTC" page here!
Contributor
|
LGTM!! Thank you for writing this up - will be useful to a lot of users. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents how to connect to CHTC via VS Code, best practices, and troubleshooting.
Preview should be at https://chtc.github.io/web-preview/preview-vs-code/uw-research-computing/vs-code .
Also check the HTC/HPC navigation pages under the "Get started" section.