Skip to main content

nff

nff — let coding agents iterate on hardware

PyPI License: MIT Built with Rust Boards MCP nff platform

nff is an MCP server that gives coding agents direct control over physical hardware — on the bench during development, and in the field for maintenance and diagnosis.

Connect your board over USB and Claude writes, compiles, flashes, and reads serial output autonomously. Deploy devices with the nff-sdk-c library and Claude can reach them remotely: capture crash state, diagnose failures, and push fixes — without physical access.

nff is the open-source bench CLI of the nff platform — an end-to-end, agent-driven system for developing, shipping, and operating ESP32-class firmware (bench → OTA → fleet diagnosis). This repo (nff) and the device library (nff-sdk-c) are the two MIT-licensed pieces that run on the engineer's laptop and hardware; the hosted backend (fleet broker, OTA orchestration, crash-analysis engine) is proprietary.

nff platform

you: "Run the sensor init sequence and assert the calibration values over serial"
LLM: [writes firmware] → [compiles] → [flashes ESP32] → [reads serial] → returns structured output

you: "Why did the unit in the field just hard-fault?"
LLM: [captures panic over OTA] → [reads registers + backtrace] → "Stack overflow in your sensor ISR at line 47"

Supported boards: with the PlatformIO backend (now the default in both the shipped Rust binary and the Python implementation) nff is board-universal — any of PlatformIO's ~1000+ boards across ~40 hardware platforms (every ESP32 variant, RP2040/Pico, all STM32 families, classic & megaAVR, SAMD/SAM, Teensy, nRF51/nRF52, Renesas RA / Arduino Uno R4, NXP LPC, Kendryte K210, GD32V/RISC-V, MSP430, TIVA, and many more), with the platform toolchain auto-installed on first build. The classic arduino-cli backend remains available and covers ESP32 (CP210x / CH340) · ESP8266 (FTDI) · Arduino AVR (Uno, Mega, Nano, Leonardo). See Build backends and the full Supported Boards listing.

Bench to fleet, over-the-air. The loop doesn't stop at the bench: nff ota deploy ships the binary you just built to a whole device group — a staged, ECDSA-signed rollout with per-device tracking and automatic rollback — and nff fleet --watch shows it land in real time. See Ship it over-the-air.

Shipped as a single Rust binary. The release artifact is the compiled nff binary built from nff-rs/ — a self-contained executable with no Python runtime required. The Python package under nff/nff/ remains as the reference/prototyping implementation (features are often prototyped there first, then ported to Rust at parity); both are kept in sync, version for version. The Rust port is at full feature parity (CLI commands, MCP server + OAuth proxy, the bench-loop hardening, the PlatformIO build backend, and the nff pi Raspberry-Pi probe).

Quickstart

Get your hardware on the LLM loop in under five minutes.

1. Install

One-liner (recommended — no Python needed):

macOS / Linux:

curl -fsSL https://nanoforgeflow.com/install.sh | sh

Windows (PowerShell):

irm https://nanoforgeflow.com/install.ps1 | iex

Staging versions :

curl -fsSL https://nanoforgeflow.com/install-staging.sh | sh
irm https://nanoforgeflow.com/install-staging.ps1 | iex

Or via pip (depreciated post 0.2.37):

pip install nff

pip install nff fetches a prebuilt wheel containing the same compiled Rust binary for your platform — no Rust toolchain needed at runtime. pip is just the delivery mechanism; the installed nff command is the native binary.

2. Install board cores

On the default PlatformIO backend there is nothing to install here — PlatformIO Core is set up by nff init, and the platform/framework/esptool for your board auto-install on the first build. Just make sure your sketch names a PlatformIO board id (--board esp32dev, etc.).

Both toolchains (platformio / arduino-cli) are auto-installed by nff init/nff install-deps for the active backend if not already present.

3. Plug in your board and run init

