circfirm 5.2.3

CLI tool for install firmware for CircuitPython boards

A CLI tool for updating the firmware for CircuitPython boards

Installation

The best way to install circfirm is by using pipx, which creates an isolated virtual environment for the dependencies:

pipx install circfirm

You can also just use pip to install it, if the dependencies won’t cause issues:

pip install circfirm

Example Usage

The follow commands show some of the functionality of circfirm:

# Install a version of CircuitPython to a connected board
circfirm install 8.0.0

# Install a version of CircuitPython in French to a connected board
circfirm install 8.0.0 --language fr

# List all the cached (previously downloaded) CircuitPython versions
circfirm cache list

# List all the cached CircuitPython versions for a speciic board
circfirm cache list --board-id feather_m4_express

# Save a version of CircuitPython to the cache
# (You can also use the --language option here)
circfirm cache save feather_m4_express 8.0.0

# Clear the cached CircuitPython versions
circfirm cache clear

# You can use --board-id, --version, and --language options to further specify
# what firmwares should be cleared - this clears version 7.0.0 firmwares for
# all boards and in all languages
circfirm cache clear --version 7.0.0

# See help/information about circfirm or any specific command using --help
circfirm --help
circfirm install --help
circfirm cache save --help

Documentation

Documentation for circfirm can be found here

License

This software is provided under an MIT license.