aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a64544d5bafe5c5f20ac08c0e1db88cc6bd766bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
KVMX: vagrant-like QEMU KVM Wrapper
===================================

KVMX is a lightweight implementation of a virtual machine manager
inspired by vagrant.

It may be used for development or as a wrapper for GUI isolation.

This is simple stuff. Don't use it if you need any complex behavior
or integration. In the other hand, if you're looking for a small
application that doesn't depend on software installed from unstrusted
sources, you'll feel welcome here :)

## Instalation

Simply clone it and add to your `$PATH`:

    git clone https://git.fluxo.info/kvmx
    cd kvmx && git verify-commit HEAD

## Basic usage

    kvmx init [project-name] [project-folder] # initialize
    kvmx edit [project-name]                  # customize
    kvmx up   [project-name]                  # bring it up!

If no project name is specified, the current folder name is assumed as the project name.
If no folder is specified, the current folder is assumed as the project home.

## Further reading

See https://blog.fluxo.info/suckless/virtual for details.