diff --git a/README.md b/README.md index 93b2dc1..ede7463 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,7 @@ sudo apt-get install fireup ## Usage -```bash - +``` _______ __ __ / ____(_)_______ / / / /___ / /_ / / ___/ _ \/ / / / __ \ @@ -69,28 +68,54 @@ Commands: help Print this message or the help of the given subcommand(s) Options: - --debian Prepare Debian MicroVM - --alpine Prepare Alpine MicroVM - --nixos Prepare NixOS MicroVM - --fedora Prepare Fedora MicroVM - --gentoo Prepare Gentoo MicroVM - --slackware Prepare Slackware MicroVM - --opensuse Prepare OpenSUSE MicroVM - --opensuse-tumbleweed Prepare OpenSUSE Tumbleweed MicroVM - --almalinux Prepare AlmaLinux MicroVM - --rockylinux Prepare RockyLinux MicroVM - --archlinux Prepare ArchLinux MicroVM - --ubuntu Prepare Ubuntu MicroVM - --vcpu Number of vCPUs - --memory Memory size in MiB - --vmlinux Path to the kernel image - --rootfs Path to the root filesystem image - --bridge Name of the bridge interface [default: br0] - --tap Name of the tap interface [default: ] - --mac-address MAC address for the network interface - --api-socket Path to the Firecracker API socket - --boot-args Override boot arguments - --ssh-keys Comma-separated list of SSH public keys to add to the VM - -h, --help Print help - -V, --version Print version + --debian + Prepare Debian MicroVM + --alpine + Prepare Alpine MicroVM + --nixos + Prepare NixOS MicroVM + --fedora + Prepare Fedora MicroVM + --gentoo + Prepare Gentoo MicroVM + --slackware + Prepare Slackware MicroVM + --opensuse + Prepare OpenSUSE MicroVM + --opensuse-tumbleweed + Prepare OpenSUSE Tumbleweed MicroVM + --almalinux + Prepare AlmaLinux MicroVM + --rockylinux + Prepare RockyLinux MicroVM + --archlinux + Prepare ArchLinux MicroVM + --ubuntu + Prepare Ubuntu MicroVM + --vcpu + Number of vCPUs + --memory + Memory size in MiB + --vmlinux + Path to the kernel image + --rootfs + Path to the root filesystem image + --bridge + Name of the bridge interface [default: br0] + --tap + Name of the tap interface [default: ] + --mac-address + MAC address for the network interface + --api-socket + Path to the Firecracker API socket + --boot-args + Override boot arguments + --ssh-keys + Comma-separated list of SSH public keys to add to the VM + --tailscale-auth-key + Tailscale auth key to connect the VM to a Tailscale network + -h, --help + Print help + -V, --version + Print version ```