Skip to content
FastLEDPublic

About

A blazing fast build tool for Esp32, Teensy, Avr, Nrf, Raspberry Pi, Stm, Mgm240 and more.

Topics

Resources

Stars

14 stars

Watchers

2 watching

Forks

Latest commit

 

History

2,195 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 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 / SAME

Build Arduino Due Build SAMD21 Build Arduino Zero Build SAMD51J Build SAMD51P Build Teknic ClearCore SAME53

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 Uno and ESP32-S3 Blink build benchmark

The chart is regenerated nightly from clean-output (cold) and immediate repeat (warm) Arduino Uno and ESP32-S3 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.

On Windows, fbuild --fix-win enables long paths with administrator approval. Interactive ESP32 commands offer this repair when needed; declining uses a short cache and prints a yellow warning. See Windows setup.

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 install Download an environment's platform, toolchains, framework, tools and lib_deps without compiling (--check exits 2 when something is missing).
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
  • Host tools as Rust-built APE native executables: one binary per tool that runs everywhere fbuild does, even on NixOS (details)
  • Transparent architecture with Rust workspace internals documented under docs/architecture/

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

Host Tools: APE Native Executables

The tools fbuild runs on the host for each platform are moving to FastLED-built Rust executables shipped in a single format: the cosmocc Actually Portable Executable (APE). That covers upload/flash utilities, deployers and image/format helpers that would otherwise come as Python scripts, per-OS vendor binaries, or packages that behave differently on each host. Each tool is built once and runs as a native executable on every host fbuild supports: Linux, macOS and Windows, x86_64 and aarch64. There is one artifact per tool instead of one per OS and CPU, and one behavior to test instead of a matrix.

The goal per platform is to replace its third-party host tools with Rust tools whose bugs FastLED fixes once and then ships as APE, so the fix reaches every host at the same time.

Reference platform: NXP LPC8xx. Its flasher is FastLED's fork of the Rust probe-rs. The fork carries the fixes that make the LPC845-BRK's LPC-Link2 CMSIS-DAP firmware work: spec-default fallbacks when the firmware doesn't answer DAP_Info, an explicit DAP_Connect(Swd) with retry, and a CMSIS-DAP v1 HID transport over nusb (#935, #936). The source is on the tools branch of FastLED/framework-arduino-lpc8xx, and fastled-release-cross.yml cross-builds it today as six per-host release assets: Windows, Linux and macOS, each on x86_64 and aarch64. fbuild pins and checksums all six in crates/fbuild-deploy/src/probe_rs.rs. The APE target is one asset, built and pinned once, that runs on all of those hosts.

Next: WCH CH32V. Its flashers, wlink (WCH-LinkE) and wchisp (USB ISP), are already Rust. fbuild pins them per host in crates/fbuild-deploy/src/wlink.rs and wchisp.rs, and wlink has assets for only three hosts. Every other host needs FBUILD_WLINK_PATH. An APE build removes that gap.

Guaranteed launch, nothing to install

An APE tool launches anywhere fbuild does. Nothing has to be installed on the host: no ape loader, no binfmt_misc registration, no shell support. That guarantee is needed because most Unix hosts can't exec an APE file directly. posix_spawn returns ENOEXEC ("Exec format error") unless an APE handler is registered, and some distros, NixOS among them, ship none. Every fbuild spawn detects the APE magic (MZqFpD=', jartsr=', APEDBG=') and runs the tool through a loader:

Host How an APE tool runs
Windows Natively; an APE file is a valid PE.
Linux fbuild extracts the loader embedded in the tool itself, checks it is a 64-bit ELF for the host CPU, and caches it in an owner-only, exec-capable directory. If no such directory exists (read-only HOME, noexec /tmp), it runs the loader from a sealed in-memory file instead. The tool's environment needs no PATH, sh, coreutils, HOME or TMPDIR.
macOS x86_64: fbuild extracts the tool's embedded loader and turns it into a Mach-O (the prologue's header move). Apple Silicon: fbuild compiles the tool's embedded ape-m1.c once with /usr/bin/cc (Xcode Command Line Tools). Both are cached like on Linux.

Loader precedence is FBUILD_APE_LOADER (explicit override), then the loader embedded in the tool, then ape on PATH, /usr/bin/ape and /usr/local/bin/ape, then /bin/sh. Set FBUILD_APE_CACHE_DIR to choose where extracted loaders are cached. Parallel builds and deploys are safe: fbuild holds a fork lock while it writes a loader, so a concurrent first spawn can't fail with ETXTBSY ("Text file busy").

Adding an APE tool

Build the Rust tool with cosmocc so the output is an APE, provision it like any other package, and spawn it through fbuild_core::subprocess::run_command*, or build the command with fbuild_core::platform::process::command / tokio_command instead of Command::new. The tool then works like any other executable, with no per-host special casing. A hello-world fixture and its build script live in crates/fbuild-core/data/ape-hello/. Implementation notes are in crates/fbuild-core/src/platform/README.md.

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

fbuild is free software licensed under the GNU Affero General Public License v3.0 only (AGPL-3.0-only). See LICENSE.

About

A blazing fast build tool for Esp32, Teensy, Avr, Nrf, Raspberry Pi, Stm, Mgm240 and more.

Topics

Resources

Stars

14 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages