Nanvix

Nanvix: A Microkernel-Based Research Operating System

Quick Start

Linux

Requires Ubuntu 24.04 with sudo privileges and KVM enabled.

# Run on Bash.

# Clone main repository.
git clone https://github.com/nanvix/nanvix.git && cd nanvix

# Setup the development environment.
./z setup

# Build Nanvix.
./z build -- all

# Run an example application.
./bin/nanvixd.elf -console-file /dev/stdout -- ./bin/hello-rust-nostd.elf

Windows

Requires Windows 11 with GNU Make on PATH, Windows Hypervisor Platform enabled, Developer Mode turned on, and a Rust toolchain installed via rustup.

# Run on PowerShell.

# Clone main repository (symlinks require Developer Mode).
git clone -c core.symlinks=true https://github.com/nanvix/nanvix.git; cd nanvix

# Setup the development environment.
.\z.ps1 setup

# Build Nanvix.
.\z.ps1 build -- all

# Run an example application.
.\bin\uservm.exe -kernel .\bin\kernel.elf -initrd .\bin\hello-rust-nostd.elf -standalone

For more details, see the full setup, build, and run guides.

How to Join the Community?

Join us on Slack!