nyakang/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.

 

     

English · 简体中文

---

---

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

• Ask mode for one-off help such as generating commands, explaining selected output, and analyzing errors
• Agent mode for multi-step work using an observe-decide-run loop against the active terminal session
• Recent-output actions so you can ask AI to explain the latest terminal output without manually copying it
• Structured command cards with risk levels, execution controls, and optional save-to-quick-command support
• Approved command execution tools for Agent workflows, with a separate final-answer step after terminal work completes
• Inline terminal capture during Agent execution with configurable Terminal Output Lines
• Session mentions with @ to bring other terminal sessions into the AI context
• Provider management for built-in providers, manual model entries, credential groups, and custom OpenAI-compatible endpoints
• Risk control for high-impact commands, including approval gates and safer alternatives

---

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.

• NyaTerm is an SSH client for developers, sysadmins, and DevOps engineers
• NyaTerm is a terminal workspace with tabs, horizontal splits, and vertical splits
• NyaTerm is an SFTP browser with a transfer queue and local-edit-then-upload-back workflow
• NyaTerm supports SSH, Local Terminal, Telnet, Serial, RDP, and VNC sessions
• NyaTerm is not a shell replacement; it connects to remote shells, local shells, Telnet endpoints, and serial devices

---

Why NyaTerm

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

• Workspace-first — keep related terminals together with tabs, split panes, side panels, and child windows
• Remote operations in context — browse SFTP files, follow terminal paths, run transfers, and edit remote files without leaving the session
• Security-aware workflows — manage credentials, keys, known hosts, OTP, lock screen, and master-password protected storage
• Portable configuration — import from existing tools, export encrypted .nya backups, and sync encrypted snapshots through WebDAV or S3-compatible storage
• AI where it is useful — generate commands, inspect output, and run approved multi-step actions from the active terminal context

---

Features

Sessions and Workspace

• SSH, Local Terminal, Telnet, Serial, RDP, and VNC session support
• Multi-tab workspace with horizontal and vertical pane splits, tab drag docking, and layout restoration
• RDP and VNC remote desktop panes; VNC currently supports direct TCP, None / classic VNC Auth, Raw / ZRLE / Tight / Tight JPEG framebuffer updates, window scaling, bounded reconnects, and text clipboard exchange for Latin-1 text
• Saved connections with folders, icons, metadata, duplication, keyboard copy, reconnect, and import flows
• Command Palette and session quick switcher for finding actions, open sessions, saved connections, and new-session entry points
• Main-window Background Image customization with cover / contain / stretch / tile sizing and adjustable Background Content Opacity
• Left and right activity bars for file explorer, network, Security/Auth, Sync & Backup, AI Assistant, Notes, saved connections, active sessions, command history, asset monitoring, resource monitoring, GPU monitor, process manager, and Docker manager
• Notes panel and editor with tree navigation, context menus, autosave, toolbar controls, and sync/backup-aware persistence
• Asset monitoring workspace with grouped connection views, breadcrumb navigation, table/card layouts, and resource/GPU/NPU status integration
• Remote host monitoring panels for SSH sessions: resource monitor, NVIDIA GPU and Ascend NPU overviews, process manager (signal/renice), and Docker manager (containers, images, volumes, networks, Compose)
• Session input sync groups to broadcast typed input and sent commands to multiple sessions at once
• Temporary SSH links for one-off connections from a pasted ssh:// URL or ssh command without saving a connection
• Child windows for settings, new-session creation, quick-command editing, remote-file editing, and auto-upload prompts
• Tray support with optional minimize-to-tray and hide-main-window behavior

Terminal Experience

• Terminal search with result navigation, search history, copy/paste, context menus, and selected-text actions
• Command history with fuzzy suggestions, configurable length filters, and suppression in interactive programs
• Unicode grapheme rendering for emoji, combining marks, and ZWJ sequences
• Optional line-number and timestamp gutter
• Optional action links for IPv4 addresses, host:port, and archive filenames
• Optional keyword highlighting with expanded built-in presets, custom rules, and JSON import
• Terminal zoom, workspace padding, font weight controls, native IME support, image path paste handling, and a clear-terminal action
• AI shortcuts for explaining recent output, plus inline Agent command output with configurable Terminal Output Lines
• Large-output protection, configurable scrollback, SSH keep-alive, and session recording
• Online search and translation from selected terminal text
• Zmodem file transfer support directly from the terminal, surfaced in the transfer queue
• Confirmation dialog before closing all sessions
• Customizable keyboard shortcuts for terminal and UI actions, including Backspace Mode selection for Telnet and Serial sessions

SFTP and File Workflows

• Built-in SFTP file explorer for SSH sessions
• Upload, download, rename, move, delete, properties, new file/folder, and OpenSSH-compatible symlink actions
• Folder upload/download, multi-folder upload selection, multi-select, editable path bar, and manual/automatic sync with terminal cwd
• Transfer queue with speed display, pause, resume, cancel, retry, duplicate-target handling, timestamp preservation, and configurable concurrency
• Enhanced SCP and directory-transfer handling with original-property preservation where available
• Open remote files in a local editor and upload saved changes back through the watcher-driven auto-upload flow, with content fingerprinting so only real content changes trigger re-upload
• Multi-tab read-only remote file preview for text, JSON, Markdown, CSV/TSV, images, and PDF, with per-tab session labels, zoom/rotate/fit controls, and paged PDF rendering
• Preview loading and decoding run off the render thread with per-format size limits, so oversized or unsupported files surface a clear message instead of blocking the UI
• SFTP channel concurrency limiting and automatic retry on transient channel-open failures
• External drag-and-drop upload support on Windows
• Zmodem transfers track local paths and can reveal completed files in the system file manager

Security, Authentication, and Networking

• Password authentication, private keys, host-key verification, and encrypted local persistence
• Credential management with regex-based terminal auto-fill
• OTP management with TOTP/HOTP, QR import, and SSH auto-fill support
• Per-connection SSH algorithm preferences with Compatible / Secure / Custom modes and security-risk labels for key exchange, ciphers, MACs, and host keys
• Proxy configurations including SOCKS5, HTTP, and ProxyCommand; SSH jump hosts with cycle prevention; local / remote / dynamic tunnels
• SSH X11 forwarding for environments with a local X server
• Screen lock, idle app lock, master password, diagnostics settings, local log management, and diagnostics bundle export

Sync, Backup, and Migration

• Encrypted cloud sync and backup through WebDAV, S3-compatible storage, and GitHub Gist
• Master password required before sync, backup, encrypted import/export, or scheduled encrypted backup actions
• Startup sync checks, debounced auto-push after supported local changes, detailed status updates, and scheduled backup retention
• Manual test / push / pull / backup actions, remote backup restore, and snapshot-level conflict resolution
• Session import from Xshell, MobaXterm, WindTerm, and NyaTerm JSON definitions
• Full-app encrypted .nya import/export for portable NyaTerm configuration

---

Screenshots

Workspace

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

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.

Terminal Enhancements

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

Remote Files

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

Security and Network Tools

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

Sync and Backup

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

---

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 |

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

• Rust stable via rustup
• Platform dependencies required by GPUI and your operating system

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-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:

• WindTerm - Inspired the design and features of NyaTerm
• tabby - An excellent cross-platform terminal that provided many design inspirations
• Alacritty - Terminal emulation components used by NyaTerm
• russh - An SSH client and server implementation in Rust

---

Sponsor

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

---

Contributors

---

Star History

---

License

This project is licensed under the MIT License.