devshell: add ghaf-flash to devshell, improve readability#1613
Merged
brianmcgillion merged 1 commit intotiiuae:mainfrom Dec 3, 2025
Merged
devshell: add ghaf-flash to devshell, improve readability#1613brianmcgillion merged 1 commit intotiiuae:mainfrom
brianmcgillion merged 1 commit intotiiuae:mainfrom
Conversation
brianmcgillion
approved these changes
Dec 3, 2025
Collaborator
brianmcgillion
left a comment
There was a problem hiding this comment.
fairly big wrapper for
zstdcat result/disk1.raw.zst | sudo dd of=/dev/sda bs=32M status=progress conv=sync oflag=direct iflag=fullblock
:) :)
Collaborator
Author
Haha indeed |
adef30e to
abe80ec
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a user-friendly ghaf-flash command to the development shell and significantly improves the flash script's usability with colored output, progress indicators, and better error messaging.
Key Changes:
- Adds
ghaf-flashcommand alias to devshell for easier access to the flash script - Enhances flash.sh with colored output, progress bars (using
pv), and interactive confirmation - Fixes typo in package description ("Flashingscript" → "Flashing script")
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 13 comments.
| File | Description |
|---|---|
packages/pkgs-by-name/flash-script/package.nix |
Adds pv dependency for progress display and fixes description typo |
packages/pkgs-by-name/flash-script/flash.sh |
Major UX improvements: adds colored output, progress bars, better help text, force flag, and user confirmation prompts |
nix/devshell.nix |
Adds ghaf-flash command to devshell builder category for convenient access |
Comments suppressed due to low confidence (1)
packages/pkgs-by-name/flash-script/flash.sh:181
- Using
evalwith user-controlled variable$FILENAMEembedded inPV_CMDcan lead to command injection vulnerabilities. While the filename is validated earlier, it's safer to avoidevalaltogether. Instead, construct the command directly:
if [[ -n $IMGSIZE ]]; then
zstdcat "$FILENAME" | pv -tpreb -N "$FILENAME" -s "$IMGSIZE" | dd of="$DEVICE" bs=32M conv=fsync oflag=direct iflag=fullblock status=none
else
zstdcat "$FILENAME" | pv -tpreb -N "$FILENAME" | dd of="$DEVICE" bs=32M conv=fsync oflag=direct iflag=fullblock status=none
fi PV_CMD="pv -tpreb -N \"$FILENAME\""
if [[ -n $IMGSIZE ]]; then
PV_CMD="$PV_CMD -s $IMGSIZE"
fi
set +e
zstdcat "$FILENAME" | eval "$PV_CMD" | dd of="$DEVICE" bs=32M conv=fsync oflag=direct iflag=fullblock status=none
abe80ec to
d4598f0
Compare
Signed-off-by: Kajus Naujokaitis <kajus.naujokaitis@unikie.com>
d4598f0 to
b9bc3ce
Compare
Collaborator
Author
|
Adjusted some parts based on copilot notes. Ready for review. |
brianmcgillion
approved these changes
Dec 3, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Changes
Added
flash-scriptasghaf-flashto ghaf devshell.Some improvements:
pvis available)-fflagType of Change
Related Issues / Tickets
Checklist
make-checksand it passesTesting Instructions
Applicable Targets
aarch64aarch64x86_64x86_64x86_64Installation Method
nixos-rebuild ... switchTest Steps To Verify: