@vonxq/vt-server

V-Terminal Server — A WebSocket relay server for sharing terminals across devices with E2E encryption.

V-Terminal 服务器 —— 基于 WebSocket 的终端共享中继服务器，支持端到端加密。

Install / 安装

npm install -g @vonxq/vt-server

Quick Start / 快速开始

# Interactive setup (first time) / 首次交互式设置
vt-server setup

# Start as daemon / 后台启动
vt-server start

The setup wizard will guide you through:

• Username and TOTP configuration (for Authenticator app)
• CLI TOTP secret (for client registration)
• Port and TLS certificate generation

设置向导将引导你配置：

• 用户名和 TOTP 动态码（用于 Authenticator 应用）
• CLI TOTP 密钥（用于客户端注册）
• 端口和 TLS 证书生成

Commands / 命令

vt-server setup          # Interactive setup / 交互式设置
vt-server start          # Start daemon / 后台启动
vt-server stop           # Stop daemon / 停止
vt-server restart        # Restart / 重启
vt-server status         # Status, QR code, keys / 状态、QR码、密钥
vt-server logs           # View logs / 查看日志
vt-server regen-totp     # Regenerate TOTP secrets / 重新生成动态码
vt-server regen-keys     # Regenerate E2E key pair / 重新生成密钥对
vt-server changeport     # Change port / 修改端口

Features / 特性

• Daemon mode — Runs as a background process with PID management
• Auto TLS — Generates self-signed certificates automatically
• TOTP Auth — Time-based one-time passwords for Web and CLI
• E2E Encryption — X25519 + NaCl box, server cannot read terminal content
• Embedded Web UI — Built-in PWA frontend, no separate deployment needed
• MCP Support — JSON-RPC interface for AI tool integration

Configuration / 配置

Config file: ~/.vterminal-server/config.json

{
  "authUser": "admin",
  "port": 8443,
  "totpSecret": "...",
  "cliTotpSecret": "...",
  "jwtSecret": "...",
  "tls": { "cert": "~/.vterminal-server/cert.pem", "key": "~/.vterminal-server/key.pem" },
  "e2e": { "publicKey": "...", "privateKey": "..." }
}

Requirements / 系统要求

• Node.js >= 18

License

MIT