本项目支持 XEnvManager 协议
\n\nVibeCoding 的时候，我突然想到，能不能让 agent 帮我上服务器部署代码呢，于是，我开发了\n\n![](\"logo.png\")
\n\n**OctSSH** 是一个 MCP 服务，允许 LLM **安全、可控**地访问您的服务器 shell 环境。\n\n### 注意\n**默认模式（stdio）下，OctSSH 只支持连接到您本机 `ssh_config` 中配置好的免密登录的机器。**\n\n---\n\n> [!TIP]\n> **那么... OctSSH 有什么特别之处呢？**\n\n## 异步支持\n\nOctSSH 提供了一套完整的异步任务工具，防止 LLM 等待长任务超时：\n\n| 工具 | 说明 |\n|:---|:---|\n| `exec(machine, command, confirm_code?)` | 同步执行短命令 |\n| `sudo-exec(machine, command, confirm_code?)` | 以 root 身份同步执行 (sudo -n) |\n| `exec-async(machine, command, confirm_code?)` | 后台运行长任务 (screen) |\n| `exec-async-sudo(...)` | 以 root 身份后台运行 |\n| `write-stdin(session_id, data, append_newline?)` | 向运行中的异步任务写入 stdin |\n| `get-result(session_id, lines?)` | 查看异步任务输出 |\n| `grep-result(session_id, pattern, ...)` | 搜索任务日志 |\n| `cancel(session_id)` | 终止任务 |\n| `sleep(time)` | 暂停（轮询场景适用） |\n\n> **注意**：在 **HTTP Serve 模式**下，上述工具直接作用于本机，不需要 `machine` 参数。\n\n## 安全设计\n\nOctSSH 设计了一套 **Virtual Mode** 操作模式和 **Confirm Code** 安全验证，工作流程如下：\n\n### 🔒 安全机制：Virtual Mode\n\n我们不希望 AI 变成毁灭世界的终结者，所以设计了 Virtual Mode。\n当 AI 尝试以下操作时，OctSSH **不会直接执行**，而是返回 `confirm_code` 确认码：\n\n- 📁 **文件覆盖**：上传的目标路径已存在同名文件\n- 💀 **高危指令**：`rm -rf` 等“删库跑路”级命令\n- 🔍 **正则拦截**：配置中自定义的敏感模式\n\n**执行流程示例**：\n1. AI 调用 `exec(\"web\", \"rm -rf /var/www/html\")`\n2. 🛑 OctSSH 拦截：该操作将递归删除目录 -> 返回 `confirm_code: a1b2c3` + 受影响文件预览\n3. 👤 用户检查后告诉 AI：\"确认执行\"\n4. ✅ AI 调用 `exec(\"web\", \"rm -rf /var/www/html\", \"a1b2c3\")` -> 真正执行\n\n## 快速开始\n\n### 安装\n\n```bash\nnpm install -g @aliyahzombie/octssh\noctssh init\n```\n\n### 启动模式\n\n#### 1. 默认 Client 模式 (stdio)\n在本地运行，通过 SSH 控制远程机器（读取 `~/.ssh/config`）：\n```bash\noctssh\n```\n\n#### 2. Streamable HTTP Server 模式 (本机控制)\n安装在**目标机器**上，通过 HTTP 接口控制该机器本身（无需 SSH 中转，适合反向代理或远程直连）。\n在此模式下，OctSSH 仅控制**本机**。\n\n```bash\noctssh serve\n```\n- **默认监听**：`127.0.0.1:8787` (可通过 `OCTSSH_SERVE_HOST` / `OCTSSH_SERVE_PORT` 覆盖)\n- **认证**：启动时会打印随机生成的 Key；客户端需带 Header `X-OctSSH-Key: