Skip to main content

Installation

Add BoxLite to your Cargo.toml:

Basic Execution

1

Create a file src/main.rs

2

Run it

From Source (Development)

For contributing or local development:
1

Clone the repository

2

Initialize submodules

This step is critical! The build will fail without submodules.
3

Install platform dependencies

4

Build and test

See CONTRIBUTING.md for detailed build instructions.

Next Steps

Core concepts

Understand the different box types, lifecycle, images, and resource configuration.

Architecture Documentation

Understand how BoxLite works — Core components (Runtime, LiteBox, VMM, Portal), Image management and rootfs preparation, Host-guest communication protocol.

Rust API Reference

Complete Rust API reference documentation.