rpi-imager
Write operating system images to storage media
TLDR
Write a specific image to a specific block device
Write a specific image to a block device, disabling the checksum verification
Write a specific image to a block device, which will expect a specific checksum when running the verification
SYNOPSIS
rpi-imager
PARAMETERS
--cli
Run in command-line interface mode (headless).
--repo
Specify a custom image repository URL.
--device
Specify the target device (e.g., /dev/sda). Use with caution!
--image
Specify the image file to write.
--config
Specify a configuration file.
--version
Show the version and exit.
--help
Show help options.
DESCRIPTION
The `rpi-imager` command is a graphical tool (primarily used from a desktop environment) designed for easily writing operating system images to SD cards and USB drives, especially for use with Raspberry Pi devices. It simplifies the process of selecting an operating system image (either from a list of recommended distributions or from a local file) and flashing it to a storage medium. The tool automatically handles formatting the drive and writing the image, making it much more user-friendly than manually using command-line tools like `dd`.
It also offers advanced features such as setting up WiFi credentials and enabling SSH during the image writing process, enabling a ready to use device on first boot. This makes it especially useful for headless (no monitor) Raspberry Pi setups, which are common in IoT and embedded applications.
CAVEATS
Using the `--device` option, especially in command-line mode, requires extreme caution. Incorrectly specifying the device can lead to data loss on the wrong drive. Always double-check the device path before proceeding.
IMAGE REPOSITORY
The image repository used by `rpi-imager` contains metadata about available operating systems, including download URLs and checksums. By default, it uses the official Raspberry Pi repository, but you can specify a custom repository using the `--repo` option. This allows for distributing custom operating system images within an organization.
HEADLESS SETUP
One of the key features of `rpi-imager` is its ability to pre-configure settings such as WiFi credentials and SSH access before writing the image to the SD card. This is particularly useful for setting up Raspberry Pi devices in 'headless' mode, where no monitor, keyboard, or mouse are connected. Using the appropriate settings either via GUI or CLI these settings get automatically applied on first boot.
HISTORY
rpi-imager was developed by the Raspberry Pi Foundation to provide a more user-friendly alternative to traditional image writing methods. It has evolved to include support for various operating systems and advanced configuration options. Initially it was GUI only and later it was extended to a command line tool.