Files
opsxshell/README.md
T

4.2 KiB
Raw Blame History

OpsXShell

轻量原生的跨平台 SSH / SFTP 运维终端。产品目标是让常用远程操作更直接,不做审计平台,也不依赖插件才能完成基础工作。

已支持

  • SSH 终端:密码、私钥、SSH Agent 自动尝试、主机指纹校验
  • 会话管理:分组、标签、快速连接、多标签、终端分屏
  • 批量命令:选中多个会话执行同一命令,结果仅保留在当前窗口
  • SFTP:双栏文件管理、断点续传、完整后原子替换、重命名、权限、远程文本编辑
  • 端口转发:本地、远程、动态 SOCKS5;规则可编辑和复制,与运行实例分离,支持真实启停和状态统计
  • 连接代理:HTTP CONNECT、SOCKS5,可选用户名密码
  • OpenSSH 配置:导入 ~/.ssh/config 常用字段;界面支持单跳选择,Rust 后端支持最多 8 跳
  • 系统链接:ssh://user@host:port 唤起已有或新启动的 OpsXShell,并进入预填充快速连接确认
  • 本地终端与串口:系统 Shell、串口设备与波特率配置
  • 终端 AI 助手:OpenAI/Responses/Anthropic 兼容 Provider、new-api 与 Ollama;支持建议、填入及经确认的当前 SSH 会话单次执行
  • 本地安全:AES-256-GCM 加密会话密码、密钥口令和模型 API Key,不保存终端命令或 AI 对话历史

产品边界

OpsXShell 聚焦 SSH、SFTP、代理、转发、串口和多终端工作区。审计、录像、审批等堡垒机能力不在产品范围内。

当前仍需补齐的专业能力:

  • Agent Forwarding、OpenSSH 证书与 FIDO2
  • 断网重连、休眠恢复和大量标签切换的持续压测
  • SFTP 内容校验和、显式冲突选择和任务恢复
  • Windows 实机验收、自动更新、代码签名、macOS 公证和崩溃诊断

技术栈

层级 技术
桌面运行时 Tauri 2
原生后端 Rust 2021
SSH / SFTP ssh2 0.9 / libssh2
本地终端 portable-pty 0.9
串口 serialport 4.8
前端 React 18 + TypeScript 5 + Vite 5
状态管理 Zustand 4.4+
终端 XTerm.js 5.5+
测试 Vitest + Rust test

会话和设置保存在系统应用数据目录的 opsxshell-data.json。主密钥固定保存在 ~/.opsxshsell/master.key,Unix 权限为目录 0700、文件 0600。

开发

环境要求:Node.js 18+、npm 9+、Rust 1.77+。

npm install
npm run dev

常用检查与构建:

npm run acceptance:quick
npm run acceptance:full
npm run build:tauri

平台打包必须在对应系统执行。macOS 在 macOS 构建,Windows x86_64 在 Windows 构建。

目录

src/                         React 界面与状态管理
src/platform/                Tauri 命令和事件适配层
src/platform/sftp.ts         本地/远程路径强类型传输边界
src/utils/terminalPipeline.ts 终端输入、输出和背压管线
shared/types/                前后端共享 TypeScript 契约
src-tauri/src/commands/      精简的 Tauri 命令边界
src-tauri/src/domain/        原生领域模型
src-tauri/src/services/      SSH、SFTP、隧道、PTY、串口、AI、存储服务
src-tauri/src/services/ssh/  认证、known_hosts、代理/跳板和 SFTP 子模块
src-tauri/src/services/tunnel/ 转发运行模型、SOCKS5 协议和双向 Relay
test/                        前端测试与基础验收
scripts/                     构建和验收脚本

快捷键

快捷键 功能
Cmd/Ctrl + N 新建会话
Cmd/Ctrl + K 快速连接
Cmd/Ctrl + D 终端分屏
Cmd/Ctrl + W 关闭标签
Cmd + Option + I / F12 开发构建打开调试工具

文档

许可证

MIT