winload-rust-bin 0.1.10-beta.1 → 0.1.11-rc.1

package/bin.js

@@ -1,10 +1,16 @@
 #!/usr/bin/env node
 
 /**
- * @vincentzyuapps/winload — CLI entry point
+ * 📦 winload npm CLI entry point.
  *
- * 定位当前平台的预编译二进制并透传所有参数执行。
- * 用户通过 `npx @vincentzyuapps/winload` 或全局安装后直接 `winload` 即可运行。
+ * 🚀 This launcher is shared by the Rust binary npm distribution.
+ * 🧭 Users can install it in three ways:
+ *   - npm install -g @vincentzyuapps/winload
+ *   - npm install -g winload-rust-bin
+ *   - npm install -g @vincentzyuapps/winload --registry https://npm.pkg.github.com
+ *
+ * 🔎 It resolves the current platform package and forwards all CLI arguments to
+ * the precompiled Rust binary.
  */
 
 "use strict";

package/index.js

@@ -1,10 +1,17 @@
 /**
- * @vincentzyuapps/winload — binary path resolver
+ * 📦 winload npm binary path resolver.
  *
- * npm 安装时会根据 optionalDependencies 中各平台包的 os/cpu 字段，
- * 仅下载与当前平台匹配的那一个。此模块负责定位该平台包中的二进制。
+ * 🧭 The npm release is available as:
+ *   - @vincentzyuapps/winload on npm
+ *   - winload-rust-bin on npm
+ *   - @vincentzyuapps/winload on GitHub Packages
  *
- * 原理同 esbuild / @biomejs/biome / turbo 等项目。
+ * 🧩 optionalDependencies use each platform package's os/cpu fields, so npm only
+ * installs the package matching the current machine. This module locates that
+ * platform package and returns the bundled Rust binary path.
+ *
+ * 🛠 This follows the same packaging pattern used by projects such as esbuild,
+ * @biomejs/biome, and turbo.
  */
 
 "use strict";
