mirror of
https://github.com/nyakang/nyaterm.git
synced 2026-10-30 16:08:28 +00:00
Kang
4566950ee4
- Added new entries in CHANGELOG.md for version 1.1.12, detailing enhancements to jump host configuration and cycle prevention. - Updated README.md and its Chinese counterpart to include new AI Assistant features, such as command generation, error analysis, and multi-step workflows. - Enhanced documentation for terminal features, file transfer capabilities, and user settings to reflect recent changes and improvements. - Introduced a new guide for the AI Assistant, detailing its working modes, command cards, and risk control mechanisms.
187 lines
6.7 KiB
Markdown
187 lines
6.7 KiB
Markdown
---
|
||
sidebar_position: 2
|
||
---
|
||
|
||
# 快速开始
|
||
|
||
本章帮助你在最短路径内体验 NyaTerm 的核心工作流：创建连接、打开会话、使用分屏、查看文件、启用终端增强功能，并了解迁移、AI 辅助与备份入口。
|
||
|
||
## 第一步：选择会话类型
|
||
|
||
点击 **新建连接**，你会看到四类可选会话：
|
||
|
||
- **SSH** — 最完整的远程运维场景
|
||
- **本地终端** — 直接在 NyaTerm 中打开本地 shell
|
||
- **Telnet** — 适合旧系统或实验环境
|
||
- **串口** — 适合串口调试设备
|
||
|
||
如果你只是第一次体验，建议优先创建一个 **SSH** 会话，再额外创建一个 **本地终端** 对比工作区效果。
|
||
|
||
## 第二步：创建第一个 SSH 连接
|
||
|
||
在新建连接窗口中填写：
|
||
|
||
- **连接名称** — 便于识别的显示名称
|
||
- **主机** 与 **端口**
|
||
- **用户名**
|
||
- **认证方式** — 密码或私钥
|
||
|
||
如有需要，还可以展开高级区域配置：
|
||
|
||
- 代理（SOCKS5 / HTTP / ProxyCommand）
|
||
- 跳板机（会校验缺失引用与环路）
|
||
- OTP 绑定与自动填充
|
||
- X11 转发、本地 X11 DISPLAY
|
||
- 图标、分组、描述等元数据
|
||
|
||
保存后，连接会出现在已保存连接列表中。
|
||
|
||
## 第三步：如果你已有旧配置，直接导入
|
||
|
||
如果你之前已经在别的客户端维护了大量主机，不必手动重建。
|
||
|
||
NyaTerm 支持从以下来源导入：
|
||
|
||
- **Xshell**（`.xts`）
|
||
- **MobaXterm**（`.mxtsessions`）
|
||
- **WindTerm**（`.sessions`）
|
||
- **NyaTerm** 自己的加密备份文件（`.nya`）
|
||
|
||
其中：
|
||
|
||
- 会话导入适合迁移连接清单
|
||
- `.nya` 导入适合恢复完整本地配置
|
||
- `.nya` 导入 / 导出需要先设置 **主密码**
|
||
|
||
如果你只是想迁移 SSH 主机，通常从 **已保存连接** 面板的导入入口开始更快；如果你要恢复完整 NyaTerm 环境，再使用 `.nya` 更合适。
|
||
|
||
## 第四步：启动并理解工作区
|
||
|
||
双击已保存连接，或者右键选择连接，即可启动会话。
|
||
|
||
连接建立后，你会看到：
|
||
|
||
- **中央区域** — 当前终端标签页与分屏窗格
|
||
- **左侧活动栏** — 文件浏览器、网络、Security/Auth、云同步、设置等面板入口
|
||
- **右侧活动栏** — 已保存连接、AI Assistant、活动会话、命令历史、资源监控等入口
|
||
- **底部区域** — 快捷命令、串口发送、录制、锁屏等辅助区域
|
||
|
||
如果你希望关闭主窗口时保留应用在后台运行，可以到 **设置 → 常规** 开启 **关闭时最小化到托盘**。
|
||
|
||
## 第五步：试试这些高频能力
|
||
|
||
### 1. 再打开一个本地终端
|
||
|
||
使用快捷键 ``Ctrl/Cmd + ` `` 或菜单入口创建本地终端，这样你可以在一个应用里同时看本地和远程环境。
|
||
|
||
### 2. 试一次终端分屏
|
||
|
||
在标签页上右键，选择：
|
||
|
||
- **水平分屏**
|
||
- **垂直分屏**
|
||
|
||
这适合同时观察日志、执行命令和对照不同主机输出。
|
||
|
||
### 3. 打开远程文件浏览器和传输队列
|
||
|
||
SSH 会话激活后，文件浏览器面板可直接浏览远程目录，并支持：
|
||
|
||
- 上传文件 / 上传文件夹
|
||
- 下载、删除、移动、重命名、属性查看
|
||
- 路径栏点击编辑并跳转
|
||
- 复制路径或发送路径到终端
|
||
- 与终端当前目录手动 / 自动同步
|
||
|
||
如果你发起上传或下载，传输面板会显示队列进度，并支持暂停、继续、取消和失败重试。
|
||
|
||
如果你在 Windows 上使用 NyaTerm，还可以尝试把本地文件或文件夹直接拖进文件浏览器上传。
|
||
|
||
### 4. 打开命令历史和快捷命令
|
||
|
||
- **命令历史** 适合回溯与模糊检索
|
||
- **快捷命令** 适合保存固定操作，并支持变量输入、分类和执行模式
|
||
- **命令建议** 会在输入时根据历史与内置命令给出补全候选
|
||
|
||
如果建议太多或混入了超长历史命令，可以到 **设置 → 交互** 调整：
|
||
|
||
- **最小历史命令长度**
|
||
- **最大历史命令长度**
|
||
|
||
这些长度限制只影响历史命令建议，不影响快捷命令本身的可用性。
|
||
|
||
### 5. 试一次终端搜索 / 在线搜索 / 翻译
|
||
|
||
在终端中选中文本后，可以通过右键菜单：
|
||
|
||
- **查找** 当前输出
|
||
- 用自定义搜索引擎做**在线搜索**
|
||
- 按已启用的翻译 provider 做**翻译**
|
||
|
||
### 6. 试试 AI Assistant
|
||
|
||
右侧活动栏中的 **AI Assistant** 适合这些场景：
|
||
|
||
- 让 AI 根据你的目标生成一条命令
|
||
- 解释最近终端输出或当前选中文本
|
||
- 分析错误信息并给出修复建议
|
||
- 将生成的结构化命令卡片保存为快捷命令
|
||
|
||
如果你第一次打开时没有可用模型，可以先到 **设置 → AI** 配置 provider、模型和风险控制。
|
||
|
||
### 7. 启用终端增强项
|
||
|
||
可在 **设置 → 终端** 中按需打开：
|
||
|
||
- 行号
|
||
- 时间戳
|
||
- 动作链接
|
||
- 关键词高亮
|
||
- 远程资源监控
|
||
|
||
这些能力默认更偏保守，需要你按场景开启。
|
||
|
||
### 8. 试一次录制
|
||
|
||
NyaTerm 支持把当前会话输出录制为日志文件。
|
||
|
||
如果你希望把录制文件集中保存到固定目录，可以先在 **设置 → 传输** 里设置 **录制保存路径**。
|
||
|
||
### 9. 看一下通用设置和诊断入口
|
||
|
||
在正式长期使用前，建议先快速看一遍这些设置分组：
|
||
|
||
- **设置 → 常规**：启动恢复、关闭时最小化到托盘、关闭确认
|
||
- **设置 → 交互**：命令建议、历史命令长度过滤、复制与右键粘贴
|
||
- **设置 → 终端**：回滚缓冲区、Keep-Alive、动作链接、关键词高亮
|
||
- **设置 → 传输**：下载目录、默认编辑器、录制路径、传输并发
|
||
- **设置 → 安全**：主密码、锁屏、主机密钥策略
|
||
- **设置 → AI**：provider、模型、风险门槛、历史记录和上下文限制
|
||
|
||
如果你在排查问题，**设置 → 常规** 里还能直接：
|
||
|
||
- 打开本地日志目录
|
||
- 导出诊断包
|
||
|
||
## 第六步：可选配置云同步
|
||
|
||
如果你希望把常用配置做跨设备同步，可以继续：
|
||
|
||
1. 打开 **设置 → 安全**，先设置 **主密码**
|
||
2. 再打开 **设置 → 云同步**
|
||
3. 选择 WebDAV、S3 兼容存储、Gist 或网盘 provider
|
||
4. 填写连接信息后先执行 **测试连接**
|
||
5. 再决定是否启用启动检查和自动推送
|
||
|
||
如果你只是首次试用 NyaTerm，这一步不是必须的；更详细的配置方式见 [云同步](../guide/sync-and-backup)。
|
||
|
||
## 第七步：按你的场景继续深入
|
||
|
||
- 想了解不同会话差异：查看 [会话类型](../guide/session-types)
|
||
- 想配置认证、代理、跳板机：查看 [SSH 连接管理](../guide/ssh-connection)
|
||
- 想管理文件与自动回传：查看 [SFTP 文件传输](../guide/file-transfer)
|
||
- 想了解终端增强与录制：查看 [终端功能](../guide/terminal)
|
||
- 想配置 OTP：查看 [OTP 与认证](../guide/otp-and-auth)
|
||
- 想启用 AI 辅助：查看 [AI 助手](../guide/ai-assistant)
|
||
- 想启用云同步：查看 [云同步](../guide/sync-and-backup)
|