pvetui - A Terminal UI for Proxmox VE
Managing Proxmox Virtual Environment (VE) is usually done through its web UI or CLI tools. Both are powerful, but sometimes you want something lightweight, fast, and fully terminal-driven.
Thatโs where pvetui comes in. Itโs a Terminal User Interface (TUI) for Proxmox VE designed to give you quick access to clusters, nodes, VMs, and containers โ all without leaving your terminal.
๐ Key Features
Lightning Fast โ Caching ensures snappy performance
Complete Management โ Control VMs, containers, nodes, and clusters
Multi-Profile Support โ Easily switch between multiple Proxmox connections
Automatic Migration โ Old configs migrate seamlessly into new profile format
Secure Authentication โ Works with API tokens or passwords, with auto-renewal
Integrated Shells โ SSH directly into nodes, VMs, and containers
VNC Console Access โ Embedded noVNC client with seamless auth
Community Scripts โ Install popular Proxmox community scripts right from the TUI
Modern Interface โ Vim-style navigation with customizable key bindings
Flexible Theming โ Automatically adapts to your terminal color scheme
Extensive Documentation โ Guides for config, theming, and development
๐ธ Screenshots
๐ See the full screenshot gallery
๐ฆ Installation
Pre-compiled Binaries
Download from Releases
Extract and run:
./pvetui
macOS users may see Gatekeeper warnings with binaries. See the Troubleshooting Guide for solutions.
From Source
git clone --recurse-submodules https://github.com/devnullvoid/pvetui.git
cd pvetui
make install # Build and install
# or:
make install-go # Install via Go toolchain
โ ๏ธ Note: go install github.com/devnullvoid/pvetui/cmd/pvetui@latest
does not work (missing submodules for noVNC). Use the source install method.
๐ง Configuration
On first run, an interactive wizard helps you set up profiles
Supports multiple Proxmox connections with profile switching
Compatible with SOPS-encrypted configs
API token setup is recommended (simpler and more secure than passwords)
Example config (~/.config/pvetui/config.yml
):
profiles:
default:
addr: "https://your-proxmox-host:8006"
user: "root"
realm: "pam"
token_id: "mytoken"
token_secret: "YOUR_SECRET"
ssh_user: "your-ssh-user"
default_profile: "default"
๐ See Configuration Docs for details.
๐ Usage
Run with the default config:
./pvetui
Or specify a custom profile/config:
./pvetui --profile work --config /path/to/config.yml
Common Flags
-c, --config
โ Path to config file-p, --profile
โ Use specific connection profile-w, --config-wizard
โ Launch config wizard-n, --no-cache
โ Disable caching-v, --version
โ Show version info
Key Bindings
h j k l
โ Navigates
โ SSH shellv
โ VNC consoleg
โ Global menu/
โ Searchq
โ Quit
๐ All key bindings are customizable.
๐จ Theming
Automatic adaptation to your terminalโs color scheme
Built-in themes with semantic highlighting
Full customization via
key_bindings
andtheming
options
See Theming Docs .
๐บ VNC Console Access
Zero-config embedded noVNC client
Automatic authentication
Works with VMs, containers, and node shells
Secure local WebSocket proxy
โ ๏ธ Node VNC shells still require password auth (Proxmox limitation). Ensure VNC ports are accessible.
๐ค Contributing
Report issues on GitHub Issues
Submit pull requests (code, docs, testing)
Star โญ the repo to support development
๐ License & Disclaimer
Licensed under the MIT License
Proxmoxยฎ is a registered trademark of Proxmox Server Solutions GmbH
This project is not affiliated with or endorsed by Proxmox Server Solutions GmbH
Conclusion
If you love Proxmox but want something faster than the browser and friendlier than memorizing CLI commands, give pvetui a try.
Itโs a modern, fast, terminal-native interface for day-to-day Proxmox management โ built for admins who live in the shell.
ย