# MShellX

**Repository Path**: ming-hao-wang1/mshell-x

## Basic Information

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

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

## Statistics

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

## Categories & Tags

**Categories**: nms

**Tags**: shell, VNC, SSH, RDP, MOSH

## 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) · [GitHub](https://github.com/wangminghao00/MShellX) · [Gitee 镜像](https://gitee.com/ming-hao-wang1/mshell-x)

</div>

---

## 快速导航

- [核心能力](#核心能力)
- [仓库现状](#仓库现状)
- [界面截图](#界面截图)
- [快速开始](#快速开始)
- [文档导航](#文档导航)
- [项目入口](#项目入口)

## 核心能力

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

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

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

## 仓库现状

当前仓库已切到 GitHub 主仓库模式：

- GitHub 是代码、Issue、Pull Request 和发布的唯一主入口。
- Gitee 只保留为只读镜像仓库，由 GitHub Actions 自动同步。
- 本地开发应从 GitHub clone，并且只保留 GitHub `origin` 远端。
- 仓库内已提供跨平台构建命令，但多平台打包验收当前仍以本地检查为主。

## 界面截图

| 首页 | 工作区 |
| --- | --- |
| ![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) |

## 快速开始

### 1. 前置环境

建议准备：

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

### 2. 安装依赖

```bash
git clone https://github.com/wangminghao00/MShellX.git
cd MShellX
pnpm install
```

### 3. 启动开发环境

```bash
pnpm dev
```

只启动 Web 前端：

```bash
pnpm dev:web
```

### 4. 构建与检查

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

常用命令：

```bash
pnpm lint
pnpm check:i18n
pnpm check:arch
pnpm check:lines
pnpm build:web
pnpm build:desktop:debug
pnpm build:desktop
pnpm build:windows:preflight
pnpm build:windows:release
```

## 文档导航

- [文档索引](./docs/README.md)
- [功能总览](./docs/features-overview.md)
- [使用指南](./docs/guide.md)
- [多平台支持说明](./docs/platform-support.md)
- [故障排查](./docs/troubleshooting.md)
- [GitHub -> Gitee 镜像说明](./docs/github-gitee-mirror.md)
- [支持项目](./docs/support.md)

## 项目入口

- GitHub 仓库：https://github.com/wangminghao00/MShellX
- GitHub Issues：https://github.com/wangminghao00/MShellX/issues
- GitHub Star：https://github.com/wangminghao00/MShellX/stargazers
- Gitee 镜像：https://gitee.com/ming-hao-wang1/mshell-x

## 许可协议

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