nyaterm README

项目的 README,来自 github.com/nyakang/nyaterm。合并为一个 markdown 文件:README.md。

NyaTerm

NyaTerm

/ˈnjaː tɜːrm/

A modern native remote terminal workspace built with GPUI.
nyaterm.app · Documentation

SSH, local shells, Telnet, Serial, RDP, VNC, SFTP, tunnels, OTP, AI assistance, and encrypted sync in one desktop client.

Discord   WeChatGroup
LINUX DO
Version   GitHub downloads   Platform   License

English · 简体中文


NyaTerm main workspace


AI Assistant

NyaTerm includes an AI Assistant panel for command generation, terminal output explanation, error analysis, and multi-step terminal workflows.

What It Can Do


What is NyaTerm

NyaTerm is a native GPUI desktop client for SSH-centric operations and mixed terminal workflows. Its Rust workspace combines the desktop interface, terminal rendering, transport protocols, persistence, authentication, network tooling, AI-assisted terminal actions, session import/export, diagnostics, and encrypted sync/backup in one application.


Why NyaTerm

NyaTerm is built for people who move between servers, local commands, devices, and configuration files all day.


Features

Sessions and Workspace

Terminal Experience

SFTP and File Workflows

Security, Authentication, and Networking

Sync, Backup, and Migration


Screenshots

Workspace

Manage SSH, local shell, Telnet, and Serial sessions inside one tabbed and split-pane workspace.

NyaTerm workspace overview

Appearance and Background Image

Use a local wallpaper behind the main window, tune Image Sizing, Image Opacity, and Background Content Opacity, and keep child windows readable with solid surfaces.

NyaTerm background image customization

Terminal Enhancements

Use command history, search, translation, action links, timestamps, keyword highlighting, and large-output protection in the terminal.

NyaTerm terminal features

Remote Files

Browse SFTP files beside the terminal, manage transfers, and send local editor changes back to the remote path.

NyaTerm SFTP file workflow

Security and Network Tools

Manage credentials, OTP, known hosts, proxies, jump hosts, and SSH tunnels from dedicated panels.

NyaTerm security and network tools

Sync and Backup

Sync encrypted portable configuration snapshots and restore backups through WebDAV or S3-compatible storage.

NyaTerm sync and backup


Supported Platforms

OS Support
Windows Windows 10/11, x64 / arm64
macOS macOS 12+, Intel / Apple Silicon
Linux Ubuntu 20.04+, Fedora 36+, Arch Linux, and similar distributions

For customized Ubuntu 20.04 x86-64 desktops with glibc 2.31, use the dedicated focal offline compatibility build. Standard Linux release packages are built on newer distributions and may require a newer glibc. The compatibility build includes all runtime helpers, an ABI report, a system/GPU-first launcher and an explicit private CPU OpenGL fallback; the target needs a working X11 session.

Download installers from nyaterm.app or the Releases page.


Supported Session Types

Type Typical use Notes
SSH Linux / Unix remote servers Supports SFTP, OTP, resource / GPU / process / Docker monitoring, proxy, jump host, tunnels, and per-connection algorithm preferences
Local Terminal Local shell workflows Uses your local shell path and working directory
Telnet Legacy network devices or lab systems Lightweight terminal session without SSH-only features, with Backspace Mode for Ctrl+H (BS) or DEL (0x7F)
Serial Routers, boards, embedded devices Configurable port, baud rate, data bits, parity, stop bits, and Backspace Mode

Getting Started

Download

Download the latest build for your platform from nyaterm.app or Releases.

Platform Format
Windows .exe / portable .zip
macOS .dmg
Linux .deb / .AppImage / .rpm

For the Windows portable edition, extract the ZIP and run NyaTerm.exe; data lives in the adjacent data/ directory. GPUI Help → Check Updates uses signed manifests and supports downloading and installing updates for supported installation types. Homebrew and deb/rpm installations use their package manager.

Migrating from 1.x: Windows portable and old MSI installations require manual upgrades. Quit and back up all data and keys first. Replace the complete portable program payload while preserving data/; for MSI, back up, uninstall the old version, and install NSIS. Replacing only the main executable is insufficient, and automatic migration is not promised for all legacy installers. See the 2.0 migration guide.

macOS

macOS users can install NyaTerm with Homebrew:

brew install nyakang/nyaterm/nyaterm

This uses the nyakang/homebrew-nyaterm tap and installs the nyaterm cask. You can also download the .dmg installer from nyaterm.app or Releases, then drag NyaTerm into /Applications.

NyaTerm is currently not signed with an Apple Developer certificate. If macOS reports that the app is damaged or cannot be opened after installation, remove the quarantine attribute and open it again:

sudo xattr -cr /Applications/NyaTerm.app

Arch Linux / AUR

Arch Linux users can install NyaTerm from the AUR:

yay -S nyaterm-bin

Or with paru:

paru -S nyaterm-bin

You can also build it manually from the AUR repository:

git clone https://aur.archlinux.org/nyaterm-bin.git
cd nyaterm-bin
makepkg -si

AUR package: nyaterm-bin

nyaterm-bin is a community-maintained binary AUR package. If the AUR package has not yet caught up with the latest release, download the official package from Releases.

Prerequisites for Development

Development

git clone https://github.com/nyakang/nyaterm.git
cd nyaterm
cargo run -p nyaterm-app --bin nyaterm

Project Structure

├── crates/
│   ├── nyaterm-app/             # Native GPUI application entry point and assets
│   ├── nyaterm-desktop/         # GPUI application composition and feature state
│   ├── nyaterm-core/            # UI-independent domain models and policies
│   ├── nyaterm-terminal/        # Terminal state machine and parsing
│   ├── nyaterm-terminal-runtime/ # Frame worker, search, and session event routing
│   ├── nyaterm-terminal-gpui/   # GPUI terminal layout, input, and painting
│   ├── nyaterm-transport/       # SSH, PTY, SFTP, Telnet, Serial, and transfers
│   ├── nyaterm-store/           # Persistence and database compatibility
│   ├── nyaterm-ui/              # Shared GPUI controls and theme integration
│   ├── nyaterm-remote-desktop/  # UI-independent RDP/VNC sessions and typed IPC
│   ├── nyaterm-rdp-helper/      # Isolated IronRDP protocol helper process
│   ├── nyaterm-vnc-helper/      # Isolated VNC protocol helper process
│   └── nyaterm-otp/             # OTP compatibility implementation
├── docs-site/                   # Docusaurus documentation site
├── Cargo.toml                   # Rust workspace definition
└── Cargo.lock

Credits

Thanks to the following projects and libraries that make NyaTerm possible:


Sponsor

If NyaTerm helps your daily development, operations, or remote terminal workflow, you can support ongoing maintenance from the Sponsor page.


Contributors

Contributors

Star History

Star History Chart

License

This project is licensed under the Apache License 2.0.

nyaterm (nyakang/nyaterm)

正在搜索数据库…

2.5K ·GitHub
这是什么?NyaTerm 是一款基于 Rust 和 GPUI 构建的原生桌面远程终端工作台,在一个应用中整合了 SSH、本地 Shell、Telnet、串口、RDP 和 VNC 会话,并提供 SFTP 文件浏览器、隧道、OTP 管理、AI 辅助以及加密同步功能。
它是终端模拟器,还是完整的远程访问套件?两者兼有:它是一款支持标签页和分屏窗格的终端模拟器,同时内置 SFTP 浏览器、RDP/VNC 桌面窗格、代理/隧道管理以及凭据/OTP 存储,全部集成在一个原生应用中。它不会取代你的 Shell,只是用来连接 Shell。
除了下载可执行文件,还需要其他东西吗?不需要额外的运行时,每个操作系统都有独立的原生构建版本。在 macOS 上,由于应用没有使用 Apple 开发者证书进行代码签名,你需要手动清除 quarantine 属性。
安装时有哪些需要注意的问题?在移除 quarantine 属性之前,macOS 会将未签名的应用标记为已损坏;另外,在 Windows 上(便携版或 MSI)从 NyaTerm 1.x 升级时,需要先备份数据并手动重新安装,因为仅替换可执行文件是不够的。
我保存的数据和凭据会存放在哪里?所有数据都会在本地加密存储,并由主密码保护;可选的云同步和备份仅通过 WebDAV、兼容 S3 的存储或 GitHub Gist 进行,且这些方式同样需要主密码。
内置的 AI 助手能做什么?它提供 Ask 模式,用于生成命令、解释输出和分析错误;还提供 Agent 模式,通过带审批关卡的“观察-决策-执行”循环来执行多步终端操作。
我能通过 SFTP 直接编辑远程文件吗?可以。你可以用本地编辑器打开远程文件,NyaTerm 会监视该文件,并在你保存后自动将修改上传回远程路径。
VNC 能与任意 VNC 服务器配合使用吗?目前还不完全支持。VNC 功能目前仅涵盖直接 TCP 连接,支持 None 和经典 VNC 认证,以及 Raw、ZRLE、Tight、Tight JPEG 帧缓冲更新,并不支持所有认证方式或编码。
能导入其他 SSH 客户端的会话吗?可以,NyaTerm 支持导入 Xshell、MobaXterm、WindTerm 中保存的会话,以及它自己的 JSON 会话定义。
有哪些类似的项目?shell-rs, omnyssh, WindTerm, navop, electerm, Hatoba, AceShell, Netcatty
作者
nyakang
大小
90.6 MB
星标
2.5K
时长
6个月
提交 · 90 天