20260619
This commit is contained in:
142
README.md
Normal file
142
README.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# meatshell
|
||||
|
||||
**简体中文** | [English](./README.en.md)
|
||||
|
||||
一个轻量级、低内存占用的 SSH / 终端客户端，灵感来自 FinalShell，但完全由
|
||||
**Rust + [Slint](https://slint.dev)** 实现。目标是保留 FinalShell 的核心体验
|
||||
（资源监控侧栏、会话管理、多标签页终端）的同时，把内存占用从 400 MB+ 的
|
||||
JVM 压到几十 MB 原生级别。
|
||||
|
||||
## 截图
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/screenshots/01-welcome.png" alt="欢迎页 / 会话管理" width="800"><br>
|
||||
<em>欢迎页：会话管理 + 左侧本机资源监控</em>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/screenshots/02-terminal-btop.png" alt="终端 + SFTP" width="800"><br>
|
||||
<em>多标签页终端（btop 全屏渲染）+ 底部 SFTP 文件浏览 + 远端资源监控</em>
|
||||
</p>
|
||||
|
||||
## 下载与安装
|
||||
|
||||
每次推送 `v*` 标签，Gitea Actions 会自动构建 Windows GNU 版本并发布到
|
||||
[Releases](https://git.miuoo.qzz.io/Miu/meatshell/releases) 页面。
|
||||
|
||||
### Windows
|
||||
|
||||
下载 `meatshell-*-windows-x86_64.zip`，解压后双击 `meatshell.exe`。
|
||||
运行时会在 `meatshell.exe` 同目录生成 `meatshell-debug.log`，SSH 连接闪退或异常时请优先查看这个文件。
|
||||
|
||||
### Linux
|
||||
|
||||
```bash
|
||||
tar -xzf meatshell-*-linux-x86_64.tar.gz
|
||||
cd meatshell-*-linux-x86_64
|
||||
./meatshell # 直接运行
|
||||
# 可选：装应用图标 + 启动器入口（Dock / 应用列表里显示图标，无需传参）
|
||||
chmod +x install-linux.sh && ./install-linux.sh
|
||||
```
|
||||
|
||||
> 需要 glibc ≥ 2.35（Ubuntu 22.04+ / Debian 12+）。Wayland 下首次装完图标可能要注销重登一次。
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
tar -xzf meatshell-*-macos-*.tar.gz # aarch64 = Apple 芯片，x86_64 = Intel
|
||||
xattr -dr com.apple.quarantine meatshell # 去掉「未签名应用」的 Gatekeeper 拦截
|
||||
./meatshell
|
||||
```
|
||||
|
||||
> 从源码构建见下方 [运行](#运行)。
|
||||
|
||||
## 路线图
|
||||
|
||||
### v0.1
|
||||
|
||||
- [x] FinalShell 风格深色主题 UI
|
||||
- [x] 左侧本机系统监控（CPU / 内存 / 交换 / 网络吞吐，1 Hz）
|
||||
- [x] 多标签页（欢迎页 + 多个终端会话）
|
||||
- [x] 会话管理：新建 / 编辑 / 删除，本地 JSON 持久化
|
||||
- 配置位置：`%APPDATA%/meatshell/sessions.json`（Windows）
|
||||
/ `~/.config/meatshell/sessions.json`（Linux）
|
||||
/ `~/Library/Application Support/meatshell/sessions.json`（macOS）
|
||||
- [x] SSH 连接骨架（`russh`，纯 Rust 实现，支持密码 + 私钥）
|
||||
- [x] 原始 PTY 输入 + VT/ANSI 终端视图
|
||||
|
||||
### v0.2
|
||||
|
||||
- [x] 完整 VT/ANSI 终端模拟（`vt100`/xterm 解析，支持全屏 TUI、滚动缓冲、查找、选择复制）
|
||||
- [x] 远端主机资源监控（与 FinalShell 一样执行远端脚本收集）
|
||||
- [x] SFTP 文件浏览 + 拖拽上传/下载
|
||||
- [x] 已知主机 (known_hosts) 校验（首次信任写入本应用 known_hosts，密钥变化拒绝连接）
|
||||
- [x] 会话密码使用 OS 钥匙串存储（不可用时使用加密配置回退）
|
||||
|
||||
### v0.3+
|
||||
|
||||
- [x] 多标签页终端分屏
|
||||
- [x] 会话分组 / 文件夹
|
||||
- [x] 主题切换（浅色 / 跟随系统）
|
||||
- [x] 命令历史与片段管理
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 模块 | 选型 |
|
||||
| ------------- | ----------------------------------------------------------------- |
|
||||
| UI | [Slint](https://slint.dev)（纯 Rust 编译，无 GC） |
|
||||
| 异步运行时 | [`tokio`](https://tokio.rs) |
|
||||
| SSH 协议 | [`russh`](https://crates.io/crates/russh)（无 libssh 依赖） |
|
||||
| 系统指标 | [`sysinfo`](https://crates.io/crates/sysinfo) |
|
||||
| 序列化 | `serde` + `serde_json` |
|
||||
| 日志 | `tracing` + `tracing-subscriber` |
|
||||
|
||||
## 运行
|
||||
|
||||
```bash
|
||||
cargo run --release
|
||||
```
|
||||
|
||||
首次启动会在 `%APPDATA%/meatshell/sessions.json` 建立空的会话库。点击右上
|
||||
角 **“＋ 新建会话”** 添加第一台服务器。
|
||||
|
||||
## 项目布局
|
||||
|
||||
```
|
||||
meatshell/
|
||||
├── Cargo.toml
|
||||
├── build.rs # Slint 编译器入口
|
||||
├── ui/
|
||||
│ ├── app.slint # 顶层窗口
|
||||
│ ├── theme.slint # 设计 tokens
|
||||
│ ├── widgets.slint # 可复用按钮 / 输入框 / sparkline
|
||||
│ ├── sidebar.slint # 左侧系统监控面板
|
||||
│ ├── tabs.slint # 顶部标签栏
|
||||
│ ├── welcome.slint # 欢迎页 / 快速连接
|
||||
│ ├── session_dialog.slint # 新建 / 编辑会话弹框
|
||||
│ └── terminal_view.slint # VT/ANSI 终端视图 + 命令条 / SFTP 面板
|
||||
└── src/
|
||||
├── main.rs
|
||||
├── app.rs # UI ↔ 后端桥接
|
||||
├── config.rs # 会话 JSON 持久化
|
||||
├── keychain.rs # 系统钥匙串密码存储 + 加密回退
|
||||
├── known_hosts.rs # OpenSSH known_hosts 校验
|
||||
├── system.rs # CPU / 内存 / 网络采样
|
||||
├── ssh.rs # SSH 会话 worker
|
||||
└── sftp.rs # SFTP 文件浏览 / 传输 worker
|
||||
```
|
||||
|
||||
## 开发提示
|
||||
|
||||
- Slint 控件有非常严格的布局 DSL，改 `.slint` 后 `cargo check` 是最快的
|
||||
反馈方式。
|
||||
- 应用事件循环是单线程（Slint 要求），所有跨线程 UI 更新通过
|
||||
`slint::invoke_from_event_loop` 回调。
|
||||
- `known_hosts` 采用首次信任（TOFU）：第一次连接会写入 meatshell 自己的
|
||||
`known_hosts`，之后服务端密钥变化会拒绝连接。
|
||||
- 会话密码优先存入系统钥匙串；若平台钥匙串不可用，会回退到本地
|
||||
ChaCha20-Poly1305 加密配置。
|
||||
|
||||
## License
|
||||
|
||||
MIT OR Apache-2.0（双许可）。
|
||||
Reference in New Issue
Block a user