Shrinkwrap
2026.9.0.dev0
Overview
Introduction
Features
Architecture
Repository Structure
Repository License
Contributions and Bug Reports
Maintainer(s)
User Guide
Quickstart
Prerequisites
Recommended installation (pyenv)
Install pyenv
Install Python
Create a virtual environment
Install Shrinkwrap
Alternative installation (python venv)
Create a virtual environment
Install Shrinkwrap
Verify installation
Docker/Podman
If using Docker Runtime Backend
If using Podman Runtime Backend
Optional Environment Variables
Guided Tour: Configure a platform and boot a kernel
Troubleshooting
pip installs but
shrinkwrap
command not found
Wrong Python version
pip installs old versions
Editable install not picking up changes
PEP 668: Externally Managed Environment with pyenv
pyenv install: missing optional modules (_bz2, _ssl, readline, curses, ctypes)
Run-Times
Container Image Variants
Container Image Tags
Runtime Requirements
Build Container Image Locally
Commands
Config Model
Merging Configs
Merging Example
Macros
Defined Macros
Schema
Top-Level keys
build section
buildex section
component section
repo section
run section
terminal section
Config Store
bootwrapper.yaml
Description
Build-Time Variables
Run-Time Variables
Components
buildroot.yaml
Description
Build-Time Variables
Run-Time Variables
Components
cca-3world.yaml
Description
Build-Time Variables
Run-Time Variables
Components
cca-4world.yaml
Description
Build-Time Variables
Run-Time Variables
Components
cca-edk2.yaml
Description
Build-Time Variables
Run-Time Variables
Components
ffa-hafnium-optee.yaml
Description
Build-Time Variables
Run-Time Variables
Components
ffa-optee.yaml
Description
Build-Time Variables
Run-Time Variables
Components
ffa-tftf.yaml
Description
Build-Time Variables
Run-Time Variables
Components
ns-edk2-optee.yaml
Description
Build-Time Variables
Run-Time Variables
Components
ns-edk2.yaml
Description
Build-Time Variables
Run-Time Variables
Components
ns-preload.yaml
Description
Build-Time Variables
Run-Time Variables
Components
rfa.yaml
Description
Build-Time Variables
Run-Time Variables
Components
Shrinkwrap Recipes
Override Component Version and/or Location
Reuse Existing Local Repo for Component
Changing Between Arm Architecture Revisions
Explicitly Clean a Config or Component
Workaround for TF-A not Noticing Modified Build Params
Use a Custom FVP Version
Use an Alternative Device Tree
Accessing the FVP over Network when using Docker/Podman
Boot Linux with ACPI
Pass Overlay Directly on Command Line
Provide SSH keys
Developer Guide
Installation
Clone the repository
Install in editable mode (development)
Install documentation dependencies
Release Process
Release Contents
Manual PyPI Upload
Versioning Scheme
Bug Fix Releases
Release Checklist
Releases
2025.12.0
Links
Component Versions
Toolchains
FVP
Software Components
Git Shortlog
Test Report Summary
2026.3.0
Links
Component Versions
Toolchains
FVP
Software Components
Git Shortlog
Test Report Summary
2026.6.0
Links
Component Versions
Toolchains
FVP
Software Components
Git Shortlog
Test Report Summary
Unit Tests
System Tests
License
SPDX Identifiers
Shrinkwrap
»
User Guide
»
Config Store
View page source
Previous
Next
Config Store
Shrinkwrap ships with the following standard set of configs for use out-of-the-box:
bootwrapper.yaml
buildroot.yaml
cca-3world.yaml
cca-4world.yaml
cca-edk2.yaml
ffa-hafnium-optee.yaml
ffa-optee.yaml
ffa-tftf.yaml
ns-edk2-optee.yaml
ns-edk2.yaml
ns-preload.yaml
rfa.yaml