docs: 添加项目README文档

This commit is contained in:
Your Name
2026-07-28 22:12:23 +08:00
parent 57df653738
commit 9d6ddef740
+106
View File
@@ -0,0 +1,106 @@
# SSH Client Pro
一款功能丰富的 SSH 远程管理客户端,基于 Electron + React 构建,集成终端、文件管理、系统监控和 AI 智能助手。
## 功能特性
- **SSH 终端** - 完整的终端模拟器,支持密码/密钥认证,实时交互式 Shell
- **文件管理** - 远程文件浏览、创建目录、编辑文件、删除等操作
- **系统监控** - CPU、内存、磁盘、负载实时监控图表 + 进程监控(按 CPU/内存排序)
- **AI 智能助手** - 自然语言解析为 Linux 命令并执行,支持配置 OpenAI/DeepSeek 等 API
- **连接管理** - 多服务器连接配置持久化存储,支持编辑和删除
## 技术栈
| 类别 | 技术 |
|------|------|
| 桌面框架 | Electron 28 |
| 前端框架 | React 18 |
| 构建工具 | Vite 5 |
| UI 组件库 | Ant Design 5 |
| 终端模拟 | xterm.js |
| SSH 连接 | ssh2 |
| 图表 | Recharts |
| 本地存储 | electron-store |
| 打包 | electron-builder |
## 项目结构
```
├── electron/
│ └── main.js # Electron 主进程(SSH/SFTP/监控/AI 后端逻辑)
├── src/
│ ├── components/
│ │ ├── Terminal.js # 终端组件
│ │ ├── FileBrowser.js # 文件浏览器
│ │ ├── Monitor.js # 系统监控面板
│ │ ├── AIAgent.js # AI 智能助手
│ │ ├── Sidebar.js # 侧边栏(连接列表)
│ │ ├── ConnectionModal.js # 连接配置弹窗
│ │ └── WelcomePage.js # 欢迎页
│ ├── styles/
│ │ └── global.css # 全局样式(暗色主题)
│ ├── App.js # 主应用组件
│ └── index.js # React 入口
├── index.html # HTML 入口
├── vite.config.js # Vite 配置
└── package.json # 项目配置
```
## 快速开始
### 环境要求
- Node.js >= 16
- npm >= 8
### 安装依赖
```bash
npm install
```
### 开发模式
```bash
# 启动 Vite 开发服务器
npm run dev
# 另开终端,启动 Electron(连接开发服务器)
npm run electron-dev
```
### 生产运行
```bash
# 构建前端 + 启动 Electron
npm run app
```
### 打包安装程序
```bash
# 构建并打包为 Windows 安装程序 (NSIS)
npm run dist
```
## AI 智能助手配置
在 AI Agent 面板中点击「AI 设置」按钮,可配置:
- **API Key** - 你的 AI 服务密钥
- **API 地址** - 兼容 OpenAI 格式的 API 端点(如 `https://api.deepseek.com/v1`
- **模型** - 模型名称(如 `gpt-3.5-turbo``deepseek-chat``moonshot-v1-8k`
配置后,输入自然语言即可智能生成并执行 Linux 命令。未配置时使用本地关键词匹配模式。
## 快捷键 & 使用提示
- 终端支持自适应窗口大小
- 监控面板支持自动刷新(3秒间隔)和手动刷新
- 进程监控支持按 CPU / 内存排序切换
- 文件浏览器支持目录导航和文件操作
## License
MIT