NyaTerm Documentation

NyaTerm is a modern desktop client designed for SSH-centric operations and mixed terminal workflows. It is built with Tauri, React, and Rust.

Key Capabilities:

• Session Support: Connects to SSH, Local Shells, Telnet, and Serial devices. It is a client for these protocols, not a shell replacement.
• Workspace Management: Provides a tabbed interface with horizontal and vertical pane splits, tab docking, and layout restoration.
• SFTP Integration: Includes a built-in SFTP browser for remote file management and a transfer queue.
• AI Assistance: Features an integrated AI panel for command generation, error analysis, and multi-step terminal workflows.
• Security: Offers credential management, OTP (TOTP/HOTP) support, and encrypted sync/backup.
• Remote Monitoring: Provides real-time monitoring for SSH sessions, including resource usage, NVIDIA GPU metrics, process management, and Docker management.

NyaTerm is a modern remote terminal workspace built with Tauri, React, and Rust. It is designed for SSH operations, DevOps, and hybrid terminal workflows. It provides a unified desktop client to manage multiple connection types and workflows in a single workspace.

Core Capabilities:

• Session Management: Supports SSH, local Shell, Telnet, and Serial (UART) sessions.
• Workspace Organization: Uses tabs with support for horizontal/vertical splitting, tab docking, and layout recovery.
• SFTP & File Workflows: Integrated SFTP browser with a transfer queue and a "local edit and upload" workflow.
• AI Assistance: Built-in AI panel for command generation, error analysis, and multi-step agentic tasks.
• Security & Networking: Manages credentials, private keys, OTP (TOTP/HOTP), SSH tunnels (local/remote/dynamic), jump hosts, and proxies (SOCKS5/HTTP).
• Sync & Backup: Encrypted configuration synchronization via WebDAV, S3-compatible storage, or GitHub Gist.

NyaTerm is a desktop application built on Tauri 2. It follows a split architecture where the frontend and backend communicate via Tauri commands and events.

Frontend (React / TypeScript)

• Main Window: Uses AppProvider and App.tsx to manage the primary workspace.
• Child Windows: Uses ChildAppProvider and ChildWindowRouter for specialized tasks like settings, new connections, or command editing.
• Communication: Uses an invoke wrapper for commands and Tauri event listeners for backend-to-frontend updates.

Backend (Rust)

• Core Managers: Handles sessions (SessionManager), tunnels (TunnelManager), recordings (RecordingManager), authentication (PendingAuthManager), and cloud synchronization (CloudSyncManager).
• Capabilities: Provides SSH, SFTP, local PTY, Telnet, Serial, file watching, session importing (Xshell/MobaXterm/WindTerm), and AI integration.
• Persistence: Uses redb for high-performance storage and encrypted credential management.

The NyaTerm AI Assistant operates in two distinct modes depending on your goal:

1. Ask Mode (Default): Best for single-turn interactions. Use this to:

   • Generate commands.
   • Explain terminal output.
   • Analyze errors.
   • Derive fix commands from selected text.
   • Commands are returned as structured cards with risk level annotations.

2. Agent Mode: Best for multi-step autonomous tasks. It uses a ReAct loop (Observe $\rightarrow$ Decide $\rightarrow$ Execute $\rightarrow$ Observe) to complete complex tasks like troubleshooting, building, or deployment checks.

   • Requires an active terminal session.
   • Displays execution status for every step (Running, Completed, Failed, Timed Out, Needs Approval, or Blocked by Security Policy).
   • Commands are executed in the terminal, and the Agent provides a final summary via a dedicated tool rather than mixing it with command output.

Configuration: You can configure maximum steps and single-step timeouts in Settings $\rightarrow$ AI $\rightarrow$ Agent Settings.

// Agent Mode Workflow Example:
1. Agent proposes command
2. Command passes risk/policy check
3. Command executes in terminal
4. Agent observes output
5. Agent provides 'Final Answer' summary