my-singbox 2.0.0-next.0 → 2.0.0

package/README.md

@@ -13,20 +13,13 @@ sh install.sh && export PATH="$HOME/.local/node/bin:$PATH"
 
 The installer installs Node >= 22 to `~/.local/node` without sudo; it skips installation if Node >= 22 is already on PATH.
 
-> **The npm package `my-singbox` is not published yet, so `npx my-singbox ...` does not work for now.** Examples below use `npx my-singbox <cmd>`. Until the package is published, use one of these routes instead (both tested):
->
-> ```bash
-> # A) from a checkout of this repository
-> git clone --branch ts-version https://github.com/zht7063/my-singbox.git && cd my-singbox
-> npm ci && npm run build
-> node dist/cli.js doctor   # replaces "npx my-singbox doctor"
->
-> # B) install a packed tarball
-> npm pack
-> npm install -g ./my-singbox-*.tgz   # then run "my-singbox <cmd>"
-> ```
->
-> Run commands from the deployment directory (for example `/opt/sing-box`). For route A, call `node /path/to/my-singbox/dist/cli.js <cmd>` with the absolute path.
+Install the CLI from npm:
+
+```bash
+npm i -g my-singbox   # then run "my-singbox <cmd>"
+```
+
+Or run it without installing: `npx my-singbox <cmd>`. Examples below use `npx my-singbox <cmd>`; after a global install, drop `npx`. Run commands from the deployment directory (for example `/opt/sing-box`).
 
 ## Usage
 

package/README_CN.md

@@ -13,20 +13,13 @@ sh install.sh && export PATH="$HOME/.local/node/bin:$PATH"
 
 安装程序无需 sudo，将 Node >= 22 安装到 `~/.local/node`；如果 PATH 中已有 Node >= 22，则跳过安装。
 
-> **npm 包 `my-singbox` 尚未发布，目前 `npx my-singbox ...` 无法使用。** 下文示例写作 `npx my-singbox <cmd>`。包发布之前，请改用下面任一方式（均已验证）：
->
-> ```bash
-> # A) 从本仓库的检出目录运行
-> git clone --branch ts-version https://github.com/zht7063/my-singbox.git && cd my-singbox
-> npm ci && npm run build
-> node dist/cli.js doctor   # 代替 "npx my-singbox doctor"
->
-> # B) 安装打包后的 tarball
-> npm pack
-> npm install -g ./my-singbox-*.tgz   # 之后运行 "my-singbox <cmd>"
-> ```
->
-> 请在部署目录（例如 `/opt/sing-box`）中运行命令。方式 A 请使用绝对路径：`node /path/to/my-singbox/dist/cli.js <cmd>`。
+从 npm 安装命令行工具：
+
+```bash
+npm i -g my-singbox   # 之后运行 "my-singbox <cmd>"
+```
+
+也可以无需安装直接运行：`npx my-singbox <cmd>`。下文示例写作 `npx my-singbox <cmd>`；全局安装后可省略 `npx`。请在部署目录（例如 `/opt/sing-box`）中运行命令。
 
 ## 使用
 

package/dist/cli.js

