qimi

module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 23, 2026 License: MIT

README

qimi - QEMU Image Manipulator

[!WARNING]
This is not an official PacketStream LLC service or product.

qimi is a command-line tool that allows you to mount QEMU disk images (.qcow2, .qcow2c, .raw) and execute commands inside them using chroot.

Why qimi?

Unlike virt-customize or guestfish, qimi allows you to USE the image (running binaries inside, etc.) like you use as a Linux container, without restriction of guestfish (only the filesystem modifications) or virt-customize (only allows specific set of modifications).
Basically allows you to use .qcow2 image as a docker, but without the need of kvm.

Prerequisites

  • Linux system with root privileges
  • QEMU tools (qemu-nbd)
  • Go 1.24.4 or later (for building from source)

Installation

Build from source:

go build -o qimi ./cmd/qimi

Usage Overview

qimi supports two mounting strategies:

Mode Description Best For
Persistent Mount Mount once, use multiple times Running several commands on the same image
Temporary Mount Auto-mount and unmount for single commands One-off operations

Persistent Mounts

Use persistent mounts when you need to run multiple commands on the same image. This prevents unnecessary remounting overhead.

Mount an Image
sudo qimi mount ./image.qcow2 myimage

This mounts image.qcow2 with the alias myimage. The mount remains active until you unmount it or reboot.

List Active Mounts
sudo qimi ls
Execute Commands
sudo qimi exec -it myimage /bin/bash
Unmount When Done
sudo qimi unmount myimage

Temporary Mounts

For quick, one-time operations, use temporary mounts. qimi automatically handles mounting and unmounting:

sudo qimi exec -it ./image.qcow2 /bin/bash

The image is automatically unmounted when the command completes.

Examples

Interactive Shell Session (Persistent)
# Mount the image
sudo qimi mount ./ubuntu-server.qcow2 ubuntu

# Start interactive session
sudo qimi exec -it ubuntu /bin/bash

# When done, unmount
sudo qimi unmount ubuntu
Quick Package Installation (Temporary)
# One-time command execution
sudo qimi exec ./debian.qcow2 apt-get update
Check What's Mounted
sudo qimi ls

Troubleshooting

Clean Up Stale Mounts

After a system reboot, mounted images are lost but may still appear in the mount list due to tmpfs implementation issues. Clean them up with:

sudo qimi cleanup

Command Reference

Command Description
qimi mount <image> <name> Create a persistent mount
qimi unmount <name> Remove a persistent mount
qimi ls List all active mounts
qimi exec [options] <image/name> <command> Execute command in mounted image
qimi cleanup Remove stale mount entries
exec Options
  • -i - Interactive mode
  • -t - Allocate a TTY

MIT © PacketStream LLC.

Directories

Path Synopsis
cmd
qimi command
internal
nbd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL