Skip to content
Docs for briefcase-ai v3.3.0see what’s new.

Build the Rust Core

Prerequisites

  • A recent stable Rust toolchain (Rust 1.70+; CI builds on stable)
  • Python 3.9+
  • maturin

The crates use Rust edition 2021. The Cargo.toml does not pin a minimum Rust version, so any current stable toolchain works.

Clone

Terminal window
git clone https://github.com/briefcasebrain/briefcase-ai-sdk.git
cd briefcase-ai-sdk

The repository is a Cargo workspace with the core library (crates/briefcase-core) and the PyO3 bindings (bindings/python).

Build the Rust Core

Terminal window
cargo build -p briefcase-core --locked

Run Tests

Terminal window
cargo test -p briefcase-core --locked

Build the Python Bindings

Terminal window
pip install maturin
maturin develop

This compiles the Rust core through the bindings and installs the briefcase._native extension into the active environment. Add --release for an optimized build:

Terminal window
maturin develop --release

See Development for the full contributor workflow.

Next steps