nff init                      # local-first, NO sign-in — default PlatformIO backend (board-universal)
nff init --backend arduino    # opt into the arduino-cli backend instead
nff init --cloud              # also sign in to the nff platform (browser) + device onboarding

This single command:

  • Needs no account — local mode is the default and init never opens a browser or prompts for sign-in. Pass --cloud (or run nff auth login at any time) to enable the cloud features (repair, agent, OTA, device onboarding). See Local mode is the default below.
  • Detects your board by USB vendor/product ID
  • Writes ~/.nff/config.json (default device + build backend/board)
  • Installs the active backend's toolchain if missing (PlatformIO Core, or arduino-cli)
  • With --cloud (or an existing sign-in) on the arduino backend with an ESP32, optionally enrolls the board on the nff platform (flash bootstrap firmware → claim into your dashboard)
  • Registers the nff MCP server with Claude Code (claude mcp add --scope user --transport http nff http://127.0.0.1:3010/mcp)
  • Starts the MCP server in the background so Claude Code finds it already running — no manual nff mcp needed
  Local mode (default) — no account needed for build/flash/monitor/debug.
  ✓ Found: ESP32 (CP210x) on COM10
  ✓ Config written to ~/.nff/config.json
  ✓ Registered with Claude Code CLI (HTTP MCP on 127.0.0.1:3010)
  ✓ Server running on http://127.0.0.1:3010/mcp

✓ nff configured! Restart Claude Code to pick up the nff MCP server.

The background server runs until you reboot or stop it. After a reboot, run nff mcp (or just re-run nff init) to bring it back up — nff doctor will tell you if it's down.

Local mode is the default

You don't need an nff account to use nff. Compile, flash, monitor, debug, and the MCP tools all run entirely on your machine, and a plain nff init never opens a browser or asks you to sign in. nff doctor reports a clean bill of health for a local-only setup.

Only the cloud features need an account: nff repair, nff agent, OTA, and device onboarding. Opt in whenever you want them with nff init --cloud or nff auth login — signing in also lifts offline mode automatically. nff init --offline (or NFF_OFFLINE=1) persists a hard offline mode that additionally silences the cloud hints until you sign in.

4. Verify

nff doctor

5. Talk to your board

Restart Claude Code (so it picks up the MCP server) and just describe what you want — Claude compiles, flashes, and reads serial through nff:

you: "Flash sketches/blink_esp32 and confirm the LED is toggling over serial"
LLM: [compiles] → [flashes ESP32] → [reads serial] → "LED toggling at 1 Hz, confirmed"

Prefer the CLI directly? The same loop is a one-liner:

nff flash sketches/blink_esp32
nff monitor --timeout 10

Two modes, one tool

Bench development

nff closes the edit–compile–flash–debug loop. Instead of switching between your editor, terminal, and serial monitor, you stay in one conversation. The LLM iterates on firmware in response to serial output, catches exceptions, and reflashes — handling the logistics so you focus on the problem.

Field maintenance

Once a device is deployed, nff becomes your remote window into it. When a bare-metal MCU crashes in the field there is no shell, no SSH, no process table — just a panic on a chip you cannot physically touch. nff captures the crash state (registers, stack, memory, backtrace) and routes it to a cloud AI agent that explains the failure in plain language and drives the recovery. No truck roll. No JTAG probe on-site.

This is the gap Mender, balena, and similar OTA tools cannot fill: they require a living network client running inside the firmware. nff's field mode works precisely when the firmware is dead.


Ship it over-the-air — nff ota

The bench loop ends with a compiled binary; nff ota is how that binary reaches the fleet. One command turns a local build into a staged, signed rollout to a device group — with per-device progress and automatic rollback on failure. The same "push and it's live" motion as a web deploy, for firmware in the field.

you: "The fix is verified on the bench — roll 1.2.0 out to the prod group"
LLM: [compiles] → [ota_deploy v1.2.0 → prod] → [fleet_status] → "18/18 devices committed, 0 rollbacks"

Prefer the CLI directly? A deploy is one line, and a live fleet view is another:

nff ota deploy build/firmware.bin --version 1.2.0 --group prod
# OK: deployment 3f2a… started (v1.2.0)
#   delivered=18 failed=0 skipped=0
#   track it with `nff ota status 3f2a…`

nff ota status        # per-device progress of the latest deployment
nff fleet --watch     # live table: device status, current → target firmware, OTA progress
Command What it does
nff ota deploy BINARY --version X.Y.Z --group NAME Ship a compiled .bin to a device group as a staged OTA rollout. --max-in-flight N caps devices updating concurrently; --retries N sets the per-device retry budget
nff ota status [DEPLOYMENT_ID] Show a deployment's per-device progress (the project's latest if omitted)
nff ota list List recent deployments and deployable firmware versions for your project
nff ota devices List enrolled devices and their OTA status / current firmware version
nff fleet [--watch] Show field devices with live status, firmware version, and OTA progress

