@bingzi-233/ssh-mcp 1.3.0 → 1.5.0

package/README.md

@@ -1,6 +1,6 @@
 # ssh-mcp
 
-纯命令行 SSH/SFTP 工具：在多台远程服务器上执行命令、传输大文件（断点续传）。支持 CLI 模式和 MCP stdio 模式（`--mcp`）。
+纯命令行 SSH/SFTP 工具：远程执行命令、批量操作、大文件传输（断点续传）、端口转发、健康检查、配置对比、快照打包、tail -f、watch 等 27 个子命令。CLI + MCP 双模式。
 
 [![NPM](https://img.shields.io/npm/v/@bingzi-233/ssh-mcp?color=CB3837&logo=npm)](https://www.npmjs.com/package/@bingzi-233/ssh-mcp)
 [![Node](https://img.shields.io/node/v/@bingzi-233/ssh-mcp?color=339933&logo=nodedotjs)](https://nodejs.org)
@@ -12,26 +12,16 @@
 ## CLI 快速上手
 
 ```bash
-# 安装
 npm i -g @bingzi-233/ssh-mcp
 
-# 查看帮助
-ssh-mcp --help
-
-# 列出服务器
-ssh-mcp list-servers
-
-# 执行远程命令
-ssh-mcp run-command -s prod-web -c "df -h /"
-
-# 上传文件（支持断点续传）
-ssh-mcp upload -s prod-web -l ./dist.tar.gz -r /tmp/dist.tar.gz
-
-# 下载文件
-ssh-mcp download -s prod-web -r /var/log/app.log -l ./logs/app.log
-
-# 传输进度
-ssh-mcp transfer-status
+ssh-mcp list-servers                                     # 列出服务器
+ssh-mcp run-command -s prod-web -c "df -h /"             # 执行命令
+ssh-mcp batch --servers web1,web2,web3 -c "uptime"       # 批量执行
+ssh-mcp upload -s prod-web -l ./dist.tar.gz -r /tmp/     # 上传文件
+ssh-mcp health -s prod-web                               # 健康检查
+ssh-mcp ls -s prod-web -p /var/log                       # 列出目录
+ssh-mcp tail-f -s prod-web -p /var/log/app.log           # 追尾日志
+ssh-mcp forward -s prod-web -L 8080:192.168.1.5:80       # 端口转发
 ```
 
 ## 命令一览
@@ -40,13 +30,23 @@ ssh-mcp transfer-status
 |---|---|
 | `list-servers` | 列出所有已配置的服务器 |
 | `run-command` | 在远程服务器上执行命令 |
-| `open-session` | 打开长连接会话（复用 TCP 连接） |
-| `close-session` | 关闭长连接会话 |
-| `list-sessions` | 列出当前所有长连接会话 |
-| `upload` | 上传文件到远程（后台任务，断点续传） |
-| `download` | 从远程下载文件（后台任务，断点续传） |
-| `transfer-status` | 查看传输进度 |
-| `cancel-transfer` | 取消传输 |
+| `batch` | 在多台服务器上批量执行同一命令 |
+| `open-session` / `close-session` / `list-sessions` | 长连接会话管理 |
+| `upload` / `download` | 大文件传输（后台任务，断点续传） |
+| `transfer-status` / `cancel-transfer` | 传输进度与取消 |
+| `forward` / `list-forwards` / `close-forward` | SSH 端口转发（本地/远程） |
+| `ls` / `stat` | 列出远程目录、查看文件信息 |
+| `rm` / `mkdir` | 删除远程文件/目录、创建远程目录 |
+| `health` | 一键健康检查（OS/磁盘/内存/负载/CPU） |
+| `cert-info` | 查看 SSL/TLS 证书信息 |
+| `copy-between` | 服务器间直传文件（不经本地中转） |
+| `diff-servers` | 对比两台服务器同一文件差异 |
+| `exec-script` | 上传脚本执行并自动清理 |
+| `snapshot` | 远程目录 tar.gz 打包下载 |
+| `tail-f` / `stop-tail` / `list-tails` | 持续追踪远程文件（SFTP） |
+| `watch` / `stop-watch` / `list-watches` | 定时重复执行命令并高亮差异 |
+| `curl` | 从远程服务器发起 HTTP 请求 |
+| `env` | 收集远程服务器环境信息 |
 
 每个子命令运行 `ssh-mcp <子命令> --help` 查看详细用法。
 
@@ -56,24 +56,15 @@ ssh-mcp transfer-status
 
 ```json
 {
-  "security": {
-    "blocked_patterns": []
-  },
+  "security": { "blocked_patterns": [] },
   "servers": [
     {
       "name": "prod-web",
-      "description": "生产环境 Web 服务器",
+      "description": "生产环境",
       "host": "192.168.1.10",
       "port": 22,
       "username": "deploy",
       "privateKeyPath": "~/.ssh/id_rsa"
-    },
-    {
-      "name": "db",
-      "description": "数据库服务器",
-      "host": "db.example.com",
-      "username": "admin",
-      "password": "your-password"
     }
   ]
 }
@@ -81,16 +72,24 @@ ssh-mcp transfer-status
 
 鉴权优先级：私钥 → 密码 → ssh-agent。修改配置无需重启。
 
-## 长连接会话
+## 端口转发
 
 ```bash
-SID=$(ssh-mcp open-session -s prod-web)
-ssh-mcp run-command -s prod-web --session $SID -c "hostname"
-ssh-mcp run-command -s prod-web --session $SID -c "uptime"
-ssh-mcp close-session -s $SID
+# 本地转发：本机 8080 → 经 SSH 服务器 → 内网 192.168.1.5:80
+ssh-mcp forward -s prod-web -L 8080:192.168.1.5:80
+
+# 远程转发：SSH 服务器 9000 → 回传到本机 localhost:3000
+ssh-mcp forward -s prod-web -R 9000:127.0.0.1:3000
+
+ssh-mcp list-forwards
+ssh-mcp close-forward -i f1
 ```
 
-复用 TCP 连接，省去重复握手和认证。注意每条命令仍在独立 channel 中执行，不保留工作目录。
+## 批量执行
+
+```bash
+ssh-mcp batch --servers prod-web,prod-api,prod-worker -c "systemctl status nginx"
+```
 
 ## 安全策略
 
@@ -101,10 +100,7 @@ ssh-mcp close-session -s $SID
 以 MCP stdio 服务运行（供 Claude Code 等 AI 客户端调用）：
 
 ```bash
-# 手动注册
 claude mcp add ssh -- npx -y @bingzi-233/ssh-mcp --mcp
-
-# 或通过插件安装
 /plugin marketplace add BingZi-233/ssh-mcp
 /plugin install ssh-mcp@bingzi-plugins
 ```

package/dist/forward.js

@@ -0,0 +1,108 @@
+import { createServer, Socket } from "node:net";
+import { createConnection } from "./ssh.js";
+const forwards = new Map();
+/** 存活的本地 net.Server / SSH 连接，用于关闭 */
+const resources = new Map();
+let counter = 0;
+function track(id, conn, server) {
+    resources.set(id, { conn, server });
+    conn.on("close", () => {
+        const f = forwards.get(id);
+        if (f)
+            f.state = "stopped";
+        server?.close();
+    });
+    conn.on("error", () => {
+        const f = forwards.get(id);
+        if (f)
+            f.state = "stopped";
+        server?.close();
+    });
+}
+/**
+ * 启动端口转发。
+ *
+ * type=local: 监听本机 localPort，流量经 SSH 服务器转发到 remoteHost:remotePort。
+ * type=remote: SSH 服务器监听 remotePort，流量经本机转发到 localHost:localPort。
+ */
+export async function startForward(cfg, type, localHost, localPort, remoteHost, remotePort) {
+    const conn = await createConnection(cfg, 20_000);
+    const id = `f${++counter}`;
+    if (type === "local") {
+        await new Promise((resolve, reject) => {
+            const server = createServer((socket) => {
+                conn.forwardOut(localHost, localPort, remoteHost, remotePort, (err, stream) => {
+                    if (err) {
+                        socket.destroy();
+                        return;
+                    }
+                    socket.pipe(stream).pipe(socket);
+                    stream.on("error", () => socket.destroy());
+                    socket.on("error", () => stream.destroy());
+                });
+            });
+            server.on("error", reject);
+            server.listen(localPort, localHost, () => {
+                server.removeListener("error", reject);
+                track(id, conn, server);
+                resolve();
+            });
+        });
+    }
+    else {
+        // remote: SSH 服务器暴露端口，转发回本机
+        await new Promise((resolve, reject) => {
+            conn.forwardIn(remoteHost, remotePort, (err) => {
+                if (err)
+                    reject(err);
+                else {
+                    track(id, conn);
+                    resolve();
+                }
+            });
+        });
+        // 处理来自远程的入站连接
+        conn.on("tcp connection", (info, accept) => {
+            const stream = accept();
+            const sock = new Socket();
+            sock.connect(remotePort, localHost, () => {
+                sock.pipe(stream).pipe(sock);
+                stream.on("error", () => sock.destroy());
+                sock.on("error", () => stream.destroy());
+            });
+            sock.on("error", () => stream.end());
+        });
+    }
+    const fwd = {
+        id,
+        server: cfg.name,
+        type,
+        localHost,
+        localPort,
+        remoteHost,
+        remotePort,
+        state: "running",
+        createdAt: Date.now(),
+    };
+    forwards.set(id, fwd);
+    return fwd;
+}
+export function getForward(id) {
+    return forwards.get(id);
+}
+export function listForwards() {
+    return [...forwards.values()];
+}
+export function closeForward(id) {
+    const fwd = forwards.get(id);
+    if (!fwd || fwd.state === "stopped")
+        return false;
+    fwd.state = "stopped";
+    const res = resources.get(id);
+    if (res) {
+        res.server?.close();
+        res.conn.end();
+        resources.delete(id);
+    }
+    return true;
+}