Skip to main content

Terminal-based interface to manage virtual machines using libvirt

Project description

VirtUI Manager

A powerful, text-based Terminal User Interface (TUI) application for managing QEMU/KVM virtual machines using the libvirt Python API.

Main

Why VirtUI Manager?

Managing virtual machines in a terminal environment has never been easier or more powerful. VirtUI Manager bridges the gap between the simplicity of command-line tools and the rich functionality of GUI-based solutions, offering the best of both worlds for virtualization administrators.

The Problem with Traditional Tools

  • Virt-manager requires X11 forwarding, which is slow, resource-intensive, and often impossible in remote environments
  • GUI-based solutions are heavy with X dependencies, making them unsuitable for headless servers or low-bandwidth connections
  • Command-line tools lack the intuitive interface needed for complex VM management tasks
  • Cockpit Machine is feature incomplete, and needs a lot of depencies. It is not multi hypervisor oriented

Why VirtUI Manager is Different

VirtUI Manager solves these challenges with:

  • Lightweight Terminal Interface: No X11 dependencies, works perfectly over SSH
  • Remote Management: Efficient low-bandwidth control of remote libvirt servers
  • Rich Feature Set: Advanced VM management capabilities in a simple, intuitive interface
  • Multi-server Support: Manage VMs across multiple libvirt servers from a single interface
  • Performance Optimized: Built-in caching reduces libvirt calls and improves responsiveness
  • Libvirt Event handler: Only get update on event from libvirt
  • Migration Support: Live and offline VM migration capabilities and custom migration
  • Bulk Operations: Execute commands across multiple VMs at once (including configuration)
  • Web Console Access: Integrated VNC support with novnc over ssh tunnel for remote server
  • CMD line interface: improved command line to manage VMs: multi hypervisors, VMs selection, clone operation, bulk command, etc...

Documentation

VirtUI Manager doc

CI check

CI Check

Flatpak build

Build Flatpak

Requirements

  • Recommended Minimal Terminal Size: 34x92. 34x128 is the recommended Size
  • Remote Connection: SSH access to libvirt server (ssh-agent recommended)
  • Python 3.7+
  • libvirt with Python bindings
  • Python Dependencies: textual, pyaml, libvirt-python, markdown-it-py
  • Optional: virt-viewer, novnc, websockify for enhanced functionality

Note about Libvirt API

As there is no simple way to get sound and network model using libvirt API, the user can provides a list in his own configuration file.

To get a list of model for a machine type you can use the qemu command line:

qemu-system-x86_64 -machine pc-q35-10.1 -audio  model=help
qemu-system-x86_64 -machine pc-q35-10.1 -net  model=help

Possible User config parameters:

  • network_models: List of allowed network models (default: ['virtio', 'e1000', 'e1000e', 'rtl8139', 'ne2k_pci', 'pcnet'])
  • sound_models: List of allowed sound models (default: ['none', 'ich6', 'ich9', 'ac97', 'sb16', 'usb'])

Contributing

CONTRIBUTING.md

AI Assist

AI assistance is used to improve coding efficiency by automating boilerplate, suggesting relevant code completions, and quickly detecting bugs.

License

This project is licensed under the GPLv3 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

virtui_manager-1.9.3.tar.gz (462.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

virtui_manager-1.9.3-py3-none-any.whl (471.6 kB view details)

Uploaded Python 3

File details

Details for the file virtui_manager-1.9.3.tar.gz.

File metadata

  • Download URL: virtui_manager-1.9.3.tar.gz
  • Upload date:
  • Size: 462.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for virtui_manager-1.9.3.tar.gz
Algorithm Hash digest
SHA256 13b4406cb2007dc6805f12e000b5a7c32cbed1e7021afe57479a8227d964d58a
MD5 3a117ff6859a9b4e7ddb6518af6fc9fd
BLAKE2b-256 d583a8865a81e54df601f248c0fe9a0ac9e8004c1d7fdc360c609fe8d1d3d5e2

See more details on using hashes here.

File details

Details for the file virtui_manager-1.9.3-py3-none-any.whl.

File metadata

  • Download URL: virtui_manager-1.9.3-py3-none-any.whl
  • Upload date:
  • Size: 471.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for virtui_manager-1.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 353f29832f2a1e51feb53667cd50b8dce4f88f3f9d2eb756599b0a635c4482a5
MD5 f8639c76663748242b69de4f0a550b30
BLAKE2b-256 52559c9b7fef61c5e2e72d6cb879322c548eeba1c54ee0ce8e6266adf3d152fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page