LIBREM5-FLASH-IMAGE(1)

πŸ“¦
version 0.0.5 Β· 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

πŸ’– LIBREM5-FLASH-IMAGE πŸ’–

okay bestie, gather round, because today we're talking about librem5-flash-image β€” the manual page for the Image flashing tool for Librem 5 devices. yes, that Librem 5. the phone. we're flashing it. it's giving main character energy and honestly? obsessed. ✨


🌸 NAME 🌸

librem5-flash-image β€” Image flashing tool for Librem 5 devices. no cap, that's literally the whole thing. πŸ’…


✨ DESCRIPTION ✨

so like, here's the whole vibe of how you call it:

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]

and what does it DO, you ask? Flash a Librem 5 or Librem 5 Devkit. that's it. that's the job. πŸ¦‹


πŸŽ€ OPTIONS πŸŽ€

  • -h, --help β€” show this help message and exit. the classic. the icon. πŸ’–
  • --version β€” show program's version number and exit. lil peek at the numbers.
  • --dir DIR β€” download files to DIR instead of yeeting them into a temporary directory. ✨
  • --skip-cleanup β€” skip temporary directory cleanup. leave the mess, live your truth.
  • --skip-flash β€” do all the preparations but don't flash. all dressed up, nowhere to go. πŸŽ€
  • --skip-download β€” use already downloaded files (specified with --dir) instead of downloading. we already have it at home, bestie.
  • --download-attempts DOWNLOAD_ATTEMPTS β€” maximum number of attempts to resume image download. 0 means unlimited, and the default is 10. 🫢

🌈 IMAGE OPTIONS 🌈

  • --dist DIST β€” download an image for this distribution ( byzantium, crimson, dawn, ... ) instead of the current release. pick your era. πŸ’œ
  • --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'. yes it'll figure it out for you, she's smart. ✨
  • --stable β€” download the latest stable image (default, use --snapshot to override). the safe pick. the sensible pick. πŸ‘‘
  • --snapshot β€” download the latest CI snapshot instead of "blessed" images (takes precedence over --stable). living on the edge, love that for you. 😭
  • --image IMAGE β€” flash the given uncompressed image file instead of downloading one. bring your own. πŸŽ€
  • --uboot UBOOT β€” use and flash the given bootloader file instead of downloading one. same energy, but for the bootloader. πŸ’…

🧚 TESTING AND DEBUGGING OPTIONS 🧚

  • --debug β€” enable debug output. turn on the subtitles. 🌸
  • --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. fancy. πŸ¦‹

πŸ’œ INITIAL SETUP OPTIONS πŸ’œ

  • --udev β€” setup udev rules to flash without root permissions. no sudo, no crying, just vibes. periodt. ✨

fr fr, one thing to remember: --snapshot takes precedence over --stable, so if you pass both, snapshot wins. iykyk. πŸ’…

and that's the whole page bestie, no notes. this was librem5-flash-image version 0.0.5, dated March 2025, straight from the User Commands corner of the manual-verse. go forth and flash responsibly, mwah πŸ’–πŸŒΈπŸ¦‹πŸŽ€πŸ’…

πŸ“¦ where this page comes from