fbuild

fbuild

fbuild is a fast, multi-platform compiler, deployer, emulator runner, and serial monitor for embedded development. It reads the same platformio.ini files already used by PlatformIO sketches, but uses a Rust-native, data-driven build pipeline.

Check Ubuntu Check macOS Check Windows Formatting Documentation Build Native Binaries

Build Matrix

These board builds are part of the front door. They show the platform breadth that fbuild actively protects in CI.

AVR

Build Arduino Uno Build Leonardo Build ATmega8A Build ATtiny85 Build ATtiny88 Build ATtiny4313

MegaAVR

Build ATtiny1604 Build ATtiny1616 Build Nano Every

Renesas

Build UNO R4 WiFi

ESP8266

Build ESP8266

ESP32

Build ESP32 Dev Build ESP32-C2 Build ESP32-C3 Build ESP32-C5 Build ESP32-C6 Build ESP32-H2 Build ESP32-P4 Build ESP32-S2 Build ESP32-S3

CH32V (RISC-V)

Build CH32V003 Build CH32V103 Build CH32V203 Build CH32V208 Build CH32V303 Build CH32V307

CH32X (RISC-V, USB PD)

Build CH32X035

Teensy

Build Teensy 4.1 Build Teensy 4.0 Build Teensy 3.6 Build Teensy 3.5 Build Teensy 3.2 Build Teensy 3.1 Build Teensy 3.0 Build Teensy LC

STM32

Build STM32F103C8 Build STM32F103CB Build STM32F103TB Build STM32F411CE Build STM32H747XI Build Nucleo F429ZI Build Nucleo F439ZI Build Arduino Giga R1

SAM / SAMD

Build Arduino Due Build SAMD21 Build Arduino Zero Build SAMD51J Build SAMD51P

RP2040 / RP2350

Build RP2040 Build RP2350

Nordic NRF52

Build nRF52840 DK Build SuperMini nRF52840 Build nice!nano nRF52840 Build nRFMicro nRF52840 Build Adafruit Feather NRF52840 Sense

Apollo3

Build Apollo3 RedBoard Build Apollo3 expLoRaBLE

NXP LPC (Cortex-M0+)

Build LPC804 Build LPC845 Build LPC845-BRK Build LPCXpresso804 Build LPCXpresso845-MAX

Silicon Labs

Build MGM240 Build SparkFun Thing Plus Matter

Raspberry Pi Pico

Build Raspberry Pi Pico Build Raspberry Pi Pico 2

Board descriptions and family deep-dives live in docs/BOARD_STATUS.md.

Build performance

Arduino CLI vs PlatformIO vs fbuild Blink build benchmark

The chart is regenerated nightly from clean-output (cold) and immediate repeat (warm) Arduino Uno Blink builds. Raw measurements are discoverable through the benchmark manifest.

Installation

pip install fbuild

For source installs, platform notes, and first-run cache behavior, start with the getting started guide.

Command Quick Start

fbuild reads the same platformio.ini files as PlatformIO. Use these commands as direct replacements for the most common PlatformIO workflows:

fbuild PlatformIO equivalent Use it to
fbuild build pio run Compile the project.
fbuild build --clean pio run --target clean, then pio run Clean and compile the project.
fbuild deploy pio run --target upload Build and upload firmware.
fbuild deploy --clean Clean, then pio run --target upload Clean, build, and upload firmware.
fbuild monitor pio device monitor Monitor serial output without flashing.
fbuild ci pio ci Build one or more sketches for CI.

Pass --platformio to build, deploy, or monitor to delegate that workflow to the installed PlatformIO CLI. fbuild ci is a fbuild-native, PlatformIO-compatible CI command; detailed flags and nested commands are in the CLI reference.

fbuild-only commands

These commands extend beyond the PlatformIO workflow surface:

