Files
nyaterm/docs-site/docs/getting-started/installation.md
T
Kang 8e27865206 ci(contributing, docs): enhance contribution guidelines and installation instructions
- Updated the `CONTRIBUTING.md` to include additional test commands for release asset verification and package metadata generation.
- Revised `README.md` and `README.zh-CN.md` to clarify the installation process for Windows portable editions and added details on migrating from Tauri to GPUI.
- Introduced new workflows for publishing to AUR, Gitee, and Homebrew, ensuring streamlined release processes across platforms.
- Added a new `actionlint.yaml` for workflow syntax validation, improving CI/CD reliability.
- Enhanced documentation to reflect changes in artifact versioning and release management, ensuring clarity for contributors and users.
2026-08-31 10:32:18 +08:00

3.1 KiB
Raw Blame History

安装指南

系统要求

NyaTerm 支持以下操作系统:

  • Windows 10/11x64 / ARM64
  • macOS 12+Intel / Apple Silicon
  • Linuxx64 / ARM64Ubuntu 20.04+、Fedora 36+、Arch Linux 等)

NyaTerm 用 GPUI 做原生 GPU 渲染,因此对图形环境有要求:

  • Linux:需要可用的 Vulkan 驱动(例如 libvulkan1mesa-vulkan-drivers),以及 X11 或 Wayland 会话。缺少 Vulkan 驱动时应用无法启动
  • macOS:使用 Metal,系统自带
  • Windows:使用系统图形驱动,通常无需额外安装

NyaTerm 是桌面客户端而不是终端复用器,在纯 SSH 的无头服务器上无法运行。

下载安装

从发布页面下载

前往 Releases 页面,按操作系统下载安装包:

平台 安装包格式
Windows 安装版 -setup.exe / 便携版 .zip
macOS .dmg / .app.tar.gz
Linux .deb / .AppImage / .rpm

Windows 便携版解压后运行 NyaTerm.exe 即可,配置数据保存在同目录的 data/

Help → 检查更新 只检查 GitHub Releases 并提供页面入口,不会自动下载或替换程序文件。更新便携版时关闭 NyaTerm 后手动替换程序文件,保留 data/ 目录。

以前安装的 Tauri 安装版可以通过原有签名更新器迁移一次到 GPUI 安装版。旧 Tauri 便携更新器只允许更新单个主程序,无法携带 GPUI 必需的 RDP/VNC helper;请下载完整的 GPUI 便携 ZIP,并将旧目录中的 data/ 复制到新目录,不能只替换 NyaTerm.exe

macOS

macOS 用户可以通过 Homebrew 安装 NyaTerm

brew install nyakang/nyaterm/nyaterm

该命令会使用 nyakang/homebrew-nyaterm tap,并安装 nyaterm cask。也可以从 nyaterm.appReleases 下载 .dmg 安装包,然后将 NyaTerm 拖入 /Applications

NyaTerm 目前还没有使用 Apple Developer 证书签名。安装后如果 macOS 提示应用已损坏或无法打开,可以移除 quarantine 属性后再打开:

sudo xattr -cr /Applications/NyaTerm.app

从源码构建

从源码构建见 开发环境搭建

迁移旧环境

在其他客户端维护过会话时,安装后可以直接导入 Xshell、MobaXterm、WindTerm、SecureCRT、FinalShell、Termius 或 NyaTerm / Electerm JSON。完整格式清单和导入注意事项见 SSH 连接管理 → 导入其他客户端的会话

要完整恢复一个 NyaTerm 环境,用 .nya 加密配置备份而不是会话导入——它恢复的不只是连接列表。.nya 导入 / 导出需要先在 设置 → 安全 设置主密码,导入后通常需要重启应用。

下一步

装好之后从 快速开始 继续,它会带你建立第一个连接、认识工作区,并指出哪些设置值得先过一遍。