# Development ## Host requirements Ubuntu/Debian host names (the development machine is Ubuntu 26.04): ```sh sudo apt install qemu-system-x86 qemu-utils ovmf-generic seabios ipxe-qemu \ xorriso mtools dosfstools squashfs-tools cpio zstd python3-pexpect # Rust quality gates (names may be versioned; check `apt search rustfmt`) sudo apt install rust-clippy rustfmt # or, if cargo is rustup-managed: # rustup component add rustfmt clippy ``` Optional: `expect`, `cryptsetup`, `btrfs-progs`, `parted`, `kpartx` for offline inspection of VM images. `7z`/`p7zip` is useful for reading the reference ISO. ## Reference media The Gentoo LiveGUI ISO is a **reference artifact**, not source. It is ignored by `.gitignore`. Keep it outside git; point the VM harness at it by path. ## Rust installer The Bash prototype has been retired (see `docs/BASH-MIGRATION.md`); the Rust workspace is the only installer. ```sh cd installer-rs cargo fmt --all -- --check cargo clippy --workspace --all-targets cargo test --workspace cargo build --release -p phoebus-installer # Static binary for the live environment: RUSTFLAGS="-C target-feature=+crt-static" \ cargo build --release -p phoebus-installer --target x86_64-unknown-linux-gnu ``` Useful CLI invocations: ```sh target/release/phoebus-installer --config FILE --plan target/release/phoebus-installer --config FILE --dry-run --install target/release/phoebus-installer --config FILE --install --yes \ --luks-passphrase-file /secure/luks.pw --user-password-file /secure/user.pw ``` ## Disposable VM testing Never point the harness at a physical disk. The target is always a qcow2 file. `installer/tests/vm/serial-driver.py` drives QEMU over the serial console: ```sh cd /path/to/serve cp /path/to/phoebus_os/installer-rs/target/x86_64-unknown-linux-gnu/release/phoebus-installer . cp /path/to/phoebus_os/installer/tests/vm/install.sh . python3 -m http.server 8000 --bind 127.0.0.1 QEMU_BIN=qemu-system-x86_64 \ OVMF_CODE=/usr/share/OVMF/OVMF_CODE_4M.fd \ OVMF_VARS=/usr/share/OVMF/OVMF_VARS_4M.fd \ DISK=/tmp/phoebus/target.qcow2 \ ISO=/path/to/livegui-*.iso \ KERNEL=/tmp/live/boot/gentoo INITRD=/tmp/live/boot/gentoo.igz \ INSTALL_URL=http://10.0.2.2:8000/install.sh \ python3 installer/tests/vm/serial-driver.py install # Then boot the disk alone (ISO detached): DISK=/tmp/phoebus/target.qcow2 OVMF_CODE=... OVMF_VARS=... \ python3 installer/tests/vm/serial-driver.py boot ``` `installer/tests/vm/run-vm.sh` launches an interactive VM instead. ### Verifying the graphical stack The serial-only VM has no logind seat, so wlroots' DRM backend cannot start there. For headless verification use: ```sh export WLR_BACKENDS=headless WLR_RENDERER=pixman WLR_RENDERER_ALLOW_SOFTWARE=1 dwl & # creates wayland-0 grim /tmp/shot.png # proves the compositor renders ``` On a real machine the installer writes `/usr/local/bin/phoebus-session` (waybar + mako + swaybg + dwl). ## Inspecting the reference ISO without booting ```sh 7z l livegui-*.iso 7z x livegui-*.iso image.squashfs boot/gentoo boot/gentoo.igz unsquashfs -l image.squashfs # file listing unsquashfs -d /tmp/root image.squashfs etc/portage/make.conf ``` ## Make targets `make help` lists the common tasks. `make context` prints a session briefing (state, roadmap next steps, handoff), `make doctor` checks the host prerequisites, and `make test`, `make check`, `make build`, `make static`, `make hooks`, `make commit MSG="..."`, `make publish`, `make backup`, `make forgejo-init`, `make public` and `make release TAG=...` wrap the rest. ## Continuous integration `.forgejo/workflows/ci.yml` mirrors the local gates (`cargo fmt`, `cargo clippy`, `cargo test`). It runs only once a Forgejo Actions runner is registered for the repository; see Forgejo's documentation for `act_runner`. Until then, run `make test` before pushing. ## Backups The only remotes are self-hosted, so keep off-box copies: ```sh make backup # writes ~/backups/phoebus/phoebus-.bundle ``` Restore with `git clone /path/to/phoebus-.bundle phoebus_os`. ## Quality gates before commit 1. `make test` (`cd installer-rs && cargo test --workspace`) 2. `cargo fmt --all -- --check` and `cargo clippy --workspace --all-targets` 3. Update `docs/CHANGELOG.md` and `docs/STATUS.md` when behavior changes. 4. Commit (see `docs/GIT-WORKFLOW.md`).