Command Purpose
fbuild symbols Report per-symbol firmware size and bloat details.
fbuild bloat Inspect symbol back-references and generate bloat graphs.
fbuild reset Reset a device without flashing it.
fbuild purge Purge downloaded packages or run cache garbage collection.
fbuild sync Resolve platformio.ini dependencies into a deterministic lock file.
fbuild daemon Manage the background build daemon, locks, and cache.
fbuild show Show daemon logs and other runtime information.
fbuild device List devices and manage device leases.
fbuild mcp Start the Model Context Protocol server for AI integrations.
fbuild clang-tidy Run clang-tidy static analysis on project sources.
fbuild iwyu Run include-what-you-use analysis on project sources.
fbuild clangd-config Generate clangd and VS Code configuration for the project.
fbuild test-emu Build and run firmware in an emulator for testing.
fbuild clang-query Run a clang-query matcher against project sources.
fbuild lnk Fetch, verify, and create .lnk resource pointers.
fbuild lib-select Diagnose the LDF-style library selection result.
fbuild compile-many Compile many sketches against one board in parallel stages.
fbuild serial Probe serial ports and read them with board-aware settings.
fbuild bringup Orchestrate build, flash, reset, monitor, and bring-up steps.
fbuild port Scan serial ports with vendor and product identification.
fbuild cache Save, restore, list, and verify portable cache archives.

See fbuild help <command> or the full CLI reference for options and nested subcommands.

Quick Start

Create a minimal Arduino project:

mkdir my-project
cd my-project
mkdir src

Add platformio.ini:

[env:uno]
platform = atmelavr
board = uno
framework = arduino

Add src/main.ino:

void setup() {
  pinMode(LED_BUILTIN, OUTPUT);
}

void loop() {
  digitalWrite(LED_BUILTIN, HIGH);
  delay(1000);
  digitalWrite(LED_BUILTIN, LOW);
  delay(1000);
}

Build it:

fbuild build

On the first build, fbuild downloads the toolchain and framework packages it needs, then caches them for later builds. A successful Uno build writes .fbuild/build/uno/firmware.hex.

Examples

Common workflows:

fbuild build
fbuild deploy --clean
fbuild deploy --monitor
fbuild test-emu . -e uno
fbuild monitor --timeout 60 --halt-on-success "TEST PASSED"

Detailed build, deploy, monitor, and emulator examples live in the CLI reference and emulator testing guide.

Docs Index

The full FAQ-style map is docs/INDEX.md. Common entry points:

Goal Start here
Install fbuild and run the first build docs/getting-started/
Use build, deploy, monitor, or test-emu docs/reference/cli.md
Configure platformio.ini docs/reference/platformio-ini.md
Check board and platform support docs/platforms/
Understand the project rationale docs/WHY.md
Work on fbuild itself docs/development/
Read architecture internals docs/architecture/overview.md

Key Features

  • platformio.ini compatibility for existing Arduino and ESP32 sketches
  • Fast incremental builds with cached toolchains, frameworks, and libraries
  • URL-based package and library management, including GitHub lib_deps
  • Build, deploy, serial monitor, and emulator test workflows from one CLI
  • Cross-platform support on Windows, macOS, and Linux
  • Transparent architecture with Rust workspace internals documented under docs/architecture/

See docs/WHY.md for the full rationale, benefits, and performance notes.

CLI Usage

The user-facing command reference is docs/reference/cli.md. It covers core workflows (build, deploy, monitor, test-emu) and diagnostics such as symbols, bloat, lib-select, compile-many, and ci.

Configuration

fbuild reads platformio.ini project files. The configuration reference, including default_envs, build_flags, lib_deps, upload and monitor settings, and compatibility notes, lives in docs/reference/platformio-ini.md.

Emulator Testing

fbuild can build firmware and run it without hardware via fbuild test-emu or fbuild deploy --to emu. Emulator backends, auto-detection rules, QEMU notes, and known limitations live in docs/guides/emulator-testing.md.

PlatformIO Compatibility: .eh_frame Strip

On supported release builds, fbuild may strip unused GCC .eh_frame unwind metadata to reduce firmware size. The policy, opt-out controls, and rationale are documented in docs/reference/platformio-compatibility.md.

Supported Platforms

fbuild supports AVR, MegaAVR, Renesas RA, ESP8266, ESP32 variants, CH32 RISC-V, Teensy, STM32, SAM/SAMD, RP2040/RP2350, Nordic NRF52, Apollo3, Silicon Labs EFR32, NXP LPC, and WASM via Emscripten.

For the canonical per-board CI badge matrix, support table, and board-family notes, see docs/BOARD_STATUS.md or the platforms docs.

Project Structure

The repository is a Rust workspace with a Python package boundary. The human development guide is docs/development/, and the crate dependency map is crates/CLAUDE.md.

Architecture

Architecture docs are decentralized under docs/architecture/. Start with docs/architecture/overview.md, then follow the subsystem-specific docs.

Development

