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 circfirmYou can also just use pip to install it, if the dependencies won’t cause issues:
pip install circfirmExample 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 --helpDocumentation
Documentation for circfirm can be found here
License
This software is provided under an MIT license.
1 maintainer
Metadata
1 maintainer
Release files for circfirm 6.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| circfirm-6.0.0.tar.gz | 8.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| circfirm-6.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.2 MB
Release files / circfirm-6.0.0.tar.gz
| Download URL | circfirm-6.0.0.tar.gz |
|---|---|
| Size | 8.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1023f3a9fd769a89fd8104c441647f342e245229a7eed1beaccb46809a4ba00b
|
|
BLAKE2b-256 checksum How to use checksums |
d513ef42c3240053c3cd835d2e2a9f88c6478486545f584a2e349f09c0eef479
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency logRelease files / circfirm-6.0.0-py3-none-any.whl
| Download URL | circfirm-6.0.0-py3-none-any.whl |
|---|---|
| Size | 25.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
79a9f6bacb18c187ebf2efc3c8d1f04752c44d5cece6159411a75b6489e47cde
|
|
BLAKE2b-256 checksum How to use checksums |
da0c084dc973a74d584748f0a6f5df4e94c56f65050c64c2b9adb3ec5b2a6d90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency log
