Cubic
=====

.. toctree::
   :caption: How-To
   :hidden:

   howto/install
   howto/getting_started
   howto/http_server
   howto/ssh_connect
   howto/console_login
   howto/environment_variables

.. toctree::
   :caption: Troubleshooting
   :hidden:

   troubleshooting/qemu_not_found
   troubleshooting/recover_disk

.. toctree::
   :caption: Internals
   :hidden:

   internals/how_it_works
   internals/security
   internals/qemu_detection

.. toctree::
   :caption: Command Reference
   :hidden:

   reference/run
   reference/create
   reference/instances
   reference/images
   reference/ports
   reference/show
   reference/modify
   reference/console
   reference/ssh
   reference/scp
   reference/exec
   reference/start
   reference/stop
   reference/restart
   reference/rename
   reference/clone
   reference/delete
   reference/prune
   reference/completions

Cubic spins up Linux virtual machines on Linux, macOS and Windows with a single command.

Every distribution comes as a prebuilt cloud image and is ready to use within seconds, so you skip the long installation. Cubic keeps things simple and secure by acting as lightweight glue over proven tools. No privileged system service is required and every VM runs as your normal user, so you never need admin or root rights.
Cubic is built on top of ``QEMU``, ``EDK2``, official cloud images and ``cloud-init``.

Features
---------
* Simple command-line interface
* Supports Alma Linux, Arch Linux, Debian, Fedora, Gentoo, OpenSUSE, Rocky Linux and Ubuntu guest images
* Uses official, checksum-verified cloud images downloaded straight from each distribution
* Supports Linux, macOS and Windows hosts with amd64 and arm64 architecture
* Supports hardware acceleration with KVM (Linux) and Hypervisor (macOS), Windows runs on TCG software emulation for now
* Boots each VM with EDK2 UEFI firmware, discovered automatically per architecture
* No background privileged service and runs with standard user rights, no admin or root needed
* Written in Rust

Source Code
===========

The source code of Cubic is on `Github`_.

.. _Github: https://github.com/cubic-vm/cubic