Scroll to navigation

LIBREM5-FLASH-IMAGE(1) User Commands LIBREM5-FLASH-IMAGE(1)

NAME

librem5-flash-image - Image flashing tool for Librem 5 devices

DESCRIPTION

usage: librem5-flash-image [-h] [--version] [--dir DIR] [--skip-cleanup]

[--skip-flash] [--skip-download]
[--download-attempts DOWNLOAD_ATTEMPTS] [--dist DIST] [--variant {plain,luks}] [--board {devkit,librem5r2,librem5r3,librem5r4}] [--stable] [--snapshot] [--image IMAGE] [--uboot UBOOT] [--debug] [--image-job IMAGE_JOB] [--uboot-job UBOOT_JOB] [--embedded-boot] [--udev]

Flash a Librem 5 or Librem 5 Devkit.

options:

show this help message and exit
show program's version number and exit
download files to DIR (instead of a temporary directory)
skip temporary directory cleanup
do all the preparations but don't flash
use already downloaded files (specified with --dir) instead of downloading
maximum number of attempts to resume image download. 0: unlimited, default is 10

image options:

download an image for this distribution ( byzantium, crimson, dawn, ... ) instead of the current release
image variant to download ( plain, luks ), default is 'luks'
type of the board to download ( devkit, librem5r2, librem5r3, librem5r4 ) default is 'auto'
download the latest stable image (default, use --snapshot to override)
download the latest CI snapshot instead of "blessed" images (takes precedence over --stable)
flash the given uncompressed image file instead of downloading one
use and flash the given bootloader file instead of downloading one

testing and debugging options:

enable debug output
Jenkins job to download the image from
Jenkins job to download the uboot from
set the bootloader embedded in the flashed image as bootable instead of using separate boot partition

initial setup options:

setup udev rules to flash without root permissions
March 2025 librem5-flash-image 0.0.5