Signed, staged, and downgrade-proof. The bench builds the binary, but a field device only ever accepts an ECDSA-signed update delivered by the fleet (signing keys live in an HSM) — so the update ships through the platform, never from the bench directly. Versions are strict 3-part semver and must increase: devices refuse downgrades. Rollouts stay staged (--max-in-flight), and a device that fails verification rolls itself back to the previous firmware.

OTA is a cloud feature: it needs a platform sign-in (nff auth login, or nff init --cloud) and refuses to run in offline mode. Deployments run under your project — the platform verifies membership and drives the rollout.

The same capability is exposed to agents as MCP tools — see Fleet & OTA below.


MCP Tools

Bench — hardware & build

Tool What it does
list_devices() List all connected USB boards
compile(sketch?, code?, board?) Compile a sketch only (no board/port) to verify it builds; returns JSON {ok, fqbn, elf, image, artifacts, errors, output}
flash(sketch?, code?, board?, port?) Compile and upload a sketch to the connected board
serial_read(duration_ms?, port?, baud?) Capture serial output for N ms
serial_write(data, port?, baud?) Send a string to the device
reset_device(port?) Toggle DTR to hardware-reset the board
get_device_info(port?) Return port, board name, FQBN, baud rate

Debug — live on-chip (JTAG/SWD)

Pause a running device and inspect it at the source level — like a real debugger, not just serial prints. nff drives OpenOCD + GDB itself (binaries come from the PlatformIO toolchain). Supported targets: ESP32-S3/C3/C6 (built-in USB-JTAG) and STM32 via an ST-Link probe (e.g. on-board on a Nucleo/Discovery); the board is auto-detected from USB. Most tools require a halted target (hit a breakpoint or call pause_execution first); symbols are optional — with no ELF you can still attach and read registers/memory/raw-GDB.

Tool What it does
debug_start(elf?, board?, interface?) Launch OpenOCD + GDB, load the last build's firmware.elf, and reset+halt the target. Returns session info (chip, halt state, current frame)
debug_stop() Stop the session and shut down OpenOCD + GDB
get_session_info() Whether a session is active, the chip, halt state, and current frame
get_call_stack() Call stack — function, file, line per frame
get_variables(frame?) Local variables and arguments in a frame (default 0)
expand_variable(expression) Expand a struct/array/pointer into its children
get_registers() Core CPU registers → name : hex value
get_memory(address, count?) Raw memory as a hex dump (default 64 bytes)
evaluate(expression) Evaluate a C/C++ expression in the current frame (GDB syntax)
set_breakpoint(location) Breakpoint at file:line or a function name
pause_execution() / continue_execution() Halt / resume the target
step(kind?) Step over (default) / into / out
gdb_command(command) Raw GDB passthrough — MI commands (starting with -) return structured JSON, console commands return text

Classic ESP32 / ESP32-S2 have no built-in JTAG: connect an external probe and pass interface= (e.g. ftdi/esp32_devkitj_v1). nff debug check reports the detected chip / OpenOCD / GDB / ELF without touching hardware.

