Files
nyaterm/docs-site/docs/getting-started/quick-start.md
T
KangandClaude Opus 5 e18cb3902e docs: cut the template phrasing and the authoring notes
The migrated prose leaned on a small set of constructions and repeated them
until they stopped carrying information. Across ~3.7k lines the source had 78
uses of "适合", 63 of "如果你", and 34 contrastive "而不是" clauses, most of
them attached to bullet lists that restated the feature name.

What changed:
- Replaced the "适合场景 / 适合:" tail hanging off nearly every section with
  either a plain sentence or nothing. "适合" is now 0, "如果你" is 0, and the
  18 remaining "而不是" clauses each rule out an assumption a reader would
  actually make (a rejected password is not truncated; a font name is not a
  bundled file; a decoder panic must not exit silently).
- Removed the closing editorial lines that asserted significance without adding
  information ("这也是 NyaTerm 和普通多标签终端差异较大的地方"), and the
  meta-commentary where the docs explained their own conventions.
- Dropped the relative time anchors that were already going stale: "新的 SFTP
  后端", "较新的工作区", "现在可以", "Newer Agent workflows".
- Deleted the "如果你准备录制文档素材" passage, which told the reader how to
  stage screenshots for the docs rather than how to use the recorder.
- Removed seven `:::tip Screenshot suggestion` blocks that shipped only in the
  English pages. They were internal authoring notes and pointed at a
  /img/docs/ tree and scripts/demo-*.sh files that do not exist in this repo.
- Dropped "推荐的工作流组合", four permutations of features documented
  elsewhere, and gave the synchronized input group one home instead of the
  three partial copies it had across two pages.
- Rewrote the cloud-sync conflict choices to lead with what is lost, since
  "适合:你确认云端版本才是应该保留的版本" buried the fact that local
  unsynced changes are discarded.

Also closes the remaining English gaps found while doing this: selection and
bulk operations, content-fingerprint upload, two FAQ entries, and two
quick-start steps existed only in Chinese. Chinese and English now carry the
same heading count on every page.

Verified with `pnpm --dir docs-site build` (both locales) and by re-resolving
all 22 cross-page anchors against the generated heading ids.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 11:27:47 +08:00

165 lines
6.3 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.
# 快速开始
本章帮助你在最短路径内体验 NyaTerm 的核心工作流:创建连接、打开会话、使用分屏、查看文件、启用终端增强功能,并了解迁移、AI 辅助与备份入口。
## 第一步:选择会话类型
点击 **新建连接**,你会看到六类可选会话:
- **SSH** — 最完整的远程运维场景
- **本地终端** — 直接在 NyaTerm 中打开本地 shell
- **Telnet** — 旧系统或实验环境
- **串口** — 串口调试设备
- **RDP** — Windows 远程桌面
- **VNC** — VNC 服务或虚拟机控制台;真实服务器互通范围仍在验证
第一次体验先建一个 **SSH** 会话,再建一个 **本地终端** 对比工作区效果。
## 第二步:创建第一个 SSH 连接
在新建连接窗口中填写:
- **连接名称** — 便于识别的显示名称
- **主机** 与 **端口**
- **用户名**
- **认证方式** — 密码或私钥
如有需要,还可以展开高级区域配置:
- 代理(SOCKS5 / HTTP / ProxyCommand)
- 跳板机(会校验缺失引用与环路)
- OTP 绑定与自动填充
- X11 转发、本地 X11 DISPLAY
- 图标、分组、描述等元数据
保存后,连接会出现在已保存连接列表中。
## 第三步:导入已有配置
已经在别的客户端维护了大量主机时不必手动重建。NyaTerm 可以导入 Xshell、MobaXterm、WindTerm、SecureCRT、FinalShell、Termius 和 NyaTerm / Electerm JSON——格式清单和注意事项见 [导入其他客户端的会话](../guide/ssh-connection#导入其他客户端的会话)。
两条路径的用途不同:
- 迁移**连接清单**:从 **已保存连接** 面板的导入入口开始最快
- 恢复**完整 NyaTerm 环境**:用 `.nya` 加密备份,需要先设置主密码
## 第四步:启动并理解工作区
双击已保存连接,或者右键选择连接,即可启动会话。
连接建立后,你会看到:
- **中央区域** — 当前终端标签页与分屏窗格
- **左侧活动栏** — 文件浏览器、网络、Security/Auth、云同步、设置等面板入口
- **右侧活动栏** — 已保存连接、AI Assistant、活动会话、命令历史、资源监控等入口
- **底部区域** — 快捷命令、串口发送、录制、锁屏等辅助区域
要让关闭主窗口后应用留在后台,到 **设置 → 常规** 开启 **关闭时最小化到托盘**。
## 第五步:试试这些高频能力
### 1. 再打开一个本地终端
使用快捷键 ``Ctrl/Cmd + ` `` 或菜单入口创建本地终端,这样你可以在一个应用里同时看本地和远程环境。
### 2. 试一次终端分屏
在标签页上右键,选择:
- **水平分屏**
- **垂直分屏**
用来同时观察日志、执行命令和对照不同主机的输出。
### 3. 打开远程文件浏览器和传输队列
SSH 会话激活后,文件浏览器面板可直接浏览远程目录,并支持:
- 上传文件 / 上传文件夹
- 下载、删除、移动、重命名、属性查看
- 路径栏点击编辑并跳转
- 复制路径或发送路径到终端
- 与终端当前目录手动 / 自动同步
发起上传或下载后,传输面板会显示队列进度,支持暂停、继续、取消和失败重试。
Windows 上还可以把本地文件或文件夹直接拖进文件浏览器上传。
### 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. 再决定是否启用启动检查和自动推送
首次试用可以跳过这一步。详细配置见 [云同步](../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)