@zicolasjac-ai/remote-readonly-ssh 1.1.1 → 1.1.2

package/README.md

@@ -19,19 +19,28 @@ npm install -g @zicolasjac-ai/remote-readonly-ssh
 
 要求 Node.js >= 18，系统已装 OpenSSH 客户端（Windows 10+ / Linux / macOS 自带）。
 
+> **npx 一行命令**：`npx -y @zicolasjac-ai/remote-readonly-ssh init` 也可直接启动初始化向导（无需先 `npm install`）。
+>
 > 从旧包名 `remote-readonly-ssh`（v1.0.0）升级的用户，请先 `npm uninstall -g remote-readonly-ssh` 再安装，否则会报 `EEXIST: file already exists`。
 
+> **postinstall 自动引导**：全局安装完成后，TTY 环境下会自动进入初始化向导；非交互式安装（如 CI）会打印三行下一步提示，不会阻塞安装。
+
 ## 快速开始
 
 ```bash
-npm install -g @zicolasjac-ai/remote-readonly-ssh
-rrs init                 # 生成配置模板 ~/.rrs/config.json
-rrs setup skills         # 把 SKILL.md 安装到 opencode / claude / agents 等目录
-# 编辑配置: 填 jump_server / private_key_path / target_hosts
-rrs list-tools
-rrs sys-info --json
+npm install -g @zicolasjac-ai/remote-readonly-ssh   # 装完自动进向导
+# 或 npx -y @zicolasjac-ai/remote-readonly-ssh init
 ```
 
