# MShellX

**Repository Path**: good-project-fork/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**: 0
- **Forks**: 14
- **Created**: 2026-04-14
- **Last Updated**: 2026-04-14

## 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>Modern cross-platform remote workspace</strong></p>

<p>Terminal · file transfer · desktop session · monitoring</p>

[中文](./README.zh-CN.md) · [GitHub](https://github.com/wangminghao00/MShellX) · [Gitee Mirror](https://gitee.com/ming-hao-wang1/mshell-x)

</div>

---

## Quick Navigation

- [Highlights](#highlights)
- [Project Status](#project-status)
- [Screenshots](#screenshots)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [Project Links](#project-links)
- [Support MShellX](#support)

## Highlights

### Unified Remote Workspace
- Connection management for SSH, MOSH, Telnet, Rlogin, Serial, RDP, and VNC profiles
- Tabbed workspace for terminal sessions and desktop sessions
- Detached window flows for workspace and desktop sessions

### Terminal, Files, Desktop, Monitoring
- xterm.js terminal surface
- SSH-backed remote file panel with upload, download, and inline edit
- RDP / VNC desktop session surface
- System info, process inspection, network trend, and port forwarding tools

### Desktop Runtime
- Next.js frontend + Tauri 2 desktop shell + Rust backend
- Runtime session registry, Tauri command bridge, WebSocket realtime channel
- Host-aware desktop capabilities for tray, custom title bar, native file drop, and runtime fallbacks

## Project Status

This repository is now managed with a GitHub-first workflow:

- GitHub is the source of truth for code, issues, pull requests, and releases.
- Gitee is kept only as a mirror entry and is not a primary collaboration channel.
- Local development should clone from GitHub and keep only the GitHub `origin` remote.
- Cross-platform build commands exist in the repository, but packaging validation is still primarily driven by local checks.

## Screenshots

| Home | Workspace |
| --- | --- |
| ![MShellX home](./docs/screenshots/home.png) | ![MShellX workspace](./docs/screenshots/workspace.png) |
| Connections | File Panel |
| ![MShellX connections](./docs/screenshots/connections.png) | ![MShellX file panel](./docs/screenshots/workspace-file.png) |
| Desktop Session | Scripts |
| ![MShellX desktop session](./docs/screenshots/desktop-session.png) | ![MShellX scripts](./docs/screenshots/scripts.png) |
| Tasks | Settings |
| ![MShellX tasks](./docs/screenshots/task.png) | ![MShellX settings](./docs/screenshots/settings-system.png) |

## Quick Start

### 1. Prerequisites

You will need:

- Node.js
- pnpm
- Rust toolchain
- Tauri prerequisites for your platform

### 2. Install

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

### 3. Development

```bash
pnpm dev
```

Web-only development:

```bash
pnpm dev:web
```

### 4. Build And Checks

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

Useful repository commands:

```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
```

## Documentation

- [Documentation Index](./docs/README.md)
- [Features Overview](./docs/features-overview.md)
- [User Guide](./docs/guide.md)
- [Platform Support Notes](./docs/platform-support.md)
- [Troubleshooting](./docs/troubleshooting.md)

## Project Links

- GitHub Repository: https://github.com/wangminghao00/MShellX
- GitHub Issues: https://github.com/wangminghao00/MShellX/issues
- GitHub Star: https://github.com/wangminghao00/MShellX/stargazers
- Gitee Mirror: https://gitee.com/ming-hao-wang1/mshell-x

<a id="support"></a>
## Support MShellX

If MShellX is useful to you, supporting the project through GitHub or the QR codes below helps keep development moving.

- GitHub Repository: https://github.com/wangminghao00/MShellX
- GitHub Star: https://github.com/wangminghao00/MShellX/stargazers
- GitHub Fork: https://github.com/wangminghao00/MShellX/fork

### WeChat

![WeChat QR Code](./docs/pay/WeChat.jpg)

### Alipay

![Alipay QR Code](./docs/pay/Alipay.jpg)

## Contributing

Issues and pull requests are welcome on GitHub.

## License

This project is licensed under the MIT License. See [LICENSE](./LICENSE).