Introduction

Use the official OnMCU CLI to run firmware on remote microcontrollers.

Use onmcu to upload firmware, reserve a matching board, and stream its logs. When the board stops, the CLI returns the job result to your shell.

onmcu login
onmcu list-boards
onmcu run --board NUCLEO-H743ZI --file ./firmware.elf

Commands

Global options

OptionEnvironment variablePurpose
-v, --verboseInclude debug, source-file, line-number, and target information in CLI logs.
-c, --config <PATH>ONMCU_CLI_CONFIG_PATHLoad controller and upload settings from a TOML file.
-h, --helpShow help.
-V, --versionPrint the installed version.

Place --config before the subcommand:

onmcu --config ./onmcu.toml list-boards

What onmcu run does

  1. The CLI validates the board name against the boards returned for your account.
  2. It hashes and uploads the firmware in chunks.
  3. It waits for an available matching device and starts streaming logs.
  4. When the log stream ends, it checks the final job status.
  5. It returns 0 only for a completed job and a specific non-zero exit code otherwise.

Shell scripts, Cargo, and CI can therefore handle a hardware run like any other command.

Project source

The CLI is open source under the MIT license. Find releases, source code, and issues in onmcu/onmcu-rs.

On this page