agent-ssh-cli 0.1.3 → 0.2.0

package/README.md

@@ -11,8 +11,8 @@
   <a href="https://github.com/sleepinginsummer/agent-ssh-cli/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-green" alt="License MIT"></a>
   <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-%3E%3D18-339933?logo=node.js&logoColor=white" alt="Node.js >=18"></a>
   <a href="https://www.npmjs.com/"><img src="https://img.shields.io/badge/npm-%3E%3D8-CB3837?logo=npm&logoColor=white" alt="npm >=8"></a>
-  <a href="https://github.com/sleepinginsummer/agent-ssh-cli"><img src="https://img.shields.io/badge/Windows-MacOS-0078D6?labelColor=0078D6&color=C0C0C0" alt="Windows/MacOS"></a>
-  <a href="https://github.com/sleepinginsummer/agent-ssh-cli/releases"><img src="https://img.shields.io/badge/release-v0.1.3-blue" alt="release v0.1.3"></a>
+  <a href="https://github.com/sleepinginsummer/agent-ssh-cli"><img src="https://img.shields.io/badge/Windows-macOS-Linux-0078D6?labelColor=0078D6&color=C0C0C0" alt="Windows/macOS/Linux"></a>
+  <a href="https://github.com/sleepinginsummer/agent-ssh-cli/releases"><img src="https://img.shields.io/badge/release-v0.2.0-blue" alt="release v0.2.0"></a>
   <a href="https://github.com/sleepinginsummer/agent-ssh-cli/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen" alt="PRs welcome"></a>
 </p>
 
@@ -52,7 +52,9 @@
 - 本机网络可访问目标 SSH 服务器
 - 目标服务器已开启 SSH 服务
 - 如使用私钥认证，私钥文件需对当前用户可读
-- `agentsshcli exec/upload/download` 的连接缓存支持 macOS/Linux/Windows
+- 当前版本内部执行器已迁移到 Rust，npm 仍作为安装入口
+- `agentsshcli exec/upload/download` 默认使用 Rust daemon 连接缓存，也可以通过 `--no-cache` 直连
+- 预编译平台包支持 macOS arm64/x64、Linux x64/arm64、Windows x64
 
 ### 安装步骤
 
@@ -67,6 +69,44 @@ agentsshcli --help
 
 打开 [SKILL.md](SKILL.md)，将其添加到 agent 中。
 
+### 本地开发构建
+
+当前仓库保留 npm 安装入口，实际执行逻辑由 Rust 原生二进制完成。开发或源码安装时需要先构建原生二进制：
+
+```bash
+npm run build:native
+npm run build:native-bin
+npm run build:native-package
+npm test
+```
+
+执行链路：
+
+```text
+agentsshcli 命令
+  -> bin/agentsshcli.js
+  -> native/target/release/agentsshcli-native
+```
+
+已由 Rust 实现：
+
+- `agentsshcli list`
+- `agentsshcli init-config`
+- `agentsshcli exec ...` / `agentsshcli exec --no-cache ...`
+- `agentsshcli upload ...` / `agentsshcli upload --no-cache ...`
+- `agentsshcli download ...` / `agentsshcli download --no-cache ...`
+- Rust daemon 连接缓存与 `--cache-ttl`
+
+发布 npm 包前先生成对应平台的预编译产物和平台子包，并检查包内容：
+
+```bash
+npm run build:native-package
+npm pack --dry-run
+(cd npm/darwin-arm64 && npm pack --dry-run)
+```
+
+发布形态为主包 `agent-ssh-cli` 加平台 optional 子包：`@agent-ssh-cli/darwin-arm64`、`@agent-ssh-cli/darwin-x64`、`@agent-ssh-cli/linux-x64`、`@agent-ssh-cli/linux-arm64`、`@agent-ssh-cli/win32-x64`。预编译产物目录格式：`native-bin/<platform>-<arch>/agentsshcli-native`，Windows 文件名为 `agentsshcli-native.exe`。
+
 ## 配置
 
 初始化配置（格式参数和ssh-mcp-server一致）：
