PMBOOTSTRAP(1)

💖 PMBOOTSTRAP(1) 💖

okay bestie, welcome to the pmbootstrap manual page, straight out of the General Commands Manual ✨ this is the whole thing, no skips, no cuts, we're going the full distance 🫶

---

🌸 NAME 🌸

pmbootstrap — Develop and install postmarketOS 👑

---

✨ SYNOPSIS ✨

pmbootstrap [options] action

---

🦋 DESCRIPTION 🦋

so like, pmbootstrap is the central tool used in the development and installation of postmarketOS. it's giving main character energy fr fr, it does the whole thing 💅

---

🎀 OPTIONS 🎀

• -h, --help — show the built-in help message and dip out. exit, done, bye 💖
• -V, --version — show pmbootstrap's version number and exit.
• -c, --config config — tell it where your pmbootstrap.cfg file lives; by default it's ~/.config.
• --config-channels channels — point it at the path of channels.cfg. by default this gets read from the master branch of pmaports.git, iconic ✨
• -mp, --mirror-pmOS URL — pick which postmarketOS mirror to use. you can turn it off with -mp=''. and yeah you can stack multiple mirrors with -mp='one' -mp='two'. the default value is http://mirror.postmarketos.org/postmarketos.
• -m, --mirror-alpine URL — pick which Alpine Linux mirror to use. default value is http://dl-cdn.alpinelinux.org/alpine.
• -j, --jobs jobs — set how many parallel jobs to use when compiling. multitasking queen 💅
• -E, --extra-space space — give it an integer, the amount of additional space to allocate to the image, measured in MB (default 0).
• -B, --boot-size size — set the boot partition size on the target machine, in MB (default 128).
• -p, --aports aports — specify the path to postmarketOS aports (pmaports).
• -t, --timeout time — set the number of seconds before hung processes get killed (default 900).
• -w, --work work — specify the folder where all the data gets stored (chroots, caches, built packages, etc). it's the stash spot 🎀
• -y, --assume-yes — assume 'yes' to all question prompts. no more typing, just vibes.
• --as-root — allow running as root. not recommended, because it may screw up the work folder's directory permissions. like, genuinely don't 🙈
• -o, --offline — do not attempt to update the package index files.
• --no-ccache — do not cache the compiled output.
• --no-cross — disable cross compiler; build only with QEMU and gcc.
• -l, --log log — specify the path to the log file.
• --details-to-stdout — print details (e.g. build output) to stdout instead of writing them to the log.
• -v, --verbose — write even more information to the log files. the way that it just keeps going 😭
• -q, --quiet — do not output any log messages. shhh 🤫

---

🔥 ACTIONS 🔥

1. init — initialize the config file.
2. shutdown — shut down active chroots (unmount them and unregister QEMU binfmt).
3. index — re-index all repositories with custom-built packages.
4. work_migrate — migrate the work folder version.
5. kconfig — change or edit kernel configs.
6. export — create convenience symlinks to generated image files (system, kernel, initramfs, boot.img, etc).
7. sideload — push packages to a running phone connected over USB or WiFi.
8. netboot — launch an nbd server with the postmarketOS rootfs.
9. flasher — flash something to the target device.
10. initramfs — do something with the initramfs.
11. pkgrel_bump — increase the pkgrel to indicate that a package must be rebuilt because of a dependency change.
12. aportupgrade — check for outdated packages that need upgrading.
13. newapkbuild — get a template to package new software.
14. lint — run quality checks on pmaports (required to pass CI). no cap, CI will not let you through without it 💀
15. status — get a quick health check for the work dir. vibe check for your work folder fr fr.
16. log — follow the pmbootstrap log file.
17. zap — safely delete chroot folders.
18. stats — show ccache stats.
19. update — update all existing APKINDEX files.
20. build_init — initialize the build environment.
21. chroot — start a shell in a chroot.
22. install — set up a device specific chroot and install to an SD card or image file.
23. checksum — update aport checksums.
24. aportgen — generate a postmarketOS-specific package build recipe (aport/APKBUILD).
25. build — build a package for a specific architecture.
26. config — get and set pmbootstrap options.
27. bootimg_analyze — extract all the information from an existing boot.img.
28. pull — update all git repositories that pmbootstrap cloned.
29. ci — run continuous integration scripts locally of git repo in current directory.

---

and that's the whole page, bestie, you ate it 💅🌸 this little number comes to you courtesy of the General Commands Manual and it's filed under PMBOOTSTRAP(1) — periodt ✨💖🦋