Mrdindon / proxhawk-tui
git clone https://github.com/Mrdindon/proxhawk-tui.git
v2.2.1 · 12d ago
A text console for Proxmox VE
+1
stars, 24h · #16,724
+~2
stars, 7 days · #25,752
+139
stars, 30 days · #5,436
139
★ total · +1% this week
6
forks · 0 open issues
Star history (as recorded here)
LanguageShell
LicenseAGPL-3.0
Created2026-10-06 (16d ago)
Last push10d ago
Watchers1
OwnerUser
GitHub topics
Links
README excerpt
# Proxhawk-tui — a text console for Proxmox VE **English** | Français | Español | Deutsch | 简体中文 | Русский Version 2.2.1 · licence AGPL-3.0-or-later `proxhawk-tui` is a text console version of the Proxmox VE web interface (the GUI served on port 8006). It reproduces the layout, the navigation and most panels of the web UI with Unicode box drawing, braille charts, Nerd Font icons and ANSI colours, and needs nothing that is not already installed on a Proxmox VE node. *Demo data.* ## Highlights - **Same layout and menus as the web UI** (checked against the menu definitions of Proxmox VE 9): header bar, resource tree (Server / Folder / Pool / Storage view), per-object navigation menu, toolbar, content panel and the *Tasks / Cluster log* panel. - **Read and write**: every configuration table has *Add / Edit / Remove* (`a` / `e` / `d`). The dialogs are **generated from the API schema** of the call they perform, so they offer the same parameters, choices and defaults as the web UI dialogs, including property strings (`net0`, `scsi0`, `rootfs`...) edited in sub-forms. - **Everything of the GUI**: Datacenter (cluster, options, storage of every type, backup jobs, replication, permissions, users, API tokens, TFA, groups, pools, roles, realms, HA and affinity rules, SDN with zones, VNets, subnets, controllers, IPAM, DNS, VNet firewall, fabrics, route maps, prefix lists, ACME, firewall, metric servers, resource and directory mappings, custom CPU models, notifications), Node (network with apply/revert, certificates and ACME orders, DNS, hosts, time, services, updates, repositories, disks with GPT/wipe, LVM, LVM-Thin, Directory, ZFS, **Ceph** with installation wizard, monitors, OSDs, CephFS, pools), VMs and containers (hardware/resources, cloud-init, options, snapshots, backups, restore, firewall, permissions, HA, clone, template, migrate). - **Console**: `qm terminal` for VMs with a serial port, **SSH for Linux VMs without serial port** (IP found through the guest agent, the neighbour table or a scan of the bridge network), `pct enter` for containers, node shell. - **Tiny footprint**: pure bash + the Perl and `pvesh` that ship with Proxmox VE. `whiptail` (also shipped) or `dialog` for dialogs. No daemon, no dependency, nothing written outside `~/.config/proxhawk-tui` and a temp directory. - **Fast**: a small persistent Perl helper loads the API once and answers requests in milliseconds instead of spawning `pvesh` (1–2 s) for every read. - **Tested**: `tools/integration-test.sh` drives every panel and action against a real node and verifies each write through the API (see docs/TESTING.md). - **Modular**: every panel is a small function in `views/`; themes, icon sets and languages are plain files. - **Keyboard and mouse**, 256 colours, truecolor or 8 colours, Nerd Font, Unicode, pure ASCII or no icons. Key bindings and colours are configurable; ten themes (Dracula, Nord, Gruvbox, Catppuccin, Tokyo Night...). - **34 languages**: Engli