Field — diagnosis & auth

Tool What it does
repair(serial_output, build_id?, board?) Send serial/crash output to the diagnosis server and return a structured diagnosis
authenticate(email?, password?) Log in to the diagnosis server (direct, or omit both for browser OAuth)
complete_authentication(timeout?) Wait for a browser login to finish and store the tokens
auth_status() / auth_logout() / auth_clear() / auth_reconnect(email?, password?) Inspect, end, force-clear, or re-establish the authenticated MCP session

Fleet & OTA

Ship firmware to the field and watch it land — the agent-facing side of nff ota.

Tool What it does
ota_deploy(bin_path, version, group, …) Ship a compiled .bin to a field device group over-the-air (staged, signed rollout). bin_path is the image path returned by compile — compile first, then deploy. version must be 3-part semver and greater than the fleet's current version (devices refuse downgrades). Returns JSON {deployment_id, version, delivered, failed, skipped}
ota_status(deployment_id?) Per-device progress of one deployment (the project's latest if omitted) — each job has device_id, status (pending|downloading|verifying|committed|rolled_back|timed_out) and progress 0–100
ota_deployments() Recent OTA deployments + deployable firmware versions for your project
ota_devices() Enrolled field devices with online/offline status, current firmware version, and OTA enrollment state (for USB-attached bench boards use list_devices)
fleet_status(deployment_id?) One-shot fleet snapshot: enrolled devices merged with the latest (or given) deployment's per-device jobs — the terminal equivalent is nff fleet --watch

All five require platform login — on a not-authenticated error, call authenticate (CLI: nff auth login).

All bench tools fall back to the default device in ~/.nff/config.json when port and board are omitted.

Prefer sketch= (a path) over code=. Write the .ino file to disk first and pass the sketch path, rather than raw source — it keeps the build artifact lookup deterministic. Use compile to check a build with no board attached; use flash only when a port is present.


Demo

nff Demo

Real Hardware

Real Hardware Programming


CLI Reference

Command status

What actually ships on the Rust binary today. stable = works; roadmap = present but a stub / not yet implemented. Full detail and the plan behind the roadmap items live in docs/ROADMAP.md.

Command State Notes
nff init stable Detects the board, writes config, registers + starts the MCP server. Local-first: no sign-in by default — nff init --cloud opts into the platform
nff compile stable PlatformIO (default) + arduino backends; no board/port needed
nff flash stable Compile and upload
nff monitor stable Stream serial output
nff debug stable On-chip debugging (OpenOCD + GDB)
nff doctor stable Dependency + config health check
nff status stable Snapshot: build backend, board, MCP server, auth, last build
nff clean stable
nff install-deps stable
nff mcp stable Bare nff mcp starts the server; stop / restart / logs manage the background one
nff auth / deauth stable Browser OAuth or headless login
nff repair stable Cloud diagnosis (needs login)
nff agent stable Cloud agent over SSE (needs login)
nff provision batch stable Fleet batch enrollment
nff pi probe stable Raspberry-Pi reachability probe
nff update stable Self-update to the latest release; standalone installs also auto-update in the background
nff ota stable Over-the-air rollout to a device group: deploy / status / list / devices — staged, signed, downgrade-proof (needs login). See Ship it over-the-air
nff fleet stable Live table of field devices: status, current → target firmware, OTA progress (--watch, needs login)
nff connect 🚧 roadmap Autonomous log-analysis + repair loop — not yet implemented

Real hardware

Command Description
nff init Detect board, write config, register + start the MCP server (no sign-in by default; --cloud opts in)
nff compile <path> Compile a sketch to verify it builds (no board/port needed)
nff flash <path> Compile and upload a sketch directory
nff monitor Stream serial output (Ctrl+C to exit)
nff connect 🚧 (roadmap — not yet implemented) Attach to a device, continuously analyse its logs, autonomously repair detected issues
nff debug Live on-chip debugging (OpenOCD + GDB over JTAG/SWD); nff debug check reports the tools/chip without hardware, nff debug start opens an interactive session
nff repair Send captured serial/crash output to the diagnosis server for a structured root-cause
nff ota deploy <bin> --version X.Y.Z --group NAME Ship a compiled binary to a field device group as a staged, signed OTA rollout (needs login)
nff ota status Per-device progress of the latest (or a given) OTA deployment
nff fleet --watch Live table of field devices with firmware versions and OTA progress
nff auth login Authenticate with the diagnosis server (browser OAuth or email/password)
nff doctor Check all dependencies and configuration
nff status Snapshot of the bench: build backend, detected board, MCP server up/down, auth state, and last build artifact
nff mcp Start the MCP server (streamable HTTP on 127.0.0.1:3010; started in the background by nff init). nff mcp stop / restart / logs manage that background server
nff flash sketches/sensor_init
nff flash sketches/sensor_init --board esp32dev --port COM3   # PlatformIO board id (default backend)
nff flash sketches/sensor_init --board esp32:esp32:esp32      # arduino FQBN (NFF_BUILD_BACKEND=arduino)
nff flash sketches/sensor_init --manual-reset                 # for boards without auto-reset
nff monitor --port COM10 --baud 115200
nff monitor --port COM10 --baud 115200 --timeout 15

Supported Boards

On the default PlatformIO backend, nff is board-universal. Pass any of PlatformIO's ~1000+ board ids to --board and the matching platform toolchain (compiler + framework + uploader) installs itself on first build — there is no fixed allow-list and nothing to pre-install.

Architectures & platforms covered

The PlatformIO backend gives nff every PlatformIO development platform — each one a whole family of boards. You don't need any of these in nff's catalog; just pass the PlatformIO board id to --board and the toolchain installs on first build. The table below is the full set of platforms (≈40), each spanning dozens-to-hundreds of individual boards.

Platform (--board resolves it) Core / MCU family Example boards & --board ids
espressif32 Espressif ESP32 (Xtensa LX6/LX7 + RISC-V) ESP32, ESP32-S2, ESP32-S3, ESP32-C3/C6/H2, ESP32-P4 — esp32dev, esp32-s3-devkitc-1, esp32-c6-devkitc-1
espressif8266 Espressif ESP8266 (Tensilica L106) NodeMCU, Wemos D1 — esp01_1m, nodemcuv2, d1_mini
raspberrypi Raspberry Pi RP2040 / RP2350 (ARM Cortex-M0+/M33) Pico, Pico W, Pico 2 — pico, rpipicow, rpipico2
atmelavr Classic 8-bit Atmel AVR Arduino Uno/Mega/Nano/Leonardo, Pro Mini — uno, megaatmega2560, nanoatmega328, leonardo
atmelmegaavr Atmel megaAVR (0-series) Arduino Uno WiFi Rev2, Nano Every — uno_wifi_rev2, nano_every
atmelsam Atmel SAM (ARM Cortex-M0+/M3/M4) Arduino Zero/MKR/Due, Adafruit Feather M0/M4 — mkrwifi1010, adafruit_feather_m4, due
ststm32 ST STM32 (ARM Cortex-M0/0+/M3/M4/M7) — F0/F1/F2/F3/F4/F7/G0/G4/H7/L0/L1/L4/L5/U5/WB/WL Blue Pill, Black Pill, every Nucleo/Discovery — bluepill_f103c8, genericSTM32F103C8, nucleo_f401re, nucleo_h743zi
ststm8 ST STM8 (8-bit) STM8S Discovery, sduino — stm8sdiscovery
teensy PJRC Teensy (ARM Cortex-M4/M7) Teensy 3.x / 4.0 / 4.1 / LC — teensy41, teensy40, teensy36, teensylc
nordicnrf52 Nordic nRF52 (ARM Cortex-M4, BLE) Adafruit Feather/ItsyBitsy nRF52840, Nano 33 BLE — nano33ble, adafruit_feather_nrf52840
nordicnrf51 Nordic nRF51 (ARM Cortex-M0, BLE) micro:bit v1, BBC boards — bbcmicrobit, nrf51_dk
renesas-ra Renesas RA4M1 (ARM Cortex-M4) Arduino Uno R4 Minima / WiFi — uno_r4_minima, uno_r4_wifi
nxplpc NXP LPC (ARM Cortex-M0/M3/M4) mbed LPC1768, LPC11U24 — lpc1768, lpc11u35
nxpimxrt NXP i.MX RT (ARM Cortex-M7) MIMXRT1060/1010 EVK — mimxrt1060_evk
freescalekinetis NXP/Freescale Kinetis (ARM Cortex-M0+/M4) FRDM-K64F, FRDM-KL25Z — frdm_k64f, frdm_kl25z
siliconlabsefm32 Silicon Labs EFM32 (ARM Cortex-M) EFM32 Giant/Wonder Gecko — efm32gg_stk3700
gd32v GigaDevice GD32V (RISC-V) Sipeed Longan Nano — sipeed-longan-nano
kendryte210 Kendryte K210 (RISC-V, AI) Sipeed MAIX — sipeed-maix-bit
microchippic32 Microchip PIC32 (MIPS) chipKIT Uno32, Max32 — chipkit_uno32, chipkit_max32
timsp430 TI MSP430 (16-bit) MSP430 LaunchPads — lpmsp430g2553, lpmsp430fr6989
titiva TI TIVA C (ARM Cortex-M4) Tiva C / Stellaris LaunchPad — lptm4c1230c3pm, lplm4f120h5qr
infineonxmc Infineon XMC (ARM Cortex-M) XMC2Go, XMC1100 Boot Kit — xmc1100_xmc2go
intel_arc32 Intel Curie (ARC) Arduino/Genuino 101 — genuino101
wiznet7500 WIZnet W7500 (ARM Cortex-M0, Ethernet) WIZwiki-W7500 — wizwiki_w7500
lattice_ice40 Lattice iCE40 FPGA TinyFPGA B2, iCEstick — icezum, tinyfpga_b2

Less common platforms PlatformIO also ships (and that nff therefore drives) include nuclei, riscv_gap, samd21, chipsalliance, aceinna_imu, shakti, samsung_artik, and others — see the PlatformIO platforms index for the live, complete list.

Curated families (built-in catalog)

These are the board ids in nff's built-in catalog. The catalog only supplies sensible defaults (PlatformIO platform) so you can name a short board id and nff init can auto-detect — every other board above still builds, you just pass the full PlatformIO id.

Family PlatformIO platform Catalogued --board ids
ESP32 espressif32 esp32dev, esp32-s3-devkitc-1, esp32-c3-devkitm-1, esp32-c6-devkitc-1, esp32-s2-saola-1
ESP8266 espressif8266 esp01_1m, nodemcuv2
RP2040 / Pico raspberrypi pico, rpipicow
STM32 ststm32 genericSTM32F103C8, bluepill_f103c8, nucleo_f401re
Classic AVR atmelavr uno, megaatmega2560, nanoatmega328, leonardo

Need a board that isn't catalogued (Teensy, SAMD, nRF52, Uno R4, ESP32-P4, …)? Just give its PlatformIO id — e.g. nff compile sketch.ino --board teensy41. Adding it to the catalog (for auto-detect + a short default) is a two-line PR.

USB auto-detect

When you plug a board in, nff resolves it by USB vendor/product ID to a default board id for both backends, so nff init and --board-less commands "just work". A USB-serial chip (CP210x/CH340/FTDI) is shared by many boards, so this is a default you can override with --board.

Board Vendor ID Product ID FQBN (arduino) PlatformIO board id
ESP32 (CP210x) 10c4 ea60 esp32:esp32:esp32 esp32dev
ESP32 (CH340) 1a86 7523 esp32:esp32:esp32 esp32dev
ESP8266 (FTDI) 0403 6001 esp8266:esp8266:generic esp01_1m
Arduino Uno 2341 0043 arduino:avr:uno uno
Arduino Mega 2560 2341 0010 arduino:avr:mega megaatmega2560
Arduino Leonardo 2341 0036 arduino:avr:leonardo leonardo
Arduino Nano 2341 0058 arduino:avr:nano nanoatmega328

The arduino backend (NFF_BUILD_BACKEND=arduino) is limited to the FQBN column above plus whatever cores you arduino-cli core install. The PlatformIO backend is the one that makes the rest of the families above available.


Self-Update

nff keeps itself current the way Claude Code does. After a command finishes, a throttled (default: once per 24 h) detached background check downloads the latest GitHub Release binary, verifies it against the release's SHA256SUMS, sanity-runs it, and atomically swaps it into place — the next invocation runs the new version, and a ✓ nff updated itself to vX.Y.Z notice appears on stderr. Nothing is added to the latency of the command you ran.

  • Only standalone installs auto-update (the install.sh / install.ps1 one-liners). pip/pipx/uv wheel installs (being deprecated) just get a "new version available — reinstall standalone" notice; dev checkouts are left alone.
  • nff update runs the same flow in the foreground; nff update --check only reports (exit 2 when a newer release exists — scriptable).
  • If an update fails, nff calls the doctor: nff update runs nff doctor automatically for diagnostics, and a failed background attempt is surfaced on your next command with a pointer to nff update. nff doctor also shows update health (channel, freshness, last error).
  • Opt out with NFF_NO_AUTO_UPDATE=1 (per-run) or "update": {"auto": false} in ~/.nff/config.json (persistent); nff update keeps working either way. NFF_UPDATE_EVERY_HOURS tunes the cadence.
  • A running nff mcp server keeps its old image through a swap — restart it (nff mcp restart) to pick up the new version.

Update state lives in ~/.nff/update.json; the background job logs to ~/.nff/update.log.


Config File

~/.nff/config.json, written by nff init and editable by hand:

{
  "version": "1",
  "default_device": {
    "port": "COM10",
    "board": "ESP32 (CP210x)",
    "fqbn": "esp32:esp32:esp32",
    "baud": 115200
  },
  "build": {
    "backend": "platformio",
    "board": "esp32dev"
  }
}

build.backend selects the toolchain (platformio default, or arduino) and build.board holds the PlatformIO board id; the arduino backend uses default_device.fqbn instead. The NFF_BUILD_BACKEND env var overrides build.backend per-run.


Claude Code Skills

nff ships Claude Code skills bundled inside the package:

Skill When to use
/nff Full pipeline reference — hardware workflows, sketch-first rules, debugging checklist
/nff

Skill files live at nff/skills/ (the source of truth — edit them there) so they ship with every pip install nff, and are also mirrored in .claude/commands/ for project-level use. Copy them into ~/.claude/commands/ to make the slash commands available globally.

The /wokwi-diagram simulation skill moved to the nff-sim package.


Repository Structure

nff/
├── nff/                         # Python package — reference / prototyping implementation
│   ├── cli.py                   # Click CLI — wires every subcommand
│   ├── config.py                # ~/.nff/config.json read/write
│   ├── mcp_server.py            # streamable-HTTP MCP server (Bearer-authed /mcp)
│   ├── commands/
│   │   ├── init.py
│   │   ├── compile_cmd.py       # port-free build check
│   │   ├── flash.py
│   │   ├── monitor.py
│   │   ├── connect.py           # autonomous log-analysis + repair loop
│   │   ├── repair.py            # route crash output to the diagnosis server
│   │   ├── auth_cmd.py          # nff auth login / status / logout
│   │   ├── ota.py               # nff ota — OTA rollout to a device group
│   │   ├── fleet.py             # nff fleet — live fleet/OTA view
│   │   ├── provision.py
│   │   ├── doctor.py
│   │   ├── clean.py
│   │   ├── install_deps.py
│   │   └── mcp_cmd.py
│   ├── tools/
│   │   ├── boards.py            # USB ID detection + PlatformIO board catalog
│   │   ├── serial.py            # serial read/write/stream/reset
│   │   ├── toolchain.py         # backend dispatcher + arduino-cli/esptool wrappers
│   │   ├── backends/
│   │   │   └── platformio.py    # PlatformIO backend (project scaffold, pio run)
│   │   ├── installer.py         # arduino-cli auto-install
│   │   ├── ota_client.py        # /api/ota/* client (deploy, status, fleet snapshot)
│   │   └── auth.py              # diagnosis-server token handling
│   └── skills/                  # /nff skill (ships with the package)
├── nff-rs/                      # Rust port — the shipped binary (full parity)
├── sketches/
│   ├── blink_esp32/
│   └── servo_button/
└── .claude/
    └── commands/
        └── nff.md               # /nff Claude Code skill

The Rust crate under nff-rs/nff/ is the shipped binary and is at full feature parity with the Python package — every CLI command and MCP tool runs natively (no Python runtime). Build it with cargo build --release (binary at nff-rs/target/release/nff). The Python package under nff/nff/ is the reference/prototyping implementation and is kept in sync version-for-version; when you add a feature, land it in both so the two never drift.


Linux: Serial Port Permissions

sudo usermod -aG dialout $USER
# then log out and back in

nff doctor detects this and prints the fix.


License

MIT — see LICENSE.
Copyright (c) 2026 Gauthier Lechevalier

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.

nff-0.2.38-py3-none-win_amd64.whl (4.9 MB view details)

Uploaded Python 3Windows x86-64

nff-0.2.38-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

nff-0.2.38-py3-none-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

nff-0.2.38-py3-none-macosx_10_12_x86_64.whl (4.9 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file nff-0.2.38-py3-none-win_amd64.whl.

File metadata

  • Download URL: nff-0.2.38-py3-none-win_amd64.whl
  • Upload date:
  • Size: 4.9 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for nff-0.2.38-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 069fd78d410faa6e3e19a8580ef495b27bbb62261d0349e4d7be471d4127721c
MD5 2103bf8b2fd9a7ab0097e04325bfa6ae
BLAKE2b-256 87af8097b6d8994b8f9940cf3c183f7a1c4b071e1f1be4da57c6a8e4042ef022

See more details on using hashes here.

File details

Details for the file nff-0.2.38-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nff-0.2.38-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1e10f45af89567aa573dadb1badddafbb23a64416c9cb56af052f5ed37038134
MD5 017bd9f5095b1ac6bbe26e1768905d10
BLAKE2b-256 a7f85c1e4468dbe463b1d8e44dcb28047c66dceb7efcc6f1b10a68603ae754a4

See more details on using hashes here.

File details

Details for the file nff-0.2.38-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: nff-0.2.38-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for nff-0.2.38-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 87d05eb728c13e410669d4fa81a89843ba739d98cbbb1ad5584f63914187cdcf
MD5 9b2114607ab7d2c56be81b1849dcb065
BLAKE2b-256 85f4a5aadfe69fe59f51fbc1eb202ab8f4d98be1a05dd6ca716ee183e3b2ba7d

See more details on using hashes here.

File details

Details for the file nff-0.2.38-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for nff-0.2.38-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d8168aeee062c3992c48daea6196fa64bae5b81f7950ab823cfdab9dfc689d3a
MD5 b4c66265929d02096807f82a5d808abc
BLAKE2b-256 51d295ab66b48f628058b4296b4a18f5804aaea648512fe030714edc21a60291

See more details on using hashes here.

Supported by

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