---
name: "librem5-flash-image"
section: "1"
platform: "linux"
package: "librem5-flash-image"
version: "0.0.5-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/librem5-flash-image"
---

# librem5-flash-image(1)

Image flashing tool for Librem 5 devices

## 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:

- **-h**, **--help**

  show this help message and exit

- **--version**

  show program's version number and exit

- **--dir** DIR

  download files to DIR (instead of a temporary directory)

- **--skip-cleanup**

  skip temporary directory cleanup

- **--skip-flash**

  do all the preparations but don't flash

- **--skip-download**

  use already downloaded files (specified with **--dir**) instead of downloading

- **--download-attempts** DOWNLOAD\_ATTEMPTS

  maximum number of attempts to resume image download. 0: unlimited, default is 10

### image options:

- **--dist** DIST

  download an image for this distribution ( byzantium, crimson, dawn, ... ) instead of the current release

- **--variant** {plain,luks}

  image variant to download ( plain, luks ), default is 'luks'

- **--board** {devkit,librem5r2,librem5r3,librem5r4}

  type of the board to download ( devkit, librem5r2, librem5r3, librem5r4 ) default is 'auto'

- **--stable**

  download the latest stable image (default, use **--snapshot** to override)

- **--snapshot**

  download the latest CI snapshot instead of "blessed" images (takes precedence over **--stable**)

- **--image** IMAGE

  flash the given uncompressed image file instead of downloading one

- **--uboot** UBOOT

  use and flash the given bootloader file instead of downloading one

### testing and debugging options:

- **--debug**

  enable debug output

- **--image-job** IMAGE\_JOB

  Jenkins job to download the image from

- **--uboot-job** UBOOT\_JOB

  Jenkins job to download the uboot from

- **--embedded-boot**

  set the bootloader embedded in the flashed image as bootable instead of using separate boot partition

### initial setup options:

- **--udev**

  setup udev rules to flash without root permissions