sdkvm 1.0.1 → 1.0.3

package/README.en.md

@@ -69,22 +69,11 @@ Platform limits:
 
 ## Install
 
-### npm, pnpm, yarn, bun
+**Prefer the install script**: no preinstalled Node.js, an isolated runtime for the CLI, data and entrypoint under `SDKVM_HOME` (default `~/.sdkvm`), and upgrades via `sdkvm upgrade`.
 
-The machine needs Node.js >= 18.15. All four commands install from the npm registry:
+### Install script (recommended)
 
-```sh
-npm install -g sdkvm
-pnpm add -g sdkvm
-yarn global add sdkvm
-bun add -g sdkvm
-```
-
-The CLI then runs on whatever `node` is first on `PATH`. Switching to a Node older than 18.15 stops the CLI until you switch back.
-
-### Install script
-
-No preinstalled Node.js is required. A GitHub Release that already contains `sdkvm.tgz` and `SHA256SUMS` is required (uploaded by CI after a `v*` tag).
+Requires a [GitHub Release](https://github.com/QInJ1995/sdkvm/releases) that already contains `sdkvm.tgz` and `SHA256SUMS` (uploaded by CI after a `v*` tag).
 
 macOS / Linux:
 
@@ -100,33 +89,51 @@ irm https://raw.githubusercontent.com/QInJ1995/sdkvm/main/install.ps1 | iex
 
 The script:
 
-1. Downloads Node.js 22.20.0 into `~/.sdkvm/runtime`. That copy only launches the CLI. `sdkvm node use` does not change it.
-2. Downloads `sdkvm.tgz` from the GitHub Release, checks SHA-256, and extracts it to `~/.sdkvm/cli`.
-3. Writes `~/.local/bin/sdkvm` (on Windows, `%USERPROFILE%\.local\bin\sdkvm.cmd`). If that directory is not on `PATH`, the script prints the line to add.
+1. Downloads Node.js 22.20.0 into `$SDKVM_HOME/runtime` (CLI only; `sdkvm node use` does not change it).
+2. Downloads `sdkvm.tgz` from the GitHub Release, checks SHA-256, and extracts it to `$SDKVM_HOME/cli`.
+3. Writes `$SDKVM_HOME/bin/sdkvm` (on Windows, `%SDKVM_HOME%\bin\sdkvm.cmd`) and adds that directory to the shell profile / user PATH (zsh → `~/.zshrc`, bash → `~/.bash_profile` or `~/.bashrc`).
+
+Then open a new terminal, or `source` the rc file, and check:
+
+```console
+$ sdkvm version
+1.0.3
+```
+
+To use a custom data root, **pass `SDKVM_HOME` on the install command itself** (`curl | sh` does not read `~/.zshrc`):
 
-The data root matches the CLI: `SDKVM_HOME` overrides it, otherwise `~/.sdkvm`. Both the runtime and the CLI live under that root. Override download prefixes when needed:
+```sh
+SDKVM_HOME=/Volumes/Develop/sdkvm \
+  curl -fsSL https://raw.githubusercontent.com/QInJ1995/sdkvm/main/install.sh | sh
+```
+
+Override download prefixes when needed:
 
 ```sh
 SDKVM_NODE_DIST=https://npmmirror.com/mirrors/node \
 SDKVM_RELEASE_BASE=https://github.com/QInJ1995/sdkvm/releases \
-  sh install.sh
+  curl -fsSL https://raw.githubusercontent.com/QInJ1995/sdkvm/main/install.sh | sh
 ```
 
-Check:
+### npm / pnpm / yarn / bun (alternative)
 
-```console
-$ sdkvm version
-1.0.1
+Use this when Node.js >= 18.15 is already installed and you want the package manager to own global tools. The CLI follows the `node` on `PATH`; a Node older than 18.15 can stop the CLI.
+
+```sh
+npm install -g sdkvm
+pnpm add -g sdkvm
+yarn global add sdkvm
+bun add -g sdkvm
 ```
 
 ## Upgrade
 
 | Install method | Command | What changes |
 |---|---|---|
-| npm | `npm update -g sdkvm` | CLI only. pnpm / yarn / bun use their own global update command |
-| script | `sdkvm upgrade` | Replaces `~/.sdkvm/cli` only. The runtime and installed SDKs stay |
+| Script (recommended) | `sdkvm upgrade` | Replaces `$SDKVM_HOME/cli` only. The runtime and installed SDKs stay |
+| npm and friends | `npm update -g sdkvm` | CLI only. pnpm / yarn / bun use their own global update command |
 
-`~/.sdkvm` data is independent of a CLI upgrade. A script install can also be refreshed by running the install script again.
+The data directory is independent of a CLI upgrade. A script install can also be refreshed by running the install script again.
 
 ## Quick start
 
@@ -353,6 +360,7 @@ The data root is `~/.sdkvm` (`%USERPROFILE%\.sdkvm` on Windows). `SDKVM_HOME` ov
 ├── current-node
 ├── runtime/         # Script-install Node, isolated from current-node
 ├── cli/             # Script-install CLI package
+├── bin/             # Script-install entrypoint sdkvm (add to PATH)
 ├── config.json
 ├── cache/           # Download staging, removed after a successful install
 └── tmp/             # Extract staging, also removed
@@ -552,11 +560,10 @@ pnpm, yarn, and bun use their own global uninstall command.
 A script install removes the shim and the CLI runtime. Installed SDKs stay:
 
 ```sh
-rm -f ~/.local/bin/sdkvm
-rm -rf ~/.sdkvm/cli ~/.sdkvm/runtime
+rm -rf ~/.sdkvm/bin ~/.sdkvm/cli ~/.sdkvm/runtime
 ```
 
-On Windows, delete `%USERPROFILE%\.local\bin\sdkvm.cmd`, plus `%USERPROFILE%\.sdkvm\cli` and `%USERPROFILE%\.sdkvm\runtime`.
+On Windows, delete `%USERPROFILE%\.sdkvm\bin\sdkvm.cmd`, plus `%USERPROFILE%\.sdkvm\cli` and `%USERPROFILE%\.sdkvm\runtime`, and remove `%USERPROFILE%\.sdkvm\bin` from the user PATH.
 
 After you no longer need the installed JDKs, Go, Flutter, and Node.js, remove the data directory:
 
@@ -564,7 +571,9 @@ After you no longer need the installed JDKs, Go, Flutter, and Node.js, remove th
 rm -rf ~/.sdkvm
 ```
 
-Also delete the shell blocks between `>>> sdkvm java init >>>`, `>>> sdkvm go init >>>`, `>>> sdkvm flutter init >>>`, `>>> sdkvm node init >>>` and their matching `<<< … <<<` markers.
+Also delete these shell blocks:
+- `# >>> sdkvm path >>>` … `# <<< sdkvm path <<<`
+- each SDK’s `>>> sdkvm java|go|flutter|node init >>>` … `<<< … <<<`
 
 On Windows, remove `JAVA_HOME`, `GO_HOME`, `FLUTTER_HOME`, and `NODE_HOME` from the user environment, and remove `%JAVA_HOME%\bin`, `%GO_HOME%\bin`, `%FLUTTER_HOME%\bin`, and `%NODE_HOME%` from the user PATH.
 

package/README.md

@@ -69,22 +69,11 @@
 
 ## 安装
 
-### npm、pnpm、yarn、bun
+**推荐使用安装脚本**：无需本机预装 Node.js，CLI 自带隔离运行时，数据与入口都在 `SDKVM_HOME`（默认 `~/.sdkvm`）下，升级用 `sdkvm upgrade` 即可。
 
-本机需要 Node.js >= 18.15。四条命令都从 npm registry 安装：
+### 安装脚本（推荐）
 
-```sh
-npm install -g sdkvm
-pnpm add -g sdkvm
-yarn global add sdkvm
-bun add -g sdkvm
-```
-
-装好后 CLI 使用 `PATH` 上的 `node`。若之后切到 18.15 以前的 Node，CLI 会无法启动，切回较新版本即可。
-
-### 安装脚本
-
-不要求本机已经安装 Node.js。需要仓库已有带 `sdkvm.tgz` 与 `SHA256SUMS` 的 GitHub Release（打 `v*` tag 后由 CI 上传）。
+需要仓库已有带 `sdkvm.tgz` 与 `SHA256SUMS` 的 [GitHub Release](https://github.com/QInJ1995/sdkvm/releases)（打 `v*` tag 后由 CI 上传）。
 
 macOS / Linux：
 
@@ -100,33 +89,51 @@ irm https://raw.githubusercontent.com/QInJ1995/sdkvm/main/install.ps1 | iex
 
 脚本会：
 
-1. 下载 Node.js 22.20.0 到 `~/.sdkvm/runtime`。它只启动 CLI，`sdkvm node use` 不会改到它。
-2. 从 GitHub Release 下载 `sdkvm.tgz`，校验 SHA-256 后解压到 `~/.sdkvm/cli`。
-3. 写入 `~/.local/bin/sdkvm`（Windows 为 `%USERPROFILE%\.local\bin\sdkvm.cmd`）。目录不在 `PATH` 中时，脚本会打印需要追加的那一行。
+1. 下载 Node.js 22.20.0 到 `$SDKVM_HOME/runtime`（仅启动 CLI，`sdkvm node use` 不会改到它）。
+2. 从 GitHub Release 下载 `sdkvm.tgz`，校验 SHA-256 后解压到 `$SDKVM_HOME/cli`。
+3. 写入 `$SDKVM_HOME/bin/sdkvm`（Windows 为 `%SDKVM_HOME%\bin\sdkvm.cmd`），并把该目录写入 shell 配置 / 用户 PATH（zsh→`~/.zshrc`，bash→`~/.bash_profile` 或 `~/.bashrc`）。
+
+装完后重开终端，或 `source` 对应 rc，再验证：
+
+```console
+$ sdkvm version
+1.0.3
+```
+
+自定义数据根时，**必须在安装命令的环境里带上** `SDKVM_HOME`（`curl | sh` 不会读取 `~/.zshrc`）：
 
-数据根与 CLI 一致：`SDKVM_HOME` 可覆盖，默认 `~/.sdkvm`。runtime 与 CLI 都落在该根下。国内可换下载前缀：
+```sh
+SDKVM_HOME=/Volumes/Develop/sdkvm \
+  curl -fsSL https://raw.githubusercontent.com/QInJ1995/sdkvm/main/install.sh | sh
+```
+
+国内可换下载前缀：
 
 ```sh
 SDKVM_NODE_DIST=https://npmmirror.com/mirrors/node \
 SDKVM_RELEASE_BASE=https://github.com/QInJ1995/sdkvm/releases \
-  sh install.sh
+  curl -fsSL https://raw.githubusercontent.com/QInJ1995/sdkvm/main/install.sh | sh
 ```
 
-验证：
+### npm / pnpm / yarn / bun（备选）
 
-```console
-$ sdkvm version
-1.0.1
+适合本机已有 Node.js >= 18.15、且希望用包管理器统一管理全局工具的场景。CLI 依赖 `PATH` 上的 `node`；若之后切到 18.15 以前的 Node，CLI 可能无法启动。
+
+```sh
+npm install -g sdkvm
+pnpm add -g sdkvm
+yarn global add sdkvm
+bun add -g sdkvm
 ```
 
 ## 升级
 
 | 安装方式 | 命令 | 影响范围 |
 |---|---|---|
-| npm | `npm update -g sdkvm` | 只更新 CLI。pnpm / yarn / bun 用各自的全局更新命令 |
-| 脚本 | `sdkvm upgrade` | 只替换 `~/.sdkvm/cli`。runtime 与已安装的 SDK 保持不变 |
+| 脚本（推荐） | `sdkvm upgrade` | 只替换 `$SDKVM_HOME/cli`。runtime 与已安装的 SDK 保持不变 |
+| npm 等 | `npm update -g sdkvm` | 只更新 CLI。pnpm / yarn / bun 用各自的全局更新命令 |
 
-数据目录 `~/.sdkvm` 与 CLI 升级无关。脚本安装也可以重新执行安装脚本。
+数据目录与 CLI 升级无关。脚本安装也可以重新执行安装脚本。
 
 ## 快速开始
 
@@ -353,6 +360,7 @@ sdkvm nrm test
 ├── current-node
 ├── runtime/         # 脚本安装的 CLI 运行时，与 current-node 隔离
 ├── cli/             # 脚本安装的 CLI 包
+├── bin/             # 脚本安装的入口 sdkvm（需加入 PATH）
 ├── config.json
 ├── cache/           # 下载中转，安装成功后删除
 └── tmp/             # 解压临时目录，同样会删除
@@ -552,11 +560,10 @@ pnpm、yarn、bun 使用各自的全局卸载命令。
 脚本安装只删除 shim 和 CLI 运行时，已安装的 SDK 还在：
 
 ```sh
-rm -f ~/.local/bin/sdkvm
-rm -rf ~/.sdkvm/cli ~/.sdkvm/runtime
+rm -rf ~/.sdkvm/bin ~/.sdkvm/cli ~/.sdkvm/runtime
 ```
 
-Windows 对应删除 `%USERPROFILE%\.local\bin\sdkvm.cmd`，以及 `%USERPROFILE%\.sdkvm\cli` 与 `%USERPROFILE%\.sdkvm\runtime`。
+Windows 对应删除 `%USERPROFILE%\.sdkvm\bin\sdkvm.cmd`，以及 `%USERPROFILE%\.sdkvm\cli` 与 `%USERPROFILE%\.sdkvm\runtime`，并从用户 PATH 移除 `%USERPROFILE%\.sdkvm\bin`。
 
 确认不再需要已安装的 JDK、Go、Flutter、Node.js 之后，再删除数据目录：
 
@@ -564,7 +571,9 @@ Windows 对应删除 `%USERPROFILE%\.local\bin\sdkvm.cmd`，以及 `%USERPROFILE
 rm -rf ~/.sdkvm
 ```
 
-同时删除 shell 配置里 `>>> sdkvm java init >>>`、`>>> sdkvm go init >>>`、`>>> sdkvm flutter init >>>`、`>>> sdkvm node init >>>` 到对应 `<<< … <<<` 之间的块。
+同时删除 shell 配置里：
+- `# >>> sdkvm path >>>` … `# <<< sdkvm path <<<`
+- 各 SDK 的 `>>> sdkvm java|go|flutter|node init >>>` … `<<< … <<<`
 
 Windows 还需要在系统设置中删除 `JAVA_HOME`、`GO_HOME`、`FLUTTER_HOME`、`NODE_HOME`，并从用户 PATH 移除 `%JAVA_HOME%\bin`、`%GO_HOME%\bin`、`%FLUTTER_HOME%\bin`、`%NODE_HOME%`。