agent-ssh-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 syy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,168 @@
+<div align="center">
+
+# agent-ssh-cli
+
+基于 CLI 的 SSH 代理工具，按 ssh-mcp-server 的能力映射为 Agent 可调用的远端操作能力。
+
+远程执行 · 文件上传 · 文件下载 · 连接配置 · 命令白名单 · 命令黑名单 · Agent Skill 集成
+
+<p>
+  <a href="https://github.com/sleepinginsummer/agent-ssh-cli"><img src="https://img.shields.io/badge/CLI-agentsshcli-2ea44f" alt="CLI agentsshcli"></a>
+  <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/releases"><img src="https://img.shields.io/badge/release-v0.1.0-blue" alt="release v0.1.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>
+
+[AI 一键安装](#ai-一键安装) · [手动安装](#手动安装) · [配置](#配置) · [卸载和清理](#卸载和清理) · [许可证](#许可证) · [友情链接](#友情链接)
+
+中文 | [English](README_EN.md)
+
+</div>
+
+## 简介
+本项目参考 [classfang/ssh-mcp-server](https://github.com/classfang/ssh-mcp-server) 的 SSH 操作能力设计，改写为独立 CLI 形式。感谢原项目提供的思路和能力基础。
+
+#### 他能做的事：
+- 解放双手，自动运维服务器
+- 部署代码，更新部署docker
+- 配置nginx,配置证书
+- 所有ssh能做到的事情
+#### 他的能力：
+- 列出本地配置中的 SSH 服务器连接
+- 在指定远端服务器上执行命令
+- 上传本地文件到远端服务器
+- 从远端服务器下载文件到本地
+- 通过命令黑白名单限制可执行命令
+- 通过本地路径白名单限制上传和下载访问范围
+
+## AI 一键安装
+
+```
+安装请阅读 https://github.com/sleepinginsummer/agent-ssh-cli/blob/main/AI_INSTALL.md，按说明安装 CLI 并添加 `SKILL.md`。
+```
+
+## 手动安装
+### 环境要求
+
+- Node.js `>= 18`
+- npm `>= 8`
+- 本机网络可访问目标 SSH 服务器
+- 目标服务器已开启 SSH 服务
+- 如使用私钥认证，私钥文件需对当前用户可读
+- `agentsshcli exec/upload/download` 的连接缓存支持 macOS/Linux/Windows
+
+### 安装步骤
+
+1. 全局安装：
+
+```bash
+npm install -g agent-ssh-cli
+agentsshcli --help
+```
+
+2. 导入 SKILL.md:
+
+打开 [SKILL.md](SKILL.md)，将其添加到 agent 中。
+
+## 配置
+
+初始化配置（格式参数和ssh-mcp-server一致）：
+
+```bash
+mkdir -p ~/.agent-ssh-cli
+```
+
+编辑 `~/.agent-ssh-cli/config.json`，填写真实连接信息。默认配置文件也可以通过环境变量覆盖：
+
+可以通过以下环境变量修改配置地点
+```bash
+AGENT_SSH_CONFIG=/path/to/config.json
+```
+
+配置文件是数组，每一项是一台服务器：
+
+- `name`: 连接名，必须唯一
+- `host`: SSH 主机地址
+- `username`: SSH 用户名
+- `password` / `privateKey` / `agent`: 认证方式，三者必须且只能配置一个
+- `port`: SSH 端口，默认 `22`
+- `passphrase`: 私钥口令，仅配合 `privateKey` 使用
+- `pty`: 是否分配伪终端，默认 `true`
+- `allowedLocalPaths`: 额外允许上传或下载写入的本地路径
+- `commandWhitelist`: 命令白名单正则数组
+- `commandBlacklist`: 命令黑名单正则数组
+
+`commandWhitelist` 和 `commandBlacklist` 使用 JavaScript `RegExp` 语法，不是 POSIX 正则；空白字符请写成 `\\s`，不要写 `[:space:]`。
+
+完整示例见 [example.config.json](example.config.json)。`~/.agent-ssh-cli/config.json` 保存真实连接信息。
+
+参考配置
+
+```json
+[
+  {
+    "name": "密码服务器",
+    "host": "192.0.2.10",
+    "port": 22,
+    "username": "root",
+    "password": "******",
+    "commandBlacklist": [
+      "(^|[;&|()\\s])rm(\\s|$)",
+      "(^|[;&|()\\s])shutdown(\\s|$)",
+      "(^|[;&|()\\s])reboot(\\s|$)"
+    ]
+  },
+  {
+    "name": "密钥服务器",
+    "host": "198.51.100.10",
+    "port": 22,
+    "username": "deploy",
+    "privateKey": "/path/to/id_rsa",
+    "passphrase": "******",
+    "pty": false,
+    "allowedLocalPaths": [
+      "./tmp",
+      "./dist"
+    ],
+    "commandWhitelist": [
+      "^pwd$",
+      "^ls(\\s|$)",
+      "^cat\\s+/var/log/app\\.log$"
+    ],
+    "commandBlacklist": [
+      "(^|[;&|()\\s])rm(\\s|$)",
+      "(^|[;&|()\\s])shutdown(\\s|$)",
+      "(^|[;&|()\\s])reboot(\\s|$)"
+    ]
+  }
+]
+```
+
+
+
+测试命令
+
+```bash
+agentsshcli list
+```
+
+完成安装!
+
+## 卸载和清理
+
+```bash
+npm uninstall -g agent-ssh-cli
+npm cache clean --force
+#删除配置文件
+rm -rf ~/.agent-ssh-cli
+```
+
+## 许可证
+
+[MIT](LICENSE)
+
+## 友情链接
+
+- [LINUX DO - 新的理想型社区](https://linux.do/)

package/bin/agentsshcli.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { runAgentSshCli } from "../src/cli.js";
+
+runAgentSshCli(process.argv.slice(2)).catch((error) => {
+  console.error(error.message);
+  process.exit(1);
+});

package/example.config.json

@@ -0,0 +1,40 @@
+[
+  {
+    "name": "密码服务器",
+    "host": "192.0.2.10",
+    "port": 22,
+    "username": "root",
+    "password": "******",
+    "allowedLocalPaths": [
+      "./tmp"
+    ],
+    "commandBlacklist": [
+      "(^|[;&|()\\s])rm(\\s|$)",
+      "(^|[;&|()\\s])shutdown(\\s|$)",
+      "(^|[;&|()\\s])reboot(\\s|$)"
+    ]
+  },
+  {
+    "name": "密钥服务器",
+    "host": "198.51.100.10",
+    "port": 22,
+    "username": "deploy",
+    "privateKey": "/path/to/id_rsa",
+    "passphrase": "******",
+    "pty": false,
+    "allowedLocalPaths": [
+      "./tmp",
+      "./dist"
+    ],
+    "commandWhitelist": [
+      "^pwd$",
+      "^ls(\\s|$)",
+      "^cat\\s+/var/log/app\\.log$"
+    ],
+    "commandBlacklist": [
+      "(^|[;&|()\\s])rm(\\s|$)",
+      "(^|[;&|()\\s])shutdown(\\s|$)",
+      "(^|[;&|()\\s])reboot(\\s|$)"
+    ]
+  }
+]

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "agent-ssh-cli",
+  "version": "0.1.0",
+  "description": "基于 CLI 的 SSH 代理工具，按 ssh-mcp-server 的能力一一映射",
+  "type": "module",
+  "engines": {
+    "node": ">=18",
+    "npm": ">=8"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "example.config.json",
+    "README.md"
+  ],
+  "bin": {
+    "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"
+  },
+  "dependencies": {
+    "ssh2": "^1.17.0"
+  }
+}