Installation
System Requirements
NyaTerm supports the following operating systems:
- Windows 10/11 (64-bit)
- macOS 12+ (Intel & Apple Silicon)
- Linux (Ubuntu 20.04+, Fedora 36+, Arch Linux, and similar distributions)
Download and install
From releases
Visit the Releases page and download the installer for your OS:
| Platform | Format |
|---|---|
| Windows | .msi / .exe / portable .zip |
| macOS | .dmg |
| Linux | .deb / .AppImage |
For the Windows portable edition, extract the zip and run NyaTerm.exe. Help → Check Updates uses the same Cloudflare R2 update manifest and download source as the installed edition. Tauri updater signatures are always verified before staging an update; when restarting, NyaTerm replaces the program files and preserves the complete data/ folder.
Direct downloads for the Windows portable edition:
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
Build from source
If you prefer to build NyaTerm yourself, see Development Setup.
What you see on first launch
After installation, the main window is typically organized into these areas:
- Top menu and window bar — File / View / Help and window controls
- Central workspace — terminal tabs and split panes inside the active tab
- Left activity bar and panels — file explorer, network, Security/Auth, Cloud Sync, settings, and related capability entry points
- Right activity bar and panels — saved connections, AI Assistant, active sessions, command history, and resource monitor
- Bottom helper area — quick commands, serial send, recording, and lock actions
Some workflows open dedicated child windows instead of interrupting the main workspace, such as:
- Settings
- New session / connection creation
- Quick command editing
- Remote-file editing
- Auto-upload prompts
Settings worth checking after install
Before using NyaTerm long term, quickly review:
- Settings → General: startup restore, minimize to tray when closing, close confirmation
- Settings → General: log level, log retention, open log directory, export diagnostics bundle
- Settings → Interaction: command suggestions, history-command length filters, copy, right-click paste, macOS IME compatibility
- Settings → Terminal: scrollback, Keep-Alive, action links, line numbers / timestamps, keyword highlighting, resource monitor, workspace padding, font weight, image path paste behavior
- Settings → Transfer: default download directory, default editor, recording path, concurrency, retry, duplicate-target strategy
- Settings → Security: master password, screen lock, idle auto-lock, host key policy
- Settings → AI: providers, models, risk controls, history, and context limits
If you often keep sessions or sync tasks running in the background, check Minimize to tray when closing early.
Suggested first run
For a first pass through the app, try this order:
- Open Quick Start
- Create one SSH connection
- Create one Local Terminal to experience the mixed workspace model
- Open the file explorer and transfer queue in the SSH session
- Try command history, quick commands, AI Assistant, recording, and terminal search
- On Windows, also try dragging local files or folders into the file explorer for upload