Installation

Prerequisites

• Rust 1.70+ - Install from rustup.rs
• For iOS: Xcode 15+ with command line tools
• For Android: Android Studio with NDK installed
• For Java: JDK 8+ with javac and a C compiler for the JNI bridge
• For C#: .NET SDK 10.0+ for the current C# demo and generated binding tests
• For Python: Python 3.10+ with pip

Install the CLI

cargo install boltffi_cli

Download a prebuilt CLI

Each GitHub release includes a CLI archive and a matching SHA-256 checksum file:

For example, download and verify the Windows ARM64 build in PowerShell. Replace <VERSION> with the release version without the leading v:

$version = "<VERSION>"
$asset = "boltffi-windows-arm64.zip"
$release = "https://github.com/boltffi/boltffi/releases/download/v$version"

Invoke-WebRequest "$release/$asset" -OutFile $asset
Invoke-WebRequest "$release/$asset.sha256" -OutFile "$asset.sha256"

$expected = (Get-Content "$asset.sha256" -Raw).Trim().Split()[0]
$actual = (Get-FileHash $asset -Algorithm SHA256).Hash.ToLowerInvariant()
if ($actual -ne $expected) {
    throw "Checksum verification failed"
}

Expand-Archive $asset -DestinationPath .
.\boltffi.exe check

Add to your project

Add BoltFFI to your library crate:

cargo add boltffi
cargo add --build boltffi

Then configure your library crate:

[package]
name = "mylib"
version = "0.1.0"
edition = "2021"

[lib]
crate-type = ["staticlib"]

Add cdylib if you also need a standalone Rust shared library outside BoltFFI packaging, including the current C# generate-and-integrate flow:

[lib]
crate-type = ["staticlib", "cdylib"]

Create build.rs

Create a build.rs file in your project root:

fn main() {
    boltffi::build::generate();
}

Verify installation

boltffi check

This verifies you have the required tools and Rust targets installed. Run boltffi check --fix to auto-install missing targets.