Testing, troubleshooting, linting, release, and local setup instructions live in docs/development/. Project-wide rules for contributors and LLM agents are in CLAUDE.md.

License

In the spirit of Dan Garcia's permissively licensed software, fbuild is presented as free software.

BSD 3-Clause License

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.5.17)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for niteris from gravatar.com niteris

Requires

Python >=3.10

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

fbuild-2.5.8-cp310-abi3-win_amd64.whl (28.7 MB view details)

Uploaded CPython 3.10+Windows x86-64

fbuild-2.5.8-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (29.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ x86-64

fbuild-2.5.8-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (27.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

fbuild-2.5.8-cp310-abi3-macosx_11_0_arm64.macosx_10_12_x86_64.whl (32.9 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64macOS 11.0+ ARM64

File details

Details for the file fbuild-2.5.8-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: fbuild-2.5.8-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 28.7 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for fbuild-2.5.8-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d1dfd3d1d761aa5d0ce0caa7f5105deff123090fd6a47f5b043bbe530788d997
MD5 0fa3d029768d61b351dad8cdab44d701
BLAKE2b-256 fe54cac2c09b7746e888fac9a7f49ef91b510211aeda9be446c5545b0e5a9735

See more details on using hashes here.

Provenance

The following attestation bundles were made for fbuild-2.5.8-cp310-abi3-win_amd64.whl:

Publisher: release-auto.yml on FastLED/fbuild

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fbuild-2.5.8-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for fbuild-2.5.8-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 89cbf569bdd54f0fa4898ea360cdaccea26ee8dd35c2e6263ae274b527b20c41
MD5 8d891c460bd2363e673316827cd4037c
BLAKE2b-256 1966d9f1068efa66278946e1b9fa9ea8758f1cf2c4bf48df2b0e50c506a50324

See more details on using hashes here.

Provenance

The following attestation bundles were made for fbuild-2.5.8-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release-auto.yml on FastLED/fbuild

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fbuild-2.5.8-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for fbuild-2.5.8-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 46ca632f9bff33b8d1897b88328e0e58a882bc5f086b9d741cc709f6cd03e1e7
MD5 d105d1cb0f502a3cb9bcbfe130d42fd9
BLAKE2b-256 fad8c72b8e6219fae44670d45f591aa6600614120a11652fbe0265820ebf5e79

See more details on using hashes here.

Provenance

The following attestation bundles were made for fbuild-2.5.8-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release-auto.yml on FastLED/fbuild

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fbuild-2.5.8-cp310-abi3-macosx_11_0_arm64.macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for fbuild-2.5.8-cp310-abi3-macosx_11_0_arm64.macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b8866c12051dd114507c7cdaa7638eb499d4c43470f586b887755b86c3caae63
MD5 267ad6fb3125ca7f5e46514fce6be324
BLAKE2b-256 46b255196ce5458430afc66556daa3b2d3bde08ba4ea61da6865db7ca8d0b8af

See more details on using hashes here.

Provenance

The following attestation bundles were made for fbuild-2.5.8-cp310-abi3-macosx_11_0_arm64.macosx_10_12_x86_64.whl:

Publisher: release-auto.yml on FastLED/fbuild

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.5.17

2.5.16

2.5.15

2.5.14

2.5.13

2.5.12

2.5.11

2.5.10

2.5.9

This release

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.0

2.3.24

2.3.15

2.3.14

2.3.13

2.3.12

2.3.11

2.3.6

2.3.5

2.3.3

2.3.2

2.3.1

2.3.0

2.2.31

2.2.30

2.2.29

2.2.28

2.2.27

2.2.26

2.2.25

2.2.24

2.2.23

2.2.22

2.2.21

2.2.20

2.2.19

2.2.18

2.2.17

2.2.16

2.2.15

2.2.14

2.2.13

2.2.12

2.2.11

2.2.10

2.2.9

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.1

2.2.0

2.1.21

2.1.20

2.1.19

2.1.18

2.1.16

2.1.15

2.1.13

2.1.12

2.1.11

2.1.10

2.1.9

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.5.2

1.5.0

1.4.15

1.4.14

1.4.13

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.5

1.4.2

1.3.38

1.3.35

1.3.34

1.3.33

1.3.32

1.3.31

1.3.30

1.3.29

1.3.28

1.3.27

1.3.26

1.3.25

1.3.23

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.1

1.3.0

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.0

1.0.0

0.0.1

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page