Prepare, configure, and manage Firecracker microVMs in seconds!
virtualization
linux
microvm
firecracker
update README
+51
-26
+51
-26
README.md
+51
-26
README.md
···
39
39
40
40
## Usage
41
41
42
-
```bash
43
-
42
+
```
44
43
_______ __ __
45
44
/ ____(_)_______ / / / /___
46
45
/ /_ / / ___/ _ \/ / / / __ \
···
69
68
help Print this message or the help of the given subcommand(s)
70
69
71
70
Options:
72
-
--debian Prepare Debian MicroVM
73
-
--alpine Prepare Alpine MicroVM
74
-
--nixos Prepare NixOS MicroVM
75
-
--fedora Prepare Fedora MicroVM
76
-
--gentoo Prepare Gentoo MicroVM
77
-
--slackware Prepare Slackware MicroVM
78
-
--opensuse Prepare OpenSUSE MicroVM
79
-
--opensuse-tumbleweed Prepare OpenSUSE Tumbleweed MicroVM
80
-
--almalinux Prepare AlmaLinux MicroVM
81
-
--rockylinux Prepare RockyLinux MicroVM
82
-
--archlinux Prepare ArchLinux MicroVM
83
-
--ubuntu Prepare Ubuntu MicroVM
84
-
--vcpu <n> Number of vCPUs
85
-
--memory <m> Memory size in MiB
86
-
--vmlinux <path> Path to the kernel image
87
-
--rootfs <path> Path to the root filesystem image
88
-
--bridge <name> Name of the bridge interface [default: br0]
89
-
--tap <name> Name of the tap interface [default: ]
90
-
--mac-address <MAC> MAC address for the network interface
91
-
--api-socket <path> Path to the Firecracker API socket
92
-
--boot-args <ARGS> Override boot arguments
93
-
--ssh-keys <SSH_KEYS> Comma-separated list of SSH public keys to add to the VM
94
-
-h, --help Print help
95
-
-V, --version Print version
71
+
--debian
72
+
Prepare Debian MicroVM
73
+
--alpine
74
+
Prepare Alpine MicroVM
75
+
--nixos
76
+
Prepare NixOS MicroVM
77
+
--fedora
78
+
Prepare Fedora MicroVM
79
+
--gentoo
80
+
Prepare Gentoo MicroVM
81
+
--slackware
82
+
Prepare Slackware MicroVM
83
+
--opensuse
84
+
Prepare OpenSUSE MicroVM
85
+
--opensuse-tumbleweed
86
+
Prepare OpenSUSE Tumbleweed MicroVM
87
+
--almalinux
88
+
Prepare AlmaLinux MicroVM
89
+
--rockylinux
90
+
Prepare RockyLinux MicroVM
91
+
--archlinux
92
+
Prepare ArchLinux MicroVM
93
+
--ubuntu
94
+
Prepare Ubuntu MicroVM
95
+
--vcpu <n>
96
+
Number of vCPUs
97
+
--memory <m>
98
+
Memory size in MiB
99
+
--vmlinux <path>
100
+
Path to the kernel image
101
+
--rootfs <path>
102
+
Path to the root filesystem image
103
+
--bridge <name>
104
+
Name of the bridge interface [default: br0]
105
+
--tap <name>
106
+
Name of the tap interface [default: ]
107
+
--mac-address <MAC>
108
+
MAC address for the network interface
109
+
--api-socket <path>
110
+
Path to the Firecracker API socket
111
+
--boot-args <ARGS>
112
+
Override boot arguments
113
+
--ssh-keys <SSH_KEYS>
114
+
Comma-separated list of SSH public keys to add to the VM
115
+
--tailscale-auth-key <TAILSCALE_AUTH_KEY>
116
+
Tailscale auth key to connect the VM to a Tailscale network
117
+
-h, --help
118
+
Print help
119
+
-V, --version
120
+
Print version
96
121
```