https://github.com/ikluft/piflash

Write ("flash") a Raspberry Pi boot image to an SD card, with features for power users (auto-unwrap archive files) or newbies (safety checks to avoid erasing wrong device)
https://github.com/ikluft/piflash

linux perl perl5 raspberry-pi sd-card

Last synced: 26 days ago
JSON representation

Write ("flash") a Raspberry Pi boot image to an SD card, with features for power users (auto-unwrap archive files) or newbies (safety checks to avoid erasing wrong device)

• Host: GitHub
• URL: https://github.com/ikluft/piflash
• Owner: ikluft
• License: apache-2.0
• Created: 2018-10-07T02:20:20.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-13T07:53:07.000Z (almost 2 years ago)
• Last Synced: 2024-09-29T18:42:03.005Z (about 1 month ago)
• Topics: linux, perl, perl5, raspberry-pi, sd-card
• Language: Perl
• Homepage:
• Size: 481 KB
• Stars: 10
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Name

*piflash* - Raspberry Pi SD-flashing script with safety checks to avoid erasing the wrong device

# Synopsis

    piflash [--verbose] [--resize] [--config conf-file] input-file output-device

    piflash [--verbose] --sdsearch

    piflash --version

# Featured article





"Getting started with PiFlash: Booting your Raspberry Pi on Linux"






by Ian Kluft at OpenSource.com




March 15, 2019




# Description

PiFlash writes (or "flashes") an SD card for a Raspberry Pi. It includes safety checks so that it can only erase and write to an SD card, not another device on the system. The safety checks are probably of most use to beginners. For more advanced users (like the author) it also has the convenience of flashing directly from the file formats downloadable from raspberrypi.org without extracting a .img file from a zip/gz/xz file.

## User documentation

* [PiFlash program usage and installation](https://metacpan.org/pod/distribution/PiFlash/bin/piflash)

* [Online resources for PiFlash](https://metacpan.org/pod/distribution/PiFlash/doc/resources.pod)

  * [Where to download Raspberry Pi bootable images](https://metacpan.org/pod/distribution/PiFlash/doc/resources.pod#Where-to-download-Raspberry-Pi-bootable-images)

  * [Presentations and Articles](https://metacpan.org/pod/distribution/PiFlash/doc/resources.pod#Presentations-and-Articles)

* [PiFlash release on CPAN](https://metacpan.org/release/PiFlash)

* [PiFlash source code on GitHub](https://github.com/ikluft/piflash)

PiFlash documentation is available as Unix man-pages and as Perl POD (Plain Old Documentation).

Once installed, you can run `man` or `perldoc` from a shell to read the documentation:

    % man piflash

or

 

    % perldoc piflash

 

## Developer documentation

* [PiFlash](https://metacpan.org/pod/PiFlash) - Raspberry Pi SD-flashing script with safety checks to avoid erasing the wrong device

* [PiFlash::Command](https://metacpan.org/pod/PiFlash::Command) - process/command running utilities for piflash

* [PiFlash::Hook](https://metacpan.org/pod/PiFlash::Hook) - named dispatch/hook library for PiFlash

* [PiFlash::Inspector](https://metacpan.org/pod/PiFlash::Inspector) - PiFlash functions to inspect Linux system devices to flash an SD card for Raspberry Pi

* [PiFlash::MediaWriter](https://metacpan.org/pod/PiFlash::MediaWriter) - write to Raspberry Pi SD card installation with scriptable customization

* [PiFlash::Object](https://metacpan.org/pod/PiFlash::Object) - object functions for PiFlash classes

* [PiFlash::Plugin](https://metacpan.org/pod/PiFlash::Plugin) - plugin extension interface for PiFlash

* [PiFlash::State](https://metacpan.org/pod/PiFlash::State) - PiFlash::State class to store configuration, device info and program state

## Participation in PiFlash

See the [Contributing to PiFlash](CONTRIBUTING.md) docs.

* [Code of Conduct](CONTRIBUTING.md#code-of-conduct)

* [Submitting an issue](CONTRIBUTING.md#submitting-an-issue)

* [Submitting a Pull Request](CONTRIBUTING.md#submitting-a-pull-request)

When reporting a bug, please include the full output using the --verbose option. That will include all of the

program's state information, which will help understand the bigger picture what was happening on your system.

Feel free to remove information you don't want to post in a publicly-visible bug report - though it's helpful

to add "[redacted]" where you removed something so it's clear what happened.

For any SD card reader hardware which piflash fails to recognize (and therefore refuses to write to),

please describe the hardware as best you can including name, product number, bus (USB, PCI, etc),

any known controller chips.