@vonxq/vt-cli

V-Terminal CLI — Share your terminal to any device with E2E encryption.

V-Terminal 客户端 —— 将终端共享到任意设备，支持端到端加密。

Install / 安装

npm install -g @vonxq/vt-cli

Quick Start / 快速开始

# First-time setup / 首次设置
vt setup

# Share current directory / 共享当前目录
cd ~/code/my-project
vt start .

# Open browser: https://<server-ip>:8443
# 浏览器访问: https://<服务器IP>:8443

Commands / 命令

Terminal Sharing / 终端共享

vt start [dir]           # Share terminal / 共享终端
vt new [dir]             # Open new terminal tab / 新开终端标签
vt status                # Show status and running terminals / 查看状态

Server Management / 服务器管理

vt server add <name> --url <wss://...> --totp-secret <secret>
vt server ls             # List servers / 列出服务器
vt server use <name>     # Switch active server / 切换服务器
vt server rm <name>      # Remove server / 删除服务器
vt server ping           # Test connection / 测试连接
vt server current        # Show active server / 显示当前服务器

Configuration / 配置

vt setup                 # Interactive setup / 交互式设置
vt init                  # Initialize workspace / 初始化工作区
vt regen-keys            # Regenerate E2E key pair / 重新生成密钥对

Features / 特性

• Multi-server — Switch between servers like nrm
• E2E Encryption — X25519 + NaCl box, server cannot read terminal content
• TOTP Auth — Auto-computed TOTP codes, zero-friction authentication
• Local terminal tabs — vt new . opens a new iTerm2/Terminal tab on macOS
• Status dashboard — View running terminals, connected clients, and server info

vt status Output / 状态输出

  Running Terminals
  ─────────────────
  my-project
    ● abc12345  my-project
    ● def67890  Terminal
  
  Connected Clients
  ─────────────────
  CLI clients:  1
    ● my-macbook
  Web clients:  2
    ● mobile_a1b2c3

Configuration / 配置

Config: ~/.vterminal/config.json Workspace: .vterminal (in project root)

Requirements / 系统要求

• Node.js >= 18
• macOS / Linux (Windows: experimental)

License

MIT