Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

Commit 3914f00

Browse files
authored
[readme]: add changes related to Windows release and drop of the sudo requirement for Ubix
1 parent f65c885 commit 3914f00

File tree

1 file changed

+12
-20
lines changed

1 file changed

+12
-20
lines changed

README.md

+12-20
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,29 @@ For instance, if you are using a `VPN` client to connect to private enterprise n
1212

1313
## Prerequisites
1414

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).
1616

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.
1818

1919
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.
2020

2121
## Installation
2222

23-
Mac OSx:
24-
2523
```shell
2624
gh extension install github/gh-net
2725
```
2826

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-
3727
## Usage
3828

3929
To start network forwarding from a Codespace to a local machine, run:
4030

4131
```shell
42-
sudo gh net start
32+
gh net
4333
```
4434

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.
4636
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.
4738

4839
The command will first open a Codespace selection dialog:
4940

@@ -62,15 +53,14 @@ Press `q` or `ctrl + c` to stop the extension.
6253

6354
### CLI Options
6455

65-
- `--codespace`(`-c`): Codespace name to connect to. [`codespace name`] [default: `none`]
66-
- `--dns`(`-d`): Enable/disable DNS resolution. [`true` | `false`] [default: `true`]
6756
- `--gui`(`-g`): Enable/disable GUI mode. [`true` | `false`] [default: `true`]
6857
- `--trace`(`-t`): Specify tracing verbosity. [`none` | `trace` | `debug` | `info` | `warn` | `error`] [default: `info`]
6958
- `--trace-dest`: Specify tracing destination file. [`file name`] [default: `none`]
59+
- `--dns`(`-d`): Enable/disable DNS resolution. [`true` | `false`] [default: `true`]
60+
- `--codespace`(`-c`): Codespace name to connect to. [`codespace name`] [default: `none`]
7061
- `--telemetry`: Enable/disable sending diagnostics telemetry (no `PII` data is sent). [`true` | `false`] [default: `true`]
7162

72-
Run `gh net start -h` for details.
73-
63+
Run `gh net -h` for details.
7464

7565
## Supported platforms
7666

@@ -125,8 +115,10 @@ Run `gh net start -h` for details.
125115

126116
| Architecture | Status |
127117
|-------------------------|-------------------------------------|
128-
| AMD64 | <span title="in progress">🏃</span> |
129-
| i386 | <span title="in progress">🏃</span> |
118+
| Windows 10 (AMD) | <span title="supported">✅</span> |
119+
| Windows 11 (AMD) | <span title="supported">✅</span> |
120+
| Windows 11 (ARM) | <span title="in progress">🏃</span> |
121+
| Windows 10 (i386) | <span title="in progress">🏃</span> |
130122

131123
## Tested VPN Clients
132124

0 commit comments

Comments
 (0)