.. _ref_cubic:

cubic
=====

.. code-block::

    $ cubic --help
    Cubic runs Linux virtual machines on Linux, macOS and Windows with a single
    command.
    
    Every distribution comes as an official 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. Cubic is built on top of QEMU,
    EDK2, official Linux distribution images and cloud-init.
    
    Examples:
    
      Create a new VM instance with:
      $ cubic create example --image ubuntu
      Open a shell in the VM instance:
      $ cubic ssh example
    
      Alternatively, use `run` to execute the above commands in a single command:
      $ cubic run example --image ubuntu
    
      Show all supported VM images:
      $ cubic images
    
      List previously created VM instances:
      $ cubic instances
    
      Show information about a VM instance:
      $ cubic show <instance>
    
      Execute a command in a VM instance:
      $ cubic exec <instance> -- <command>
    
      Transfer files and directories between host and VM instance:
      $ cubic scp <path/to/host/file> <instance>:<path/to/guest/file>
      See `cubic scp --help` for more examples
    
      Every command can be shortened while the short form stays unique:
      $ cubic in
    
    For more information, visit: https://cubic-vm.org/
    The source code is located at: https://github.com/cubic-vm/cubic
    
    Usage: cubic [OPTIONS] [COMMAND]
    
    Commands:
      run          Create and start a VM instance
      create       Create a VM instance
      instances    List VM instances
      images       List VM images
      ports        List ports for VM instances
      show         Show VM images and instances
      modify       Modify a VM instance
      console      Open VM instance console
      ssh          Connect to a VM instance
      scp          Copy data between host and VM instances
      exec         Execute a command in a VM instance
      start        Start VM instances
      stop         Stop VM instances
      restart      Restart VM instances
      rename       Rename a VM instance
      clone        Clone a VM instance
      snapshot     Create a snapshot of a VM instance
      restore      Restore a VM instance from a snapshot
      delete       Delete VM instances and snapshots
      prune        Clear caches
      completions  Generate shell completion scripts
    
    Options:
      -v, --verbose  Increase logging output
      -q, --quiet    Reduce logging output
      -h, --help     Print help
      -V, --version  Print version