Skip to content

Commit ab471f8

Browse files
committed
Add dev notes about how to connect to codespace using JetBrains products
1 parent a61c1f1 commit ab471f8

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,8 @@ The extension that is available for VS Code to support Kotlin works quite slow (
356356
and sometimes does not work correctly with multiplatform definitions.
357357
Because of that I higly recoment using JetBrains Gateway
358358
(but it looks like the GitHub Codespace provider is not currently compatible with latest Gateway version).
359+
However, there is a way to connect to Codespace and work with project using JetBrains IDE.
360+
Please, read details [here](docs/codespaces_for_jetbrains.md).
359361

360362
## Future plans
361363

docs/codespaces_for_jetbrains.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Connect to Codespaces using JetBrains IDE
2+
3+
## Pre-requirements
4+
5+
1. You need to have [gh CLI](https://cli.github.com/) installed.
6+
2. JetBrains IDE that can connect to remote host via SSH
7+
8+
## Steps
9+
10+
1. Create Codespace in GitHub. You can do it either via the UI or using gh CLI.
11+
2. Create local SSH server that is connected to the Codespace you need.
12+
```bash
13+
gh cs ssh --server-port <port>
14+
```
15+
For example,
16+
```bash
17+
gh cs ssh --server-port 30042
18+
```
19+
You will see something like this:
20+
```text
21+
$ gh cs ssh --server-port 30042
22+
? Choose codespace: OptimumCode/json-schema-validator (main): redesigned zebra
23+
Connection Details: ssh vscode@localhost [-p 30042 -o NoHostAuthenticationForLocalhost=yes -o PasswordAuthentication=no]
24+
```
25+
3. Connect to Codespace using the displayed connection details.

0 commit comments

Comments
 (0)