Files
nyaterm/docs-site/docs/intro.md
T
Kang 97f6024baa fix(terminal): enable native IME without a compatibility toggle
Remove the legacy macOS IME setting, runtime gates, and related UI text.
Always register native terminal input and render IME preedit. Preserve
the legacy configuration field and its stored value for compatibility.

Validation on Windows: 38 filtered desktop tests and the legacy settings
round-trip test passed. Workspace check, Clippy, and formatting passed
in an isolated worktree containing only this change. Full tests in the
main worktree were blocked by unrelated file-manager changes.
Manual Windows Shift input-method switching remains unverified.
2026-10-20 21:59:36 +08:00

113 lines
6.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
slug: /
---
# 项目介绍
**NyaTerm** 是一个围绕远程终端工作流设计、基于 GPUI 构建的原生桌面客户端。它通过 Rust workspace 统一实现桌面界面、终端渲染、SSH、SFTP、会话管理、隧道、认证、AI 能力、云同步与配置持久化,让你在同一个工作区中处理远程服务器、本地 shell、串口设备和网络辅助能力。
## 使用场景
- 同时维护多台 SSH 主机
- 在本地终端、Telnet、串口设备之间切换排障
- 边看终端输出边操作远程文件
- 为常用运维命令、登录流程和跳板机链路做标准化配置
- 需要 OTP、录制、资源监控、自动上传、AI 辅助、跨设备配置同步或本地加密备份等增强能力
- 想从 Xshell、MobaXterm、WindTerm、SecureCRT、FinalShell、Termius 或 NyaTerm 备份文件快速迁移现有配置
## 核心能力
### 多种会话类型
NyaTerm 当前支持六类会话:
- **SSH** — 远程登录、文件传输、资源监控、隧道、OTP 等完整能力
- **本地终端** — 在同一套 UI 中打开本地 shell
- **Telnet** — 兼容旧设备或实验环境
- **串口** — 网络设备、嵌入式板卡、调试口
- **RDP** — Windows 远程桌面和图形化运维
- **VNC** — 传统 RFB/VNC 服务和虚拟机控制台;真实服务器互通范围仍在持续验证
### 可组合的工作区
- 多标签页管理多个会话
- 标签页内支持**横向/纵向分屏**,并可通过拖拽把标签停靠到目标分屏区域
- 可恢复终端窗口布局,并通过 Workspace Padding 调整终端区域间距
- 命令面板与会话快速切换器可快速查找动作、会话和已保存连接
- 左右活动栏可放置文件浏览器、网络、Security/Auth、云同步、设置、AI 助手、会话列表、命令历史、资源监控等面板
- 底部辅助区可承载快捷命令、串口发送、录制与锁屏入口
- 设置、新建连接、快捷命令、远程文件编辑、自动上传提示均使用独立子窗口,减少主工作区干扰
- 支持托盘最小化和隐藏主窗口,让关闭动作可以转为后台驻留
### 面向终端操作的增强
- 命令历史与模糊建议,可在交互式程序中自动抑制建议干扰
- 可配置命令建议的历史命令长度上下限,减少超长命令带来的噪音
- 终端搜索、搜索历史、结果计数、复制/粘贴、上下文菜单
- 支持终端缩放、字体粗细、工作区间距、原生输入法和图片路径粘贴
- 选中文本后可直接做**在线搜索**或按 provider **翻译**
- 可选的**行号 / 时间戳 gutter**
- 可选的**动作链接**(如 IPv4、`host:port`、压缩包文件名)
- 可选的**关键词高亮**与自定义规则
- 大输出场景下的保护机制、会话录制与 SSH Keep-Alive
- 支持直接在终端中使用 **Zmodem**(`rz`/`sz`)和 **trzsz**(`trz`/`tsz`)进行文件传输
- 支持自定义终端与界面操作的**键盘快捷键**
### 远程文件与传输队列
- SSH 会话下内置 SFTP 文件浏览器
- 上传、下载、重命名、移动、删除、属性查看、新建文件 / 文件夹 / OpenSSH 兼容符号链接
- 传输队列支持速度显示、暂停、继续、取消、失败重试、重复目标处理、断点续传、时间戳保留
- 在本地编辑下载的远程文件后,可通过 watcher 流程快速上传回远端
- Windows 下支持把本地文件或文件夹直接拖进文件浏览器上传
### AI 助手与自动化辅助
- 右侧活动栏内置 **AI Assistant** 面板
- 支持两种模式:**Ask**(单次问答)和 **Agent**(多步自主执行)
- 可从终端输出、选中文本、文件操作或手动输入发起 AI 请求
- 支持命令生成、错误分析、输出解释、修复建议等典型场景
- Agent 模式使用 ReAct 循环自主执行命令并观察结果,可配置最大步数和超时
- Agent 命令执行与最终回答分离,审批后的真实命令输出和面向用户的总结更容易追踪
- 可配置内置 provider、自定义 **OpenAI Compatible** provider、手动模型和凭据分组
- 支持结构化命令卡片、风险等级控制、审批后执行和保存为快捷命令
- 支持推理内容展示(适配 DeepSeek R1、QwQ 等模型的推理通道)
- 输入 `@` 可提及其他会话,跨会话引入上下文
- 多会话管理、历史搜索与分组浏览
- 终端输入时的实时命令风险评估与安全替代建议
### 安全、迁移与网络能力
- 私钥、密码、主机密钥策略、本地加密存储
- **凭据管理**:基于正则匹配的终端密码自动填充
- OTP 管理(TOTP / HOTP)、二维码导入、SSH 自动填充
- 支持 SOCKS5、HTTP、ProxyCommand、跳板机链路校验、本地 / 远程 / 动态隧道和 SSH X11 转发
- 锁屏、主密码与空闲应用锁定能力
- 支持导入 **Xshell / MobaXterm / WindTerm / SecureCRT / FinalShell / Termius** 会话,以及 NyaTerm/Electerm JSON
- 支持导入 / 导出 NyaTerm 自身的加密 `.nya` 配置备份
- 可打开日志目录并导出诊断包,便于问题排查与支持协作
### 云同步
- 支持 **WebDAV**、**S3 兼容**存储、**Gitee 代码片段**、**GitHub Gist**、**Google Drive**、**OneDrive** 和 **AliyunDrive** 七类远程存储
- 在 **设置 → 安全** 配置主密码后,才能启用 **设置 → 云同步** 中的相关能力
- 支持启动检查、保存后的防抖自动推送和手动推送 / 拉取
- 当本地和云端都发生变化时,可在设置页或工作区历史面板中手动处理冲突
## 文档导航建议
第一次使用时按下面顺序阅读:
1. [安装指南](./getting-started/installation)
2. [快速开始](./getting-started/quick-start)
3. [会话类型](./guide/session-types)
4. [SSH 连接管理](./guide/ssh-connection)
5. [工作区与布局](./guide/layout-and-workspace)
6. [终端功能](./guide/terminal)
7. [SFTP 文件传输](./guide/file-transfer)
8. [代理、跳板机与隧道](./guide/tunnels-and-proxy)
9. [OTP 与认证](./guide/otp-and-auth)
10. [AI 助手](./guide/ai-assistant)
11. [安全功能](./guide/security)
12. [云同步](./guide/sync-and-backup)