# MShellX

**Repository Path**: daileilove/mshell-x

## Basic Information

- **Project Name**: MShellX
- **Description**: 融合 FinalShell 与 Xshell 的高效体验，并深度集成 VNC 图形远程能力，这是一款专为开发者与运维打造的全场景远程控制工具。

不再在多个软件之间来回切换——一个界面，即可掌控服务器的一切。
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 11
- **Created**: 2026-04-03
- **Last Updated**: 2026-04-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<h1>MShellX</h1>

<img src="./src-tauri/branding/mshellx-icon-source-1024.png" alt="MShellX" width="144" />

<p><strong>现代化跨平台远程工作台</strong></p>

<p>终端 · 文件传输 · 桌面会话 · 系统监控</p>

[English](./README.md) · [Gitee](https://gitee.com/ming-hao-wang1/msell-x)

</div>

---

## 快速导航

- [核心能力](#核心能力)
- [平台现状](#平台现状)
- [界面截图](#界面截图)
- [桌面验收入口](#桌面验收入口)
- [快速开始](#快速开始)
- [文档导航](#文档导航)

## 核心能力

### 统一远程工作区
- 支持 SSH、MOSH、Telnet、Rlogin、Serial、RDP、VNC 等连接配置
- 提供终端会话与桌面会话的标签式工作区
- 支持连接树、最近连接、分离窗口等桌面工作流

### 终端、文件、桌面、监控
- 基于 xterm.js 的终端渲染
- 面向 SSH 会话的远程文件面板、上传下载和内联编辑
- RDP / VNC 桌面会话页面
- 系统信息、进程视图、网络趋势和端口转发工具

### 桌面运行时
- Next.js 前端 + Tauri 2 桌面壳 + Rust 后端
- 本地 daemon、运行时会话注册表、原生 WebSocket 实时通道
- 已接入宿主能力抽象，可按平台控制托盘、自绘标题栏、文件拖拽和运行时降级

## 平台现状

基于当前仓库状态：

| 平台 | 打包状态 | 运行状态 | 说明 |
| --- | --- | --- | --- |
| Windows | 已就绪 | 已本地验证 | 已本地跑过 debug smoke、release smoke、bundle smoke |
| macOS | 已具备 CI 基线 | 仅 CI smoke | 代码签名、公证仍需正式发布凭据 |
| Linux | 已具备 CI 基线 | 仅 CI smoke | AppImage / deb 流程已接通，仍需发行版实机验证 |

边界说明：

- 当前仓库已经具备跨平台桌面构建和启动 smoke 能力。
- 这不等于“所有远程协议在所有宿主平台上完全等价”。
- 例如 RDP 的 CredSSP / NLA 仍与宿主能力有关，macOS / Linux 的正式分发签名流程也尚未收口。

## 界面截图

| 首页 | 工作区 |
| --- | --- |
| ![MShellX 首页](./docs/screenshots/home.png) | ![MShellX 工作区](./docs/screenshots/workspace.png) |
| 连接管理 | 文件面板 |
| ![MShellX 连接管理](./docs/screenshots/connections.png) | ![MShellX 文件面板](./docs/screenshots/workspace-file.png) |
| 桌面会话 | 脚本页 |
| ![MShellX 桌面会话](./docs/screenshots/desktop-session.png) | ![MShellX 脚本页](./docs/screenshots/scripts.png) |
| 任务页 | 设置页 |
| ![MShellX 任务页](./docs/screenshots/task.png) | ![MShellX 设置页](./docs/screenshots/settings-system.png) |

## 桌面验收入口

常用本地命令：

```bash
pnpm smoke:desktop:build
pnpm smoke:desktop:release
pnpm smoke:desktop:bundle
```

Windows 专项命令：

```powershell
pnpm smoke:windows:preflight
pnpm smoke:windows:release
```

这些命令的含义：

- `smoke:desktop:build`：构建 debug 桌面程序并真实启动一次
- `smoke:desktop:release`：构建 release 桌面程序并真实启动一次
- `smoke:desktop:bundle`：检查 bundle 产物是否生成，并做一次 bundle 级启动 smoke
- `smoke:windows:*`：持续验证 Windows 的 NSIS / MSI 路径

当前仓库内相关工作流：

- `Desktop Build Smoke`
- `Desktop Release Smoke`
- `Desktop Bundles`
- `Windows Release Smoke`

## 快速开始

### 1. 前置环境

建议准备：

- Node.js
- pnpm
- Rust toolchain
- 对应平台的 Tauri 前置依赖

### 2. 安装依赖

```bash
git clone https://gitee.com/ming-hao-wang1/msell-x.git
cd msell-x
pnpm install
```

### 3. 启动开发环境

```bash
pnpm dev
```

只启动 Web 前端：

```bash
pnpm dev:web
```

### 4. 构建与检查

```bash
pnpm check:quality
pnpm smoke:desktop:build
```

常用命令：

```bash
pnpm lint
pnpm check:i18n
pnpm check:arch
pnpm check:lines
pnpm build:web
pnpm build:desktop
pnpm smoke:desktop:release
pnpm smoke:desktop:bundle
```

## 文档导航

- [使用指南](./docs/guide.md)
- [多平台支持说明](./docs/platform-support.md)
- [故障排查](./docs/troubleshooting.md)
- [发布清单](./docs/release-checklist.md)
- [快捷键说明](./docs/shortcuts.md)
- [常见问题](./docs/faq.md)

## 仓库结构

- `src/app`：路由入口
- `src/views`：页面级视图组合
- `src/components`：可复用 UI 与领域组件
- `src/hooks`：运行时与页面行为
- `src/services`：前端服务适配层
- `src-tauri`：Tauri 桌面壳与 Rust 后端
- `docs`：项目文档与截图

## 贡献

欢迎提交 Issue 和 Pull Request。

主要协作入口：

- 仓库地址：https://gitee.com/ming-hao-wang1/msell-x
- 问题反馈：https://gitee.com/ming-hao-wang1/msell-x/issues

## 许可协议

本项目采用 MIT License，详见 [LICENSE](./LICENSE)。