You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 20, 2023. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+12-20
Original file line number
Diff line number
Diff line change
@@ -12,38 +12,29 @@ For instance, if you are using a `VPN` client to connect to private enterprise n
12
12
13
13
## Prerequisites
14
14
15
-
1. This extension depends on the latest features of [GitHub CLI](https://cli.github.com/)(>= v2.8.0). Please make sure [to upgrade it](https://github.com/cli/cli#installation).
15
+
1. This extension requires [GitHub CLI](https://cli.github.com/) version `v2.8.0` and up. Please make sure [to upgrade it](https://github.com/cli/cli#installation).
16
16
17
-
2. The extension relies on `gh codespace ssh` command to establish SSH tunnel to a Codespace. If you use [GitHub CLI >=2.13.0](https://github.com/cli/cli/releases/tag/v2.13.0) the `SSH` config is created automatically for all your Codespaces, otherwise follow [SSH setup](./docs/SSH_SETUP.md) instructions.
17
+
2.**If using GitHub CLI < [2.13.0](https://github.com/cli/cli/releases/tag/v2.13.0) only.**The extension relies on `gh codespace ssh` command to establish SSH tunnel to a Codespace. If you use [GitHub CLI >=2.13.0](https://github.com/cli/cli/releases/tag/v2.13.0) the `SSH` config is created automatically for all your Codespaces, otherwise follow [SSH setup](./docs/SSH_SETUP.md) instructions.
18
18
19
19
3. If your Codespace uses a non-default image, ensure that both the [GitHub CLI](https://cli.github.com/), `openssh-server`, and `sudo` are installed inside the codespace. Some distros need an `ssh` group too. Please see [linux dependencies doc](./docs/LINUX_DEPENDENCIES.md) for per-distro instructions.
20
20
21
21
## Installation
22
22
23
-
Mac OSx:
24
-
25
23
```shell
26
24
gh extension install github/gh-net
27
25
```
28
26
29
-
Linux:
30
-
31
-
```shell
32
-
sudo gh extension install github/gh-net
33
-
```
34
-
35
-
The `sudo` permissions are required during extension installation on Linux due to https://github.com/cli/cli/issues/5456. Hopefully, it won't be the case in the future.
36
-
37
27
## Usage
38
28
39
29
To start network forwarding from a Codespace to a local machine, run:
40
30
41
31
```shell
42
-
sudo gh net start
32
+
gh net
43
33
```
44
34
45
-
Connection issues? Please see https://github.com/github/gh-net/issues/9 and [SSH setup doc](./docs/SSH_SETUP.md) for some of the known solutions.
35
+
> Note: on Windows, you need to use a command prompt launched with Administrator privileges.
46
36
37
+
Connection issues? Please see https://github.com/github/gh-net/issues/9 and [SSH setup doc](./docs/SSH_SETUP.md) for some of the known solutions.
47
38
48
39
The command will first open a Codespace selection dialog:
49
40
@@ -62,15 +53,14 @@ Press `q` or `ctrl + c` to stop the extension.
62
53
63
54
### CLI Options
64
55
65
-
-`--codespace`(`-c`): Codespace name to connect to. [`codespace name`][default: `none`]
66
-
-`--dns`(`-d`): Enable/disable DNS resolution. [`true` | `false`][default: `true`]
0 commit comments