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.1.tar.gz (427.5 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.1-py3-none-any.whl (445.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: virtui_manager-1.9.1.tar.gz
  • Upload date:
  • Size: 427.5 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.1.tar.gz
Algorithm Hash digest
SHA256 a31ed97df98468147ad6bb3834027546b1f749679ffb260f47225f7ba98a0eb1
MD5 cfd29e8b95d229fb04cc7de26f409d3d
BLAKE2b-256 56874899ee8600bbeccd050e82e0a7a143e79187b098176ffd59c4724d9011d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: virtui_manager-1.9.1-py3-none-any.whl
  • Upload date:
  • Size: 445.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08e6eaa132786dbc1d04aa6928df618a0f76e091df683ad37e3c45bbf2f4c90d
MD5 4e02e9396f1cc5f9de97727514dc0fa2
BLAKE2b-256 d1d8914622c018a01b507b3ced35e78f7aef1d18e486f33f597104a89bf9a114

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