Launch configurable virtual machines with libkrun

Go to file

Jake Correnti 3a369eeee7 docs: add missing URI schemes Signed-off-by: Jake Correnti <jakecorrenti+github@proton.me>		2025-06-10 18:43:26 -04:00
.github/workflows	Add Build & Test to CI	2025-06-10 15:48:12 -04:00
docs	docs: add missing URI schemes	2025-06-10 18:43:26 -04:00
src	Add support for `none` and `unix` URI schemes	2025-06-10 18:43:26 -04:00
.gitignore	Initialize rust crate (cargo init)	2024-02-11 21:13:52 -05:00
CODEOWNERS	CODEOWNERS: add Jake Correnti	2025-02-04 15:44:33 +01:00
Cargo.lock	Add support for `none` and `unix` URI schemes	2025-06-10 18:43:26 -04:00
Cargo.toml	Add support for `none` and `unix` URI schemes	2025-06-10 18:43:26 -04:00
LICENSE	Initial commit, add README and LICENSE	2024-02-11 21:10:05 -05:00
Makefile	Add LIBKRUN_EFI variable	2025-03-14 10:58:05 -04:00
README.md	Update README.md	2025-03-14 10:58:15 -04:00
build.rs	build: Link with libkrun on MacOS	2024-02-17 02:23:09 -05:00
create_release_podman.sh	Add a script to automate releases for podman	2024-06-24 12:37:05 +02:00
krunkit.entitlements	Create Makefile and entitlements file	2024-02-19 09:14:41 -05:00

README.md

krunkit

krunkit is a tool to launch configurable virtual machines using the libkrun platform.

Installation

krunkit relies on the efi flavor of libkrun. At present, libkrun-efi is only available on macOS. We provide a Homebrew repository to install krunkit and all of its dependencies, installable with:

$ brew tap slp/krunkit
$ brew install krunkit

Building from source

As noted above, krunkit relies on the efi flavor of libkrun. Ensure that is installed on your system.

# If libkrun-efi.dylib is not located at /opt/homebrew/opt/libkrun-efi/lib/
# provide the path at which it's located using the LIBKRUN_EFI variable. Otherwise,
# the Makefile will default to using the /opt/homebrew/... path.
$ make LIBKRUN_EFI=<path to libkrun-efi.dylib>

$ sudo make install

Usage

See docs/usage.md.

License: Apache-2.0