@@ -147,6 +187,7 @@ AGENT_SSH_CONFIG=/path/to/config.json
 
 ```bash
 agentsshcli list
+agentsshcli exec --no-cache 密码服务器 "pwd"
 ```
 
 完成安装!

package/bin/agentsshcli.js

@@ -1,7 +1,56 @@
 #!/usr/bin/env node
-import { runAgentSshCli } from "../src/cli.js";
+import { createRequire } from "node:module";
+import { spawnSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
 
-runAgentSshCli(process.argv.slice(2)).catch((error) => {
-  console.error(error.message);
+const require = createRequire(import.meta.url);
+const currentDir = path.dirname(fileURLToPath(import.meta.url));
+const projectRoot = path.resolve(currentDir, "..");
+
+function getExecutableName() {
+  return process.platform === "win32" ? "agentsshcli-native.exe" : "agentsshcli-native";
+}
+
+function getPlatformPackageBinary() {
+  const packageName = `@agent-ssh-cli/${process.platform}-${process.arch}`;
+  try {
+    const packageJsonPath = require.resolve(`${packageName}/package.json`);
+    return path.join(path.dirname(packageJsonPath), "bin", getExecutableName());
+  } catch {
+    return undefined;
+  }
+}
+
+function getCandidatePaths() {
+  const executableName = getExecutableName();
+  return [
+    getPlatformPackageBinary(),
+    path.join(projectRoot, "native-bin", `${process.platform}-${process.arch}`, executableName),
+    path.join(projectRoot, "native-bin", executableName),
+    path.join(projectRoot, "native", "target", "release", executableName),
+    path.join(projectRoot, "native", "target", "debug", executableName)
+  ].filter(Boolean);
+}
+
+function findNativeBinary() {
+  return getCandidatePaths().find((candidate) => fs.existsSync(candidate));
+}
+
+const binaryPath = findNativeBinary();
+if (!binaryPath) {
+  console.error(`未找到 ${process.platform}-${process.arch} 的 Rust 原生可执行文件，请安装对应平台包或先运行 npm run build:native-bin`);
   process.exit(1);
+}
+
+const result = spawnSync(binaryPath, process.argv.slice(2), {
+  stdio: "inherit"
 });
+
+if (result.error) {
+  console.error(result.error.message);
+  process.exit(1);
+}
+
+process.exit(result.status ?? 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-ssh-cli",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "基于 CLI 的 SSH 代理工具，按 ssh-mcp-server 的能力一一映射",
   "type": "module",
   "engines": {
@@ -9,7 +9,6 @@
   },
   "files": [
     "bin/",
-    "src/",
     "example.config.json",
     "README.md"
   ],
@@ -17,9 +16,17 @@
     "agentsshcli": "bin/agentsshcli.js"
   },
   "scripts": {
-    "test": "node --check bin/agentsshcli.js && node --check src/cli.js && node --check src/config.js && node --check src/daemon-client.js && node --check src/daemon-paths.js && node --check src/ssh-client.js && node --check src/ssh-daemon.js"
+    "test": "node --check bin/agentsshcli.js && cargo test --manifest-path native/Cargo.toml",
+    "build:native": "cargo build --release --manifest-path native/Cargo.toml",
+    "test:native": "cargo test --manifest-path native/Cargo.toml",
+    "build:native-bin": "node scripts/build-native-bin.js",
+    "build:native-package": "npm run build:native-bin && node scripts/build-native-package.js"
   },
-  "dependencies": {
-    "ssh2": "^1.17.0"
+  "optionalDependencies": {
+    "@agent-ssh-cli/darwin-arm64": "0.2.0",
+    "@agent-ssh-cli/darwin-x64": "0.2.0",
+    "@agent-ssh-cli/linux-x64": "0.2.0",
+    "@agent-ssh-cli/win32-x64": "0.2.0",
+    "@agent-ssh-cli/linux-arm64": "0.2.0"
   }
 }

package/src/cli.js

@@ -1,464 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import process from "node:process";
-import { fileURLToPath } from "node:url";
-import { loadConfig, findConnection, validateLocalPath, getDefaultConfigPath } from "./config.js";
-import { requestDaemon } from "./daemon-client.js";
-import { normalizeCacheTtl } from "./daemon-paths.js";
-import { executeRemoteCommand, uploadFile, downloadFile } from "./ssh-client.js";
-
-const currentDir = path.dirname(fileURLToPath(import.meta.url));
-const packageJson = JSON.parse(fs.readFileSync(path.join(currentDir, "..", "package.json"), "utf8"));
-
-const HELP_TEXT = {
-  agentsshcli: `
-用法:
-  agentsshcli list [--config <path>] [--json]
-  agentsshcli exec [--config <path>] [--no-cache] [--cache-ttl <ms>] <connectionName> <command>
-  agentsshcli exec [--config <path>] [--no-cache] [--cache-ttl <ms>] --connection <name> --command <command> [--directory <dir>] [--timeout <ms>]
-  agentsshcli upload [--config <path>] [--no-cache] [--cache-ttl <ms>] <connectionName> <localPath> <remotePath>
-  agentsshcli upload [--config <path>] [--no-cache] [--cache-ttl <ms>] --connection <name> --local <path> --remote <path>
-  agentsshcli download [--config <path>] [--no-cache] [--cache-ttl <ms>] <connectionName> <remotePath> <localPath>
-  agentsshcli download [--config <path>] [--no-cache] [--cache-ttl <ms>] --connection <name> --remote <path> --local <path>
-  agentsshcli init-config
-  agentsshcli help [list|exec|upload|download]
-  agentsshcli --help
-  agentsshcli --version
-
-说明:
-  agent-ssh-cli 统一入口。
-`,
-  sshls: `
-用法:
-  agentsshcli list [--config <path>] [--json]
-  agentsshcli help list
-  agentsshcli --version
-
-说明:
-  列出当前配置文件中的 SSH 连接。
-`,
-  sshx: `
-用法:
-  agentsshcli exec [--config <path>] [--no-cache] [--cache-ttl <ms>] <connectionName> <command>
-  agentsshcli exec [--config <path>] [--no-cache] [--cache-ttl <ms>] --connection <name> --command <command> [--directory <dir>] [--timeout <ms>]
-  agentsshcli help exec
-  agentsshcli --version
-
-说明:
-  在远端执行命令。
-`,
-  sshupload: `
-用法:
-  agentsshcli upload [--config <path>] [--no-cache] [--cache-ttl <ms>] <connectionName> <localPath> <remotePath>
-  agentsshcli upload [--config <path>] [--no-cache] [--cache-ttl <ms>] --connection <name> --local <path> --remote <path>
-  agentsshcli help upload
-  agentsshcli --version
-
-说明:
-  上传本地文件到远端。
-`,
-  sshdownload: `
-用法:
-  agentsshcli download [--config <path>] [--no-cache] [--cache-ttl <ms>] <connectionName> <remotePath> <localPath>
-  agentsshcli download [--config <path>] [--no-cache] [--cache-ttl <ms>] --connection <name> --remote <path> --local <path>
-  agentsshcli help download
-  agentsshcli --version
-
-说明:
-  下载远端文件到本地。
-`
-};
-
-function printHelp(commandName) {
-  process.stdout.write(`${HELP_TEXT[commandName].trim()}\n`);
-}
-
-function printVersion() {
-  process.stdout.write(`${packageJson.version}\n`);
-}
-
-function getHelpName(commandName) {
-  const names = {
-    list: "sshls",
-    exec: "sshx",
-    upload: "sshupload",
-    download: "sshdownload"
-  };
-  return names[commandName] || commandName;
-}
-
-function initConfig() {
-  const target = getDefaultConfigPath();
-  const source = path.join(currentDir, "..", "example.config.json");
-  if (fs.existsSync(target)) {
-    throw new Error(`${target} 已存在，未覆盖`);
-  }
-  fs.mkdirSync(path.dirname(target), { recursive: true, mode: 0o700 });
-  fs.copyFileSync(source, target);
-  process.stdout.write(`已创建 ${target}\n`);
-}
-
-function parseGlobalArgs(argv) {
-  const args = [...argv];
-  let configPath = getDefaultConfigPath();
-  let help = false;
-  let version = false;
-  let json = false;
-  let noCache = false;
-  let cacheTtlMs;
-  const remaining = [];
-
-  while (args.length > 0) {
-    const current = args.shift();
-    if (current === "--help" || current === "-h") {
-      help = true;
-      continue;
-    }
-    if (current === "--version" || current === "-v") {
-      version = true;
-      continue;
-    }
-    if (current === "--json") {
-      json = true;
-      continue;
-    }
-    if (current === "--no-cache") {
-      noCache = true;
-      continue;
-    }
-    if (current === "--cache-ttl") {
-      const value = args.shift();
-      if (!value) {
-        throw new Error("--cache-ttl 缺少毫秒值");
-      }
-      cacheTtlMs = normalizeCacheTtl(value);
-      continue;
-    }
-    if (current === "--config") {
-      const value = args.shift();
-      if (!value) {
-        throw new Error("--config 缺少路径");
-      }
-      configPath = path.resolve(value);
-      continue;
-    }
-    remaining.push(current, ...args);
-    break;
-  }
-
-  return {
-    configPath,
-    help,
-    version,
-    json,
-    noCache,
-    cacheTtlMs,
-    args: remaining
-  };
-}
-
-function findOptionIndexes(args, names) {
-  const indexes = [];
-  for (let index = 0; index < args.length; index += 1) {
-    if (names.includes(args[index])) {
-      indexes.push(index);
-    }
-  }
-  return indexes;
-}
-
-function takeOption(args, names) {
-  const indexes = findOptionIndexes(args, names);
-  if (indexes.length > 1) {
-    throw new Error(`参数重复声明: ${names[0]}`);
-  }
-  if (indexes.length === 0) {
-    return {
-      present: false,
-      value: undefined
-    };
-  }
-  const index = indexes[0];
-  const value = args[index + 1];
-  if (!value || value.startsWith("--")) {
-    throw new Error(`${args[index]} 缺少参数值`);
-  }
-  args.splice(index, 2);
-  return {
-    present: true,
-    value
-  };
-}
-
-function ensureNoUnknownOptions(args) {
-  const unknown = args.find((item) => item.startsWith("--"));
-  if (unknown) {
-    throw new Error(`不支持的参数: ${unknown}`);
-  }
-}
-
-function ensureNoExtraPositionals(args) {
-  if (args.length > 0) {
-    throw new Error(`存在多余的位置参数: ${args.join(" ")}`);
-  }
-}
-
-function takePositional(args, fieldName) {
-  const value = args.shift();
-  if (value && value.startsWith("--")) {
-    throw new Error(`${fieldName} 位置参数非法: ${value}`);
-  }
-  return value;
-}
-
-function ensureNoMixedInput(namedValue, positionalValue, fieldName) {
-  if (namedValue !== undefined && positionalValue !== undefined) {
-    throw new Error(`${fieldName} 同时使用了命名参数和位置参数，保留一种即可`);
-  }
-}
-
-function resolveValue(args, optionNames, fieldName) {
-  const namedOption = takeOption(args, optionNames);
-  if (namedOption.present) {
-    return namedOption.value;
-  }
-  return takePositional(args, fieldName);
-}
-
-function parseListArgs(argv) {
-  const parsed = parseGlobalArgs(argv);
-  if (parsed.help || parsed.version) {
-    return parsed;
-  }
-  if (parsed.args.length > 0) {
-    throw new Error(`agentsshcli list 不接受位置参数: ${parsed.args.join(" ")}`);
-  }
-  return parsed;
-}
-
-function parseExecuteArgs(argv) {
-  const parsed = parseGlobalArgs(argv);
-  if (parsed.help || parsed.version) {
-    return parsed;
-  }
-  const args = [...parsed.args];
-  const connectionNameOption = takeOption(args, ["--connection", "-c"]);
-  const commandOption = takeOption(args, ["--command"]);
-  const directoryOption = takeOption(args, ["--directory", "-d"]);
-  const timeoutOption = takeOption(args, ["--timeout", "-t"]);
-  const connectionNamePositional = takePositional(args, "connectionName");
-  const commandPositional = takePositional(args, "command");
-
-  ensureNoMixedInput(connectionNameOption.present ? connectionNameOption.value : undefined, connectionNamePositional, "connectionName");
-  ensureNoMixedInput(commandOption.present ? commandOption.value : undefined, commandPositional, "command");
-
-  const connectionName = connectionNameOption.present ? connectionNameOption.value : connectionNamePositional;
-  const command = commandOption.present ? commandOption.value : commandPositional;
-  const directory = directoryOption.present ? directoryOption.value : undefined;
-  const timeoutValue = timeoutOption.present ? timeoutOption.value : undefined;
-  for (let index = 0; index < args.length; index += 1) {
-    if (args[index]?.startsWith("--")) {
-      throw new Error(`不支持的参数: ${args[index]}`);
-    }
-  }
-  ensureNoUnknownOptions(args);
-  ensureNoExtraPositionals(args);
-  if (!connectionName || !command) {
-    throw new Error("缺少必填参数 connectionName 或 command，使用 --help 查看说明");
-  }
-  const timeout = timeoutValue === undefined ? 30000 : Number(timeoutValue);
-  if (!Number.isFinite(timeout) || timeout <= 0) {
-    throw new Error("timeout 必须是正整数毫秒值");
-  }
-  return {
-    ...parsed,
-    connectionName,
-    command,
-    directory,
-    timeout
-  };
-}
-
-function parseTransferArgs(argv, mode) {
-  const parsed = parseGlobalArgs(argv);
-  if (parsed.help || parsed.version) {
-    return parsed;
-  }
-  const args = [...parsed.args];
-  const connectionName = resolveValue(args, ["--connection", "-c"], "connectionName");
-  const localOptionNames = ["--local", "-l"];
-  const remoteOptionNames = ["--remote", "-r"];
-  let localPath;
-  let remotePath;
-
-  if (mode === "upload") {
-    localPath = resolveValue(args, localOptionNames, "localPath");
-    remotePath = resolveValue(args, remoteOptionNames, "remotePath");
-  } else {
-    remotePath = resolveValue(args, remoteOptionNames, "remotePath");
-    localPath = resolveValue(args, localOptionNames, "localPath");
-  }
-
-  ensureNoUnknownOptions(args);
-  ensureNoExtraPositionals(args);
-
-  if (!connectionName || !localPath || !remotePath) {
-    throw new Error("缺少必填参数，使用 --help 查看说明");
-  }
-
-  return {
-    ...parsed,
-    connectionName,
-    localPath,
-    remotePath
-  };
-}
-
-export async function runListServers(argv) {
-  const parsed = parseListArgs(argv);
-  if (parsed.help) {
-    printHelp("sshls");
-    return;
-  }
-  if (parsed.version) {
-    printVersion();
-    return;
-  }
-  const configs = loadConfig(parsed.configPath);
-  const output = configs.map((item) => ({
-    name: item.name,
-    host: item.host,
-    port: item.port,
-    username: item.username
-  }));
-  process.stdout.write(`${JSON.stringify(output, null, 2)}\n`);
-}
-
-export async function runExecute(argv) {
-  const parsed = parseExecuteArgs(argv);
-  if (parsed.help) {
-    printHelp("sshx");
-    return;
-  }
-  if (parsed.version) {
-    printVersion();
-    return;
-  }
-  const configs = loadConfig(parsed.configPath);
-  const connection = findConnection(configs, parsed.connectionName);
-  const result = parsed.noCache
-    ? await executeRemoteCommand(connection, parsed.command, parsed.directory, parsed.timeout)
-    : (await requestDaemon(parsed.configPath, {
-        operation: "execute",
-        configPath: parsed.configPath,
-        cwd: process.cwd(),
-        connectionName: parsed.connectionName,
-        command: parsed.command,
-        directory: parsed.directory,
-        timeout: parsed.timeout,
-        cacheTtlMs: parsed.cacheTtlMs
-      })).stdout;
-  if (result) {
-    process.stdout.write(`${result}\n`);
-  }
-}
-
-export async function runUpload(argv) {
-  const parsed = parseTransferArgs(argv, "upload");
-  if (parsed.help) {
-    printHelp("sshupload");
-    return;
-  }
-  if (parsed.version) {
-    printVersion();
-    return;
-  }
-  const configs = loadConfig(parsed.configPath);
-  const connection = findConnection(configs, parsed.connectionName);
-  if (parsed.noCache) {
-    const validatedLocalPath = validateLocalPath(configs, parsed.localPath);
-    await uploadFile(connection, validatedLocalPath, parsed.remotePath);
-  } else {
-    await requestDaemon(parsed.configPath, {
-      operation: "upload",
-      configPath: parsed.configPath,
-      cwd: process.cwd(),
-      connectionName: parsed.connectionName,
-      localPath: parsed.localPath,
-      remotePath: parsed.remotePath,
-      cacheTtlMs: parsed.cacheTtlMs
-    });
-  }
-  process.stdout.write("File uploaded successfully\n");
-}
-
-export async function runDownload(argv) {
-  const parsed = parseTransferArgs(argv, "download");
-  if (parsed.help) {
-    printHelp("sshdownload");
-    return;
-  }
-  if (parsed.version) {
-    printVersion();
-    return;
-  }
-  const configs = loadConfig(parsed.configPath);
-  const connection = findConnection(configs, parsed.connectionName);
-  if (parsed.noCache) {
-    const validatedLocalPath = validateLocalPath(configs, parsed.localPath);
-    fs.mkdirSync(path.dirname(validatedLocalPath), { recursive: true });
-    await downloadFile(connection, parsed.remotePath, validatedLocalPath);
-  } else {
-    await requestDaemon(parsed.configPath, {
-      operation: "download",
-      configPath: parsed.configPath,
-      cwd: process.cwd(),
-      connectionName: parsed.connectionName,
-      localPath: parsed.localPath,
-      remotePath: parsed.remotePath,
-      cacheTtlMs: parsed.cacheTtlMs
-    });
-  }
-  process.stdout.write("File downloaded successfully\n");
-}
-
-export async function runAgentSshCli(argv) {
-  const [command, ...args] = argv;
-  if (!command || command === "--help" || command === "-h") {
-    printHelp("agentsshcli");
-    return;
-  }
-  if (command === "--version" || command === "-v" || command === "version") {
-    printVersion();
-    return;
-  }
-  if (command === "help") {
-    const target = getHelpName(args[0] || "agentsshcli");
-    if (!HELP_TEXT[target]) {
-      throw new Error(`未知帮助命令: ${args[0]}`);
-    }
-    printHelp(target);
-    return;
-  }
-  if (command === "init-config") {
-    initConfig();
-    return;
-  }
-  if (command === "list") {
-    await runListServers(args);
-    return;
-  }
-  if (command === "exec") {
-    await runExecute(args);
-    return;
-  }
-  if (command === "upload") {
-    await runUpload(args);
-    return;
-  }
-  if (command === "download") {
-    await runDownload(args);
-    return;
-  }
-  throw new Error(`未知命令: ${command}，使用 agentsshcli --help 查看说明`);
-}