@nearhost/cli 0.13.0-rc.3 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +9 -5
  2. package/package.json +10 -9
package/README.md CHANGED
@@ -25,7 +25,7 @@ Nearhost gives each project a name, a certificate your browser trusts and SSH fo
25
25
  - **Hot reload and WebSockets.** Upgrades travel through the same SSH connection as the page. Nearhost can forward a dev server's port to the same number on your laptop, so asset URLs that point at `localhost` still resolve.
26
26
  - **Any stack.** If it listens on a port, Nearhost can serve it. It reads port variables from `.env` and proposes routes. Presets from a registry you trust add Docker Compose, Vite and Laravel Sail.
27
27
  - **Local projects too.** Projects on your laptop get the same name and certificate, so one tool covers the laptop and the servers.
28
- - **Your traffic stays yours.** No relay, no account and no public URL. Nearhost owns one marked block in `/etc/hosts` and asks for `sudo` only when that block changes.
28
+ - **Your traffic stays yours.** No relay, no account and no public URL. Nearhost owns one marked block in `/etc/hosts` (the hosts file on Windows) and asks for `sudo` only when that block changes (on Windows, you approve the change in a prompt).
29
29
 
30
30
  ## Install
31
31
 
@@ -42,17 +42,21 @@ npm install -g @nearhost/cli
42
42
  nearhost
43
43
  ```
44
44
 
45
- pnpm (`pnpm add -g @nearhost/cli`) and bun (`bun add -g @nearhost/cli`) work too. Nearhost runs on macOS and Linux, on Apple silicon, Intel and ARM.
45
+ pnpm (`pnpm add -g @nearhost/cli`) and bun (`bun add -g @nearhost/cli`) work too. Nearhost runs on macOS, Linux and Windows 11, on Apple silicon, Intel and ARM.
46
46
 
47
- The binary also ships through Homebrew (`brew install nearhost/tap/nearhost`) and a shell installer (`curl -fsSL https://nearhost.dev/install.sh | sh`). The [install guide](https://nearhost.dev/docs/getting-started/install/) covers each one.
47
+ The binary also ships through Homebrew (`brew install nearhost/tap/nearhost`) and a shell installer (`curl -fsSL https://nearhost.dev/install.sh | sh`). On Windows there is a PowerShell installer (`irm https://nearhost.dev/install.ps1 | iex`). The [install guide](https://nearhost.dev/docs/getting-started/install/) covers each one.
48
48
 
49
49
  ### On Linux
50
50
 
51
51
  Nearhost serves HTTPS on port 443 and redirects port 80, and a normal user cannot bind either. Run `nearhost doctor`: it prints the `setcap` command that grants the binary that one capability, with the binary's path inside `node_modules` filled in. Run it again after each upgrade.
52
52
 
53
+ ### On Windows
54
+
55
+ Nearhost needs Windows 11 and Windows Terminal. It runs Microsoft's OpenSSH client (`ssh.exe`), so your `~/.ssh/config` applies. A key with a passphrase needs the `ssh-agent` service, which Windows leaves disabled by default; `nearhost doctor` checks it. The binary is not code signed, so SmartScreen may warn the first time it runs: choose More info, then Run anyway. Where Smart App Control is on, Windows can block the binary because it is unsigned, and Nearhost cannot run there until its Windows binaries are signed.
56
+
53
57
  ## Quick start
54
58
 
55
- 1. **Start Nearhost.** Run `nearhost`. On first run it explains its local certificate authority and trusts it for you, asking for your password through `sudo`.
59
+ 1. **Start Nearhost.** Run `nearhost`. On first run it explains its local certificate authority and trusts it for you, asking for your password through `sudo` (on Windows, you confirm a Windows security prompt).
56
60
  2. **Add a server.** Press `s` and pick a host alias from `~/.ssh/config`, or type `user@host`. Nearhost checks that it connects without a prompt. The `local` server needs no setup.
57
61
  3. **Add a project.** Press `n` and give the project's path. Nearhost reads its `.env` over SFTP and proposes the ports: which one serves the web app, which need a loopback forward and which to ignore.
58
62
  4. **Open it.** Nearhost adds a hosts entry, issues a certificate and routes `https://myapp.test` through the SSH connection. Press `o` to open it in your browser.
@@ -94,7 +98,7 @@ Nearhost serves your own machines to your own browser. To show work to someone e
94
98
 
95
99
  ## How this package works
96
100
 
97
- `@nearhost/cli` holds a small Node launcher. The Go binary comes in a platform package, `@nearhost/cli-darwin-arm64`, `@nearhost/cli-darwin-x64`, `@nearhost/cli-linux-arm64` or `@nearhost/cli-linux-x64`, and npm installs only the one that matches your machine. No install script runs, so `--ignore-scripts` works. Each binary matches the one on the [GitHub release](https://github.com/nearhost/nearhost/releases) byte for byte, and versions published by the release workflow carry npm provenance.
101
+ `@nearhost/cli` holds a small Node launcher. The Go binary comes in a platform package, `@nearhost/cli-darwin-arm64`, `@nearhost/cli-darwin-x64`, `@nearhost/cli-linux-arm64`, `@nearhost/cli-linux-x64`, `@nearhost/cli-win32-arm64` or `@nearhost/cli-win32-x64`, and npm installs only the one that matches your machine. No install script runs, so `--ignore-scripts` works. Each binary matches the one on the [GitHub release](https://github.com/nearhost/nearhost/releases) byte for byte, and versions published by the release workflow carry npm provenance.
98
102
 
99
103
  ## Licence
100
104
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@nearhost/cli",
3
- "version": "0.13.0-rc.3",
4
- "description": "Open dev servers on your other machines at trusted HTTPS addresses of their own (https://<name>.test by default) over your own SSH. A terminal app for macOS and Linux.",
3
+ "version": "0.13.0",
4
+ "description": "Open dev servers on your other machines at trusted HTTPS addresses of their own (https://<name>.test by default) over your own SSH. A terminal app for macOS, Linux and Windows.",
5
5
  "keywords": [
6
6
  "dev server",
7
7
  "development server",
@@ -23,7 +23,8 @@
23
23
  "tui",
24
24
  "cli",
25
25
  "macos",
26
- "linux"
26
+ "linux",
27
+ "windows"
27
28
  ],
28
29
  "homepage": "https://nearhost.dev",
29
30
  "bugs": "https://github.com/nearhost/nearhost/issues",
@@ -44,11 +45,11 @@
44
45
  "node": ">=18"
45
46
  },
46
47
  "optionalDependencies": {
47
- "@nearhost/cli-darwin-x64": "0.13.0-rc.3",
48
- "@nearhost/cli-darwin-arm64": "0.13.0-rc.3",
49
- "@nearhost/cli-linux-x64": "0.13.0-rc.3",
50
- "@nearhost/cli-linux-arm64": "0.13.0-rc.3",
51
- "@nearhost/cli-win32-x64": "0.13.0-rc.3",
52
- "@nearhost/cli-win32-arm64": "0.13.0-rc.3"
48
+ "@nearhost/cli-darwin-x64": "0.13.0",
49
+ "@nearhost/cli-darwin-arm64": "0.13.0",
50
+ "@nearhost/cli-linux-x64": "0.13.0",
51
+ "@nearhost/cli-linux-arm64": "0.13.0",
52
+ "@nearhost/cli-win32-x64": "0.13.0",
53
+ "@nearhost/cli-win32-arm64": "0.13.0"
53
54
  }
54
55
  }