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.elfCommands
onmcu run
Upload, flash, run, and stream firmware output.
onmcu list-boards
List the boards available to your account.
onmcu login
Save an API key in your operating system keyring.
Global options
| Option | Environment variable | Purpose |
|---|---|---|
-v, --verbose | — | Include debug, source-file, line-number, and target information in CLI logs. |
-c, --config <PATH> | ONMCU_CLI_CONFIG_PATH | Load controller and upload settings from a TOML file. |
-h, --help | — | Show help. |
-V, --version | — | Print the installed version. |
Place --config before the subcommand:
onmcu --config ./onmcu.toml list-boardsWhat onmcu run does
- The CLI validates the board name against the boards returned for your account.
- It hashes and uploads the firmware in chunks.
- It waits for an available matching device and starts streaming logs.
- When the log stream ends, it checks the final job status.
- It returns
0only 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.