Skip to content

Latest commit

 

History

History

README.md

scripts directory

This folder contains host-side helper script entrypoints organized by category. They do not run inside UEFI; they prepare your system or ESP from Linux.

The repository is now organized around component directories under components/. The directories under scripts/ are compatibility symlinks so existing commands such as bash scripts/testing/qemu-test.sh keep working while the real script sources live with their owning component.

Directory Structure

The compatibility entrypoints are organized into the following categories:

Scripts for building PhoenixBoot artifacts and images.

Scripts for testing PhoenixBoot functionality using QEMU and other methods.

Scripts for managing Machine Owner Keys (MOK) and kernel module signing.

Scripts for creating and managing EFI System Partition (ESP) images.

Scripts for managing SecureBoot keys and enrollment.

Scripts for validating system security and detecting threats.

Scripts for system recovery and remediation.

Scripts for creating and managing bootable USB media.

Scripts for running QEMU virtual machines.

Scripts for UEFI operations and diagnostics.

Scripts for project maintenance and development.

Usage

Most scripts require root privileges when writing to the ESP. Scripts are typically accessed through the task runner (./pf.py <task>) rather than directly.

Example:

# Via task runner (recommended)
./pf.py test-qemu
./pf.py secure-keygen
./pf.py build-package-esp

# Direct execution
sudo ./scripts/secure-boot/generate-sb-keys.sh
bash ./scripts/testing/qemu-test.sh

Actual script sources now live in:

  • components/core/scripts/
  • components/secure/scripts/
  • components/workflows/scripts/
  • components/maint/scripts/

See individual category README files for detailed information about each script.