@@ -12,9 +19,9 @@
 const path = require("path");
 
 /**
- * 平台映射表
+ * 🗺 Platform package mapping.
  * key:   `${process.platform}-${process.arch}`
- * value: npm 平台包名
+ * value: npm platform package name
  */
 const PLATFORMS = {
   "win32-x64":    "@vincentzyuapps/winload-win32-x64",
@@ -26,9 +33,9 @@ const PLATFORMS = {
 };
 
 /**
- * 获取当前平台对应的 winload 二进制绝对路径
- * @returns {string} 二进制路径
- * @throws {Error} 不支持的平台 / 平台包未安装
+ * 🔎 Resolve the absolute path to the winload binary for the current platform.
+ * @returns {string} Binary path
+ * @throws {Error} Unsupported platform or missing platform package
  */
 function getBinaryPath() {
   const key = `${process.platform}-${process.arch}`;
@@ -50,7 +57,10 @@ function getBinaryPath() {
   } catch {
     throw new Error(
       `winload: platform package "${pkg}" not found\n` +
-      `Try reinstalling: npm install @vincentzyuapps/winload\n` +
+      `Try reinstalling one of:\n` +
+      `  npm install @vincentzyuapps/winload\n` +
+      `  npm install winload-rust-bin\n` +
+      `  npm install @vincentzyuapps/winload --registry https://npm.pkg.github.com\n` +
       `Or download manually: https://github.com/VincentZyuApps/winload/releases`
     );
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "winload-rust-bin",
-  "version": "0.1.10-beta.1",
+  "version": "0.1.11-rc.1",
   "description": "Network Load Monitor — nload-like TUI tool for Windows/Linux/macOS (prebuilt Rust binary)",
   "license": "MIT",
   "repository": {
@@ -33,11 +33,11 @@
     "access": "public"
   },
   "optionalDependencies": {
-    "@vincentzyuapps/winload-win32-x64": "0.1.10-beta.1",
-    "@vincentzyuapps/winload-win32-arm64": "0.1.10-beta.1",
-    "@vincentzyuapps/winload-linux-x64": "0.1.10-beta.1",
-    "@vincentzyuapps/winload-linux-arm64": "0.1.10-beta.1",
-    "@vincentzyuapps/winload-darwin-x64": "0.1.10-beta.1",
-    "@vincentzyuapps/winload-darwin-arm64": "0.1.10-beta.1"
+    "@vincentzyuapps/winload-win32-x64": "0.1.11-rc.1",
+    "@vincentzyuapps/winload-win32-arm64": "0.1.11-rc.1",
+    "@vincentzyuapps/winload-linux-x64": "0.1.11-rc.1",
+    "@vincentzyuapps/winload-linux-arm64": "0.1.11-rc.1",
+    "@vincentzyuapps/winload-darwin-x64": "0.1.11-rc.1",
+    "@vincentzyuapps/winload-darwin-arm64": "0.1.11-rc.1"
   }
 }

package/readme.md

@@ -60,9 +60,10 @@ https://github.com/rolandriegel/nload
 git clone https://github.com/VincentZyuApps/winload.git
 # or clone from Gitee (faster in China Mainland):
 # git clone https://gitee.com/vincent-zyu/winload.git
-cd winload/py
-pip install -r requirements.txt
-python main.py
+cd winload/python
+uv venv --python 3.13
+uv pip install -r requirements.txt
+uv run python main.py
 ```
 
 ### Rust
@@ -165,8 +166,10 @@ which winload
 ### macOS / Linux (Homebrew)
 > 📄 [Homebrew Formula (GitHub)](https://github.com/VincentZyuApps/homebrew-tap/blob/main/Formula/winload.rb)
 > 📄 [Homebrew Formula (Gitee)](https://gitee.com/vincent-zyu/homebrew-tap/blob/main/Formula/winload.rb)
+> Recent Homebrew versions may require trusting third-party tap formulae before installation.
 ```bash
 brew tap vincentzyuapps/tap
+brew trust vincentzyuapps/tap
 # or from Gitee (manual tap clone):
 # git clone https://gitee.com/vincent-zyu/homebrew-tap.git "$(brew --prefix)/Library/Taps/vincentzyuapps/homebrew-tap"
 brew update && brew install winload
@@ -208,7 +211,7 @@ winload --max-mode smart --max-half-life 10 # Smooth adaptive Y-axis (default)
 winload --max-mode legacy # nload-style visible-history scaling
 winload --max-mode fixed --max-y-value 10M # Fixed Y-axis max
 winload --npcap      # Capture 127.0.0.1 loopback traffic (Windows, requires Npcap)
-winload --netlink    # Manually enable RTNETLINK (Linux/Android Rust edition, off by default)
+winload --netlink    # Manually enable RTNETLINK (Linux/Android, off by default)
 ```
 
 ### Options
@@ -232,7 +235,7 @@ winload --netlink    # Manually enable RTNETLINK (Linux/Android Rust edition, of
 | `--hide-separator` | Hide the separator line (row of equals signs) | off |
 | `--no-color` | Disable all TUI colors (monochrome mode) | off |
 | `--npcap` | **[Windows Rust Only]** Capture loopback traffic via Npcap (recommended) | off |
-| `--netlink` | **[Linux/Android Rust Only]** Use RTNETLINK instead of sysinfo (for Termux proot distro or restricted environments) | off |
+| `--netlink` | **[Linux/Android Only]** Use RTNETLINK instead of the default backend (for Termux proot distro or restricted environments) | off |
 | `--debug-info` | Print network interface debug info and exit | — |
 | `-h`, `--help` | Print help (`--help --emoji` for emoji version!) | — |
 | `-V`, `--version` | Print version | — |
@@ -275,13 +278,13 @@ This requires [Npcap](https://npcap.com/#download) installed with "Support loopb
 
 On Linux and macOS, loopback traffic works out of the box — no extra flags needed.
 
-On **Linux/Android**, if `/proc/net/dev` is not accessible (e.g. inside a Termux proot distro or other restricted environments), the Rust edition can use `--netlink` to collect network stats via RTNETLINK directly:
+On **Linux/Android**, if `/proc/net/dev` is not accessible (e.g. inside a Termux proot distro or other restricted environments), use `--netlink` to collect network stats via RTNETLINK directly:
 
 ```bash
 winload --netlink
 ```
 
-> Note: `--netlink` is an **opt-in backend**, similar to `--npcap`; it is never enabled unless you pass the flag. Normal Linux/Android runs still use sysinfo by default. This flag is **Linux/Android Rust edition only**; the Python edition does not support `--netlink` and continues to use psutil. macOS does not support netlink.
+> Note: `--netlink` is an **opt-in backend**, similar to `--npcap`; it is never enabled unless you pass the flag. Normal Linux/Android runs still use the default backend (Rust: sysinfo, Python: psutil). The Python edition uses `pyroute2` for RTNETLINK on Linux/Android. macOS does not support netlink.
 >
 > 📖 For a deep dive into Linux/Android network statistics collection, see [docs/linux_android_netlink.md](docs/linux_android_netlink.md)
 
@@ -308,6 +311,7 @@ winload --netlink
 |:---|:---|:---|
 | [![Python](https://img.shields.io/badge/Python-3.13.11-3776AB?style=flat-square&logo=python&logoColor=white)](https://python.org/) | 3.13.11 | Programming language |
 | [![psutil](https://img.shields.io/badge/psutil-≥7.0-FFD43B?style=flat-square&logo=python&logoColor=white)](https://github.com/giampaolo/psutil) | ≥7.0 | Process and system utilities |
+| [![pyroute2](https://img.shields.io/badge/pyroute2-≥0.9.6-FFD43B?style=flat-square&logo=python&logoColor=white)](https://github.com/svinota/pyroute2) | ≥0.9.6 | RTNETLINK backend on Linux/Android |
 | [![windows-curses](https://img.shields.io/badge/windows--curses-≥2.0-FFD43B?style=flat-square&logo=python&logoColor=white)](https://github.com/zhirui2020/windows-curses) | ≥2.0 | Windows curses support |
 
 ### Rust Edition