krunkit

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

[!IMPORTANT] krunkit is only supported on hosts running macOS 14 or newer.

Installation

[!IMPORTANT] If you've ever installed krunkit from the old tap slp/krunkit, to upgrade to the latest version you'll need to follow the Removing the old Homebrew tap instructions first, and then the ones in the Installing from Homebrew section.

Removing the old Homebrew tap

The slp/krunkit tap is now deprecated. If you've ever installed krunkit from it, you'll need to remove all packages from that tap and then the tap itself:

brew list --full-name | grep "^slp/krunkit/" | xargs brew uninstall
brew untap slp/krunkit

Installing from Homebrew

krunkit relies on libkrun. We provide a Homebrew repository to install krunkit and all of its dependencies, installable with:

brew tap slp/krun
brew install krunkit

Building from source

As noted above, krunkit relies on libkrun. Ensure that is installed on your system.

Build and install using default PREFIX (/usr/local):

make
sudo make install

To build with libkrun from Homebrew or MacPorts use the appropriate PREFIX:

make PREFIX=/opt/homebrew
sudo make install PREFIX=/opt/homebrew

Usage

See docs/usage.md.

License: Apache-2.0