@@ -8036,7 +8036,7 @@ async function genConfig(io) {
   const project = resolve2(io.cwd ?? process.cwd());
   const envPath = resolve2(project, ".env");
   if (!existsSync3(envPath))
-    throw new CliError(".env does not exist. Run scripts/gen-keys.sh first.");
+    throw new CliError(".env does not exist. Run my-singbox gen-keys first.");
   const template = findTemplate("config.json.template", project);
   const path = resolve2(project, "config.json");
   if (existsSync3(path))
@@ -8115,7 +8115,7 @@ async function confClash(io) {
   const project = resolve3(io.cwd ?? process.cwd());
   const envPath = resolve3(project, ".env");
   if (!existsSync4(envPath))
-    throw new CliError(".env does not exist. Run scripts/gen-keys.sh first.");
+    throw new CliError(".env does not exist. Run my-singbox gen-keys first.");
   const template = findTemplate("clash.yaml.template", project);
   const path = resolve3(project, "clash.yaml");
   if (existsSync4(path))
@@ -8257,7 +8257,7 @@ function addIspToClash(text, realityPrivateKey) {
   const doc = (0, import_yaml2.parseDocument)(text);
   if (doc.errors.length) throw new IspError("clash.yaml is not valid YAML.");
   const proxies = doc.get("proxies", true);
-  const missing = `clash.yaml has no usable node named "${NODE_SS}" and "${NODE_VLESS}". It was probably generated by an older version (My-sing-box / My-VLESS-Reality). Delete clash.yaml, run scripts/conf-clash.sh to regenerate it, re-import it in your clients, then re-run this script.`;
+  const missing = `clash.yaml has no usable node named "${NODE_SS}" and "${NODE_VLESS}". It was probably generated by an older version (My-sing-box / My-VLESS-Reality). Delete clash.yaml, run my-singbox conf-clash to regenerate it, re-import it in your clients, then re-run my-singbox isp-outbound --add.`;
   if (!(0, import_yaml2.isSeq)(proxies)) throw new IspError(missing);
   let changed = false;
   for (const [base, name, basePort, port] of [
@@ -8291,7 +8291,7 @@ function addIspToClash(text, realityPrivateKey) {
   const group = (0, import_yaml2.isSeq)(groups) ? groups.items.find((g) => (0, import_yaml2.isMap)(g) && g.get("name") === GROUP_MAIN) : void 0;
   const list = (0, import_yaml2.isMap)(group) ? group.get("proxies", true) : void 0;
   if (!(0, import_yaml2.isSeq)(list))
-    throw new IspError(`clash.yaml has no '${GROUP_MAIN}' proxy group with a 'proxies:' list in the expected format (generated by scripts/conf-clash.sh). Regenerate clash.yaml, re-import it in your clients, then re-run this script.`);
+    throw new IspError(`clash.yaml has no '${GROUP_MAIN}' proxy group with a 'proxies:' list in the expected format (generated by my-singbox conf-clash). Regenerate clash.yaml, re-import it in your clients, then re-run my-singbox isp-outbound --add.`);
   for (const name of [NODE_SS_ISP, NODE_VLESS_ISP]) {
     if (!list.items.some((item) => (0, import_yaml2.isScalar)(item) && item.value === name)) {
       list.add(name);
@@ -8721,7 +8721,7 @@ async function ispOutbound(io, opts) {
   };
   const preflightConfig = () => {
     if (!isFile(path("config.json")))
-      throw new IspError("config.json does not exist. Run scripts/gen-config.sh first.");
+      throw new IspError("config.json does not exist. Run my-singbox gen-config first.");
     const text = readFileSync6(path("config.json"), "utf8");
     let config;
     try {
@@ -8754,7 +8754,7 @@ async function ispOutbound(io, opts) {
   const add = async (image) => {
     const original = preflightConfig();
     if (!isFile(path(".env")))
-      throw new IspError(".env does not exist. Run scripts/gen-keys.sh first.");
+      throw new IspError(".env does not exist. Run my-singbox gen-keys first.");
     if (!configHasIsp(original.config)) await service.portsFree();
     const envText = readFileSync6(path(".env"), "utf8");
     const isp = await collectInputs(envText, ask);
@@ -8780,7 +8780,7 @@ async function ispOutbound(io, opts) {
       candidate(clashCandidate);
       clashState = `clash.yaml updated (nodes ${NODE_SS_ISP} and ${NODE_VLESS_ISP} added and listed in the ${GROUP_MAIN} group).`;
     } else {
-      warn("clash.yaml does not exist, so only the server config is changed. After running scripts/conf-clash.sh, re-run this script with --add to add the client nodes.");
+      warn("clash.yaml does not exist, so only the server config is changed. After running my-singbox conf-clash, re-run my-singbox isp-outbound --add to add the client nodes.");
       clashState = "clash.yaml not found (skipped).";
     }
     const changed = configText !== original.text;
@@ -8870,12 +8870,12 @@ Notes:
     if (docker === "permission-denied")
       throw new IspError(`permission denied while talking to the Docker daemon (the Docker socket is not accessible to this user). Nothing was changed.
 Do one of these, then re-run:
-  - run this script with sudo:  sudo my-singbox isp-outbound ${action ? `--${action}` : ""}
+  - run it with sudo:  sudo my-singbox isp-outbound ${action ? `--${action}` : ""}
   - or add your user to the docker group and log in again:  sudo usermod -aG docker "$USER"   (then log out and back in)`);
     if (docker === "down")
       throw new IspError("Docker daemon is not running (or not reachable). Start it and re-run. Nothing was changed.");
     const image = await service.containerImage();
-    if (!image) throw new IspError("Container sing-box not found. Run scripts/start.sh first.");
+    if (!image) throw new IspError("Container sing-box not found. Run my-singbox start first.");
     const sudoHint = `sudo my-singbox isp-outbound ${action ? `--${action}` : ""}`;
     try {
       accessSync(projectDir, constants.W_OK);
@@ -9221,7 +9221,7 @@ Options: --help, -h
 var ispUsage = `Usage: my-singbox isp-outbound [--add | --remove] [--yes]
 
   --add      add or update the ISP outbound (ports 13839 and 18444)
-  --remove   remove the ISP outbound and everything this script added
+  --remove   remove the ISP outbound and everything it added
   --yes, -y  do not ask before restarting sing-box
   --help     show this help
 
@@ -9265,8 +9265,7 @@ async function dispatch(argv, io) {
     }
     return ispOutbound(io, { action, yes });
   } else if (args.some((a) => ["--help", "-h"].includes(a))) {
-    const help = cmd === "doctor" ? "\nCheck server prerequisites without changing the system." : ` [args]
-Equivalent shell script: scripts/${cmd}.sh`;
+    const help = cmd === "doctor" ? "\nCheck server prerequisites without changing the system." : " [args]";
     io.stdout(`Usage: my-singbox ${cmd}${help}
 `);
     return 0;

package/dist/index.js

@@ -8140,7 +8140,7 @@ function addIspToClash(text, realityPrivateKey) {
   const doc = (0, import_yaml2.parseDocument)(text);
   if (doc.errors.length) throw new IspError("clash.yaml is not valid YAML.");
   const proxies = doc.get("proxies", true);
-  const missing = `clash.yaml has no usable node named "${NODE_SS}" and "${NODE_VLESS}". It was probably generated by an older version (My-sing-box / My-VLESS-Reality). Delete clash.yaml, run scripts/conf-clash.sh to regenerate it, re-import it in your clients, then re-run this script.`;
+  const missing = `clash.yaml has no usable node named "${NODE_SS}" and "${NODE_VLESS}". It was probably generated by an older version (My-sing-box / My-VLESS-Reality). Delete clash.yaml, run my-singbox conf-clash to regenerate it, re-import it in your clients, then re-run my-singbox isp-outbound --add.`;
   if (!(0, import_yaml2.isSeq)(proxies)) throw new IspError(missing);
   let changed = false;
   for (const [base, name, basePort, port] of [
@@ -8174,7 +8174,7 @@ function addIspToClash(text, realityPrivateKey) {
   const group = (0, import_yaml2.isSeq)(groups) ? groups.items.find((g) => (0, import_yaml2.isMap)(g) && g.get("name") === GROUP_MAIN) : void 0;
   const list = (0, import_yaml2.isMap)(group) ? group.get("proxies", true) : void 0;
   if (!(0, import_yaml2.isSeq)(list))
-    throw new IspError(`clash.yaml has no '${GROUP_MAIN}' proxy group with a 'proxies:' list in the expected format (generated by scripts/conf-clash.sh). Regenerate clash.yaml, re-import it in your clients, then re-run this script.`);
+    throw new IspError(`clash.yaml has no '${GROUP_MAIN}' proxy group with a 'proxies:' list in the expected format (generated by my-singbox conf-clash). Regenerate clash.yaml, re-import it in your clients, then re-run my-singbox isp-outbound --add.`);
   for (const name of [NODE_SS_ISP, NODE_VLESS_ISP]) {
     if (!list.items.some((item) => (0, import_yaml2.isScalar)(item) && item.value === name)) {
       list.add(name);

package/install.sh

@@ -57,8 +57,7 @@ node_dir=${MY_SINGBOX_NODE_DIR:-$HOME/.local/node}
 
 hints() {
   printf 'PATH hint: export PATH="%s/bin:$PATH"\n' "$node_dir"
-  echo 'Next: npx my-singbox doctor (package is not published yet in P1).'
-  echo 'From a checkout: node dist/cli.js doctor'
+  echo 'Next: npm i -g my-singbox && my-singbox doctor (or: npx my-singbox doctor).'
 }
 
 usable_node() {
@@ -70,7 +69,7 @@ usable_node() {
 if [[ ${MY_SINGBOX_FORCE_NODE_INSTALL:-0} != 1 ]]; then
   if command -v node >/dev/null 2>&1 && usable_node node; then
     echo "Using Node already on PATH: $(command -v node)"
-    echo 'Next: npx my-singbox doctor (package is not published yet in P1). From a checkout: node dist/cli.js doctor'
+    echo 'Next: npm i -g my-singbox && my-singbox doctor (or: npx my-singbox doctor).'
     exit 0
   fi
   if [[ -x $node_dir/bin/node ]] && usable_node "$node_dir/bin/node"; then

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "my-singbox",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0",
   "type": "module",
   "license": "MIT",
   "engines": {