+向导会依次询问：
+
+1. 是否覆盖已有 `~/.rrs/config.json`（首次安装跳过此步）
+2. 堡垒机主机 / 端口 / 用户名 / SSH 私钥路径
+3. 目标主机白名单（每行 `ip=堡垒机搜索关键字`）
+4. 是否把 SKILL.md 安装到 opencode / Claude / Cursor 等 AI 助手
+
+向导非交互式环境（CI、管道）会静默生成配置模板，不阻塞安装。
+
 ## 用法
 
 ```

package/bin/postinstall.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+"use strict";
+
+const initWizard = require("../src/init");
+const setupSkill = require("../src/setup");
+const path = require("path");
+
+const PACKAGE_ROOT = path.join(__dirname, "..");
+
+(async () => {
+  const tty = process.stdin.isTTY && process.stdout.isTTY;
+  if (tty) {
+    try {
+      await initWizard.runInteractive({ packageRoot: PACKAGE_ROOT });
+    } catch (e) {
+      console.error(`[rrs postinstall] 向导失败: ${e.message}`);
+      console.error("可稍后手动执行: rrs init");
+    }
+  } else {
+    console.log("");
+    console.log("rrs 安装完成。下一步:");
+    console.log("  rrs init                # 交互式初始化 + 安装 AI skill（推荐）");
+    console.log("  rrs setup skills        # 仅安装 AI skill 到 opencode / claude 等");
+    console.log("  rrs list-tools          # 查看白名单与配置");
+    console.log("");
+  }
+})();

package/bin/rrs.js

@@ -9,12 +9,13 @@ const {
   validateCmd, validatePath, validateHost, validateArg, validateBin,
 } = require("../src/whitelist");
 const setupSkill = require("../src/setup");
+const initWizard = require("../src/init");
 
 const PACKAGE_ROOT = path.join(__dirname, "..");
 
 function printUsage() {
   const cmds = [
-    ["init", "生成配置模板到 ~/.rrs/config.json"],
+    ["init", "交互式初始化向导（TTY 下）或生成配置模板"],
     ["list-tools", "查看工具、白名单、配置"],
     ["sys-info", "主机名/OS/内核/uptime"],
     ["proc <pattern>", "进程查询（防注入参数校验）"],
@@ -101,8 +102,10 @@ function runSetup(opts) {
 }
 
 function initConfig() {
+  if (process.stdin.isTTY && process.stdout.isTTY) {
+    return initWizard.runInteractive();
+  }
   const dir = configDir();
-  fs.mkdirSync(dir, { recursive: true });
   const dest = path.join(dir, "config.json");
   if (fs.existsSync(dest)) {
     console.log(`配置已存在: ${dest}（未覆盖，如需重置请手动删除）`);
@@ -218,4 +221,4 @@ if (require.main === module) {
   main();
 }
 
-module.exports = { parseArgs, buildCmds, printUsage, runSetup };
+module.exports = { parseArgs, buildCmds, printUsage, runSetup, initConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zicolasjac-ai/remote-readonly-ssh",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "只读 SSH 运维 CLI 与 Agent Skill：通过 JumpServer 堡垒机白名单强制执行只读查询；附 SKILL.md 让 opencode / Claude Code / Cursor 等 AI 助手自动发现并正确调用。",
   "license": "MIT",
   "bin": {
@@ -36,6 +36,7 @@
   "dependencies": {},
   "scripts": {
     "test": "node --test",
+    "postinstall": "node bin/postinstall.js",
     "preuninstall": "node -e \"try { require('./src/setup').uninstall({agent:'all'}) } catch(_) {}\""
   }
 }

package/src/init.js

@@ -0,0 +1,142 @@
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
+const readline = require("node:readline/promises");
+const setupSkill = require("./setup");
+
+const PACKAGE_ROOT = path.join(__dirname, "..");
+
+function templatePath() {
+  return path.join(PACKAGE_ROOT, "config.example.json");
+}
+
+function readTemplate() {
+  return JSON.parse(fs.readFileSync(templatePath(), "utf8"));
+}
+
+function writeTemplate(destDir) {
+  fs.mkdirSync(destDir, { recursive: true });
+  const dest = path.join(destDir, "config.json");
+  if (fs.existsSync(dest)) return { dest, existed: true };
+  fs.writeFileSync(dest, JSON.stringify(readTemplate(), null, 2), "utf8");
+  return { dest, existed: false };
+}
+
+function parseTargets(text) {
+  const out = {};
+  for (const line of String(text || "").split(/\r?\n/)) {
+    const t = line.trim();
+    if (!t || t.startsWith("#")) continue;
+    const eq = t.indexOf("=");
+    if (eq <= 0) continue;
+    const ip = t.slice(0, eq).trim();
+    const kw = t.slice(eq + 1).trim();
+    if (ip && kw) out[ip] = kw;
+  }
+  return out;
+}
+
+function applyAnswers(cfg, answers) {
+  const a = answers || {};
+  if (a.jumpHost) cfg.jump_server.host = a.jumpHost;
+  if (a.jumpPort) cfg.jump_server.port = Number(a.jumpPort) || cfg.jump_server.port;
+  if (a.jumpUser) cfg.jump_server.username = a.jumpUser;
+  if (a.privateKeyPath) cfg.private_key_path = a.privateKeyPath;
+  if (a.targetHosts && Object.keys(a.targetHosts).length) cfg.target_hosts = a.targetHosts;
+  return cfg;
+}
+
+function defaultAnswersFor(cfg) {
+  return {
+    jumpHost: cfg.jump_server && cfg.jump_server.host ? "" : "",
+    jumpPort: cfg.jump_server && cfg.jump_server.port ? String(cfg.jump_server.port) : "22",
+    jumpUser: cfg.jump_server && cfg.jump_server.username ? cfg.jump_server.username : "",
+    privateKeyPath: cfg.private_key_path && !cfg.private_key_path.includes("YOURNAME") ? cfg.private_key_path : "",
+    targetHosts: cfg.target_hosts || {},
+  };
+}
+
+async function collectAnswers(rl, cfg, prompt) {
+  const ask = async (q, def) => {
+    const label = def ? `${q} [${def}]` : q;
+    const ans = (await rl.question(`${label}: `)).trim();
+    return ans || def || "";
+  };
+  const usePrompt = prompt && typeof prompt === "object";
+  const ans = {};
+  ans.jumpHost = usePrompt && prompt.jumpHost
+    ? await prompt.jumpHost(ask, cfg)
+    : await ask("堡垒机主机 IP / 域名", "");
+  if (!ans.jumpHost) {
+    throw new Error("跳过：未填写堡垒机主机。请稍后编辑 " + path.join(os.homedir(), ".rrs", "config.json"));
+  }
+  ans.jumpPort = usePrompt && prompt.jumpPort
+    ? await prompt.jumpPort(ask, cfg)
+    : await ask("堡垒机端口", "22");
+  ans.jumpUser = usePrompt && prompt.jumpUser
+    ? await prompt.jumpUser(ask, cfg)
+    : await ask("堡垒机用户名", "");
+  ans.privateKeyPath = usePrompt && prompt.privateKeyPath
+    ? await prompt.privateKeyPath(ask, cfg)
+    : await ask("SSH 私钥绝对路径", path.join(os.homedir(), ".ssh", "id_rsa"));
+  const targetText = usePrompt && prompt.targetHosts
+    ? await prompt.targetHosts(ask, cfg)
+    : await ask("目标主机（每行 ip=堡垒机搜索关键字，空行结束）", "");
+  ans.targetHosts = parseTargets(targetText);
+  return ans;
+}
+
+async function runInteractive({ input = process.stdin, output = process.stdout, packageRoot = PACKAGE_ROOT, prompt, installSkills = true, rlFactory } = {}) {
+  const destDir = path.join(os.homedir(), ".rrs");
+  const dest = path.join(destDir, "config.json");
+  const existed = fs.existsSync(dest);
+
+  const rl = rlFactory
+    ? rlFactory()
+    : readline.createInterface({ input, output });
+  try {
+    let overwrite = "n";
+    if (existed) {
+      const ans = (await rl.question(`检测到已存在配置 ${dest}\n  (n) 跳过配置，仅安装 skill  (b) 备份后重写  (y) 直接覆盖 [n]: `)).trim().toLowerCase();
+      overwrite = ans || "n";
+    }
+
+    if (!existed || overwrite === "y" || overwrite === "b") {
+      if (existed && overwrite === "b") {
+        fs.copyFileSync(dest, dest + ".bak");
+      }
+      fs.mkdirSync(destDir, { recursive: true });
+      const cfg = readTemplate();
+      const answers = await collectAnswers(rl, defaultAnswersFor(cfg), prompt);
+      const filled = applyAnswers(cfg, answers);
+      fs.writeFileSync(dest, JSON.stringify(filled, null, 2), "utf8");
+      output.write(`已写入配置: ${dest}\n`);
+    } else {
+      output.write(`保留现有配置: ${dest}\n`);
+    }
+
+    let installedSkills = false;
+    if (installSkills) {
+      const ans = (await rl.question("安装 AI skill 到 opencode / claude / agents 目录? [Y/n]: ")).trim().toLowerCase();
+      const install = ans || "y";
+      if (install !== "n") {
+        const results = setupSkill.install(packageRoot, { agent: "all" });
+        for (const r of results) {
+          output.write(`  [${r.agent}] ${r.action === "written" ? "已安装" : r.action} ${r.dir}\n`);
+        }
+        installedSkills = true;
+      }
+    }
+
+    output.write("\n下一步:\n");
+    output.write("  rrs list-tools           # 查看白名单与配置\n");
+    output.write("  rrs sys-info --json      # 试跑一次只读巡检\n");
+    return { dest, overwrite, installedSkills };
+  } finally {
+    if (!rlFactory) rl.close();
+  }
+}
+
+module.exports = { runInteractive, writeTemplate, readTemplate, parseTargets, applyAnswers, defaultAnswersFor, templatePath };