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 — это нативное настольное рабочее пространство для удалённых терминалов, созданное на GPUI на Rust. В одном приложении объединены сеансы SSH, локальной оболочки, Telnet, Serial, RDP и VNC, а также файловый браузер SFTP, туннели, управление OTP, помощь ИИ и зашифрованная синхронизация.
Это эмулятор терминала или полноценный набор инструментов для удалённого доступа?Это и то, и другое: эмулятор терминала с вкладками и разделёнными панелями, а также встроенный браузер SFTP, панели рабочего стола RDP и VNC, управление прокси и туннелями и хранилище учётных данных и OTP — всё в одном нативном приложении. Оно не заменяет вашу оболочку, а лишь подключается к ней.
Нужно ли что-то ещё, кроме скачивания исполняемого файла?Дополнительная среда выполнения не требуется: это автономная нативная сборка под каждую ОС. На macOS нужно вручную снять атрибут карантина, так как приложение не подписано сертификатом Apple Developer.
Есть ли подводные камни при установке, о которых мне стоит знать?macOS будет помечать неподписанное приложение как повреждённое, пока вы не уберёте атрибут карантина. А при обновлении с NyaTerm 1.x в Windows (портативная версия или MSI) нужна ручная переустановка с предварительным резервным копированием данных, так как простой замены одного исполняемого файла недостаточно.
Куда попадают мои сохранённые данные и учётные данные?Всё хранится локально в зашифрованном виде и защищено мастер-паролем. Необязательные облачная синхронизация и резервное копирование работают только через WebDAV, хранилища, совместимые с S3, или GitHub Gist, и для всех них тоже требуется мастер-пароль.
Что умеет встроенный ИИ-помощник?У него есть режим Ask для генерации команд, объяснения вывода и анализа ошибок, а также режим Agent, который работает по циклу «наблюдение — решение — выполнение» с контрольными точками подтверждения для выполнения многошаговых действий в терминале.
Могу ли я редактировать удалённые файлы напрямую через SFTP?Да: можно открыть удалённый файл в своём локальном редакторе. NyaTerm отслеживает файл и после сохранения автоматически загружает изменения обратно на удалённый путь.
Работает ли VNC с любым VNC-сервером?Не полностью: поддержка VNC пока охватывает прямые TCP-подключения с аутентификацией None и классической VNC Auth и обновлениями framebuffer в форматах 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 дней