Skip to content

vscode --name #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2025
Merged

vscode --name #22

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c27fb91
vscode --name
henrique Feb 24, 2025
534e3ce
tip --name
henrique Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/access/vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,15 @@ run the `code` executable that you downloaded the `tunnel` argument.
You will be asked to choose whether to log in to Microsoft or GitHub (we have tested with GitHub):

```
> code tunnel
> code tunnel --name=$CLUSTER_NAME-tunnel
...
? How would you like to log in to Visual Studio Code? ›
Microsoft Account
❯ GitHub Account
```

* `--name` sets a name for the tunnel, which will be later listed on the VSCode UI

You will be requested to go to [github.com/login/device](https://github.com/login/device) and enter an 8-digit code.
Once you have finished registering the service with GitHub, in VSCode on your PC/laptop open the "remote explorer" pane on the left hand side of the main window, and the connection will be visible under REMOTES (TUNNELS/SSH) -> Tunnels.

Expand Down Expand Up @@ -91,13 +93,13 @@ ssh daint
# start a uenv session on the login node
uenv start --view=default prgenv-gnu/24.11:v1
# then start the tunnel
code tunnel
code tunnel --name=$CLUSTER_NAME-tunnel
```

Alternatively, you can execute `code tunnel` directly in the environment:
```
ssh daint
uenv run --view=default prgenv-gnu/24.11:v1 -- code tunnel
uenv run --view=default prgenv-gnu/24.11:v1 -- code tunnel --name=$CLUSTER_NAME-tunnel
```

Once the tunnel is configured, you can access it from VSCode.
Expand All @@ -119,7 +121,7 @@ If you plan to do computation using your VSCode, then you should first allocate
You can directly execute the `code tunnel` command using srun:
```
ssh daint
srun --uenv=prgenv-gnu/24.11:v1 --view=default -t120 -n1 --pty code tunnel
srun --uenv=prgenv-gnu/24.11:v1 --view=default -t120 -n1 --pty code tunnel --name=$CLUSTER_NAME-tunnel
```

* `--uenv` and `--view` set up the uenv
Expand All @@ -131,7 +133,7 @@ If you plan to do computation using your VSCode, then you should first allocate
If you don't want to use a uenv, the command is even simpler:
```
ssh daint
srun -t120 -n1 --pty code tunnel
srun -t120 -n1 --pty code tunnel --name=$CLUSTER_NAME-tunnel
```

!!! example "log into a node before starting"
Expand All @@ -145,7 +147,7 @@ If you plan to do computation using your VSCode, then you should first allocate

# set up the environment before starting the tunnel
uenv start prgenv-gnu/24.11:v1 --view=default
code tunnel
code tunnel --name=$CLUSTER_NAME-tunnel
```

* `-t120` requests a 2 hour (120 minute) reservation
Expand Down