Update cli (tinkerbell#9)

## Description


All cli flags can be defined as env vars. Flags translate to envs by becoming dropping the initial `--`, words become all caps, and dashes become underscores.

For example, `--mkosi-mode` -> `MKOSI_MODE`

Also, updated the help menu presentation. Organized by global and subcommand specific flags.

Fixes: #

## How Has This Been Tested?





## How are existing users impacted? What migration steps/scripts do we need?





## Checklist:

I have:

- [ ] updated the documentation and/or roadmap (if required)
- [ ] added unit or e2e tests
- [ ] provided instructions on how to upgrade

Author: mergify[bot]

.github/workflows/ci.yml

@@ -62,6 +62,9 @@ jobs:
             mkosi.output/vmlinuz/${{ matrix.arch }}
           key: kernel-${{ matrix.arch }}-${{ env.KERNEL_VERSION }}-${{ hashFiles('config/defconfig.*', 'Dockerfile') }}
 
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+
       - name: Build kernel
         run: ./build.py kernel
 
@@ -112,6 +115,9 @@ jobs:
             mkosi.output/extra-tree/${{ matrix.arch }}/opt/cni
           key: tools-${{ matrix.arch }}-${{ hashFiles('captain/tools.py') }}
 
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+
       - name: Download tools
         run: ./build.py tools
 
@@ -174,6 +180,9 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y bubblewrap
 
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+
       - name: Build initramfs
         run: ./build.py initramfs
 
@@ -238,6 +247,9 @@ jobs:
           mkdir -p mkosi.output/initramfs/${{ matrix.arch }}
           cp out/initramfs-${{ matrix.arch }}.cpio.zst mkosi.output/initramfs/${{ matrix.arch }}/image.cpio.zst
 
+      - name: Install Python dependencies
+        run: pip install -r requirements.txt
+
       - name: Build ISO
         run: ./build.py iso
 

Dockerfile

@@ -63,6 +63,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
 
 # Install mkosi from GitHub (not on PyPI)
 RUN pip3 install --break-system-packages \
+    configargparse \
     "git+https://github.com/systemd/mkosi.git@${MKOSI_VERSION}"
 
 # Verify mkosi is functional

README.md

@@ -122,9 +122,6 @@ CaptainOS reads provisioning configuration from the kernel command line:
 ├── config/
 │   ├── defconfig.amd64         # Kernel config for x86_64
 │   └── defconfig.arm64         # Kernel config for aarch64
-├── scripts/
-│   ├── build-kernel.py         # In-container kernel build entry point
-│   └── download-tools.py       # In-container tool download entry point
 └── mkosi.extra/                # Files overlaid into the image
     ├── init                    # Custom PID 1 (rootfs → tmpfs → systemd)
     └── etc/

build.py

@@ -1,44 +1,6 @@
 #!/usr/bin/env python3
 """CaptainOS build system entry point.
 
-Usage:
-    ./build.py              # Build the image (stages: kernel → tools → initramfs)
-    ./build.py build        # Same as above
-    ./build.py kernel       # Build only the kernel + modules
-    ./build.py tools        # Download tools (containerd, runc, nerdctl, CNI)
-    ./build.py initramfs    # Build only the initramfs via mkosi
-    ./build.py shell        # Drop into an interactive shell inside the builder
-    ./build.py clean        # Remove build artifacts
-    ./build.py summary      # Print mkosi configuration summary
-    ./build.py qemu-test    # Boot the built image in QEMU for testing
-
-Environment variables:
-    ARCH            Target architecture: amd64 (default) or arm64
-    KERNEL_MODE     Kernel build mode: docker (default), native, or skip
-    MKOSI_MODE      mkosi build mode: docker (default), native, or skip
-    KERNEL_SRC      Path to a local kernel source tree (optional, avoids download)
-    KERNEL_VERSION  Kernel version to build (default: 6.12.69)
-    NO_CACHE        Set to 1 to force Docker image rebuild without cache
-    BUILDER_IMAGE   Override the builder Docker image name (default: captainos-builder)
-    FORCE_KERNEL    Set to 1 to force kernel rebuild
-    FORCE_TOOLS     Set to 1 to re-download tools
-    QEMU_APPEND     Extra kernel cmdline args for qemu-test
-    QEMU_MEM        QEMU RAM size (default: 2G)
-    QEMU_SMP        QEMU CPU count (default: 2)
-
-Tinkerbell kernel cmdline (qemu-test only, passed via /proc/cmdline):
-    TINK_GRPC_AUTHORITY       tink-server gRPC endpoint (host:port)
-    TINK_DOCKER_REGISTRY      Registry host (triggers tink-agent services)
-    TINK_WORKER_IMAGE         Full image ref (overrides TINK_DOCKER_REGISTRY)
-    TINK_WORKER_ID            Machine / worker ID (auto-detected when empty)
-    TINK_TLS                  Enable TLS to tink-server (default: false)
-    TINK_INSECURE_TLS         Allow insecure TLS (default: true)
-    TINK_INSECURE_REGISTRIES  Comma-separated insecure registries
-    TINK_REGISTRY_USERNAME    Registry auth username
-    TINK_REGISTRY_PASSWORD    Registry auth password
-    TINK_SYSLOG_HOST          Remote syslog host
-    TINK_FACILITY             Facility code
-
 Requires: Python >= 3.10, Docker (unless all stages use native or skip)
 """
 
@@ -48,7 +10,12 @@
     print("ERROR: Python >= 3.10 is required.", file=sys.stderr)
     sys.exit(1)
 
-from captain.cli import main
+try:
+    from captain.cli import main
+except ImportError as exc:
+    print(f"ERROR: {exc}", file=sys.stderr)
+    print("Install dependencies:  pip install -r requirements.txt", file=sys.stderr)
+    sys.exit(1)
 
 if __name__ == "__main__":
     main()

captain/artifacts.py

@@ -32,7 +32,7 @@ def _human_size(size: int) -> str:
 
 
 def collect_kernel(cfg: Config, logger: StageLogger | None = None) -> None:
-    """Copy just the kernel image from mkosi.output/vmlinuz/{arch}/ to out/."""
+    """Copy the kernel image from mkosi.output/vmlinuz/{arch}/ to out/."""
     _log = logger or _default_log
     out = ensure_dir(cfg.output_dir)
     vmlinuz_dir = cfg.vmlinuz_output
@@ -46,13 +46,10 @@ def collect_kernel(cfg: Config, logger: StageLogger | None = None) -> None:
         _log.warn("No kernel image found in mkosi.output/vmlinuz/{arch}/")
 
 
-def collect(cfg: Config, logger: StageLogger | None = None) -> None:
-    """Copy initramfs and kernel images from mkosi.output/ to out/."""
+def collect_initramfs(cfg: Config, logger: StageLogger | None = None) -> None:
+    """Copy the initramfs CPIO from mkosi.output/initramfs/{arch}/ to out/."""
     _log = logger or _default_log
-    _log.log("Collecting build artifacts...")
     out = ensure_dir(cfg.output_dir)
-
-    # Find the initrd CPIO output
     cpio_files = sorted(cfg.initramfs_output.glob("*.cpio*"))
     if cpio_files:
         initrd_src = cpio_files[0]
@@ -62,19 +59,11 @@ def collect(cfg: Config, logger: StageLogger | None = None) -> None:
     else:
         _log.warn("No initramfs CPIO found in mkosi.output/initramfs/{arch}/")
 
-    # Find the kernel image (stored outside ExtraTrees so it doesn't bloat
-    # the initramfs — iPXE loads the kernel separately).
-    vmlinuz_dir = cfg.vmlinuz_output
-    vmlinuz_files = sorted(vmlinuz_dir.glob("vmlinuz-*")) if vmlinuz_dir.is_dir() else []
-    if vmlinuz_files:
-        vmlinuz_src = vmlinuz_files[0]
-        vmlinuz_dst = out / f"vmlinuz-{cfg.arch}"
-        shutil.copy2(vmlinuz_src, vmlinuz_dst)
-        _log.log(f"kernel: {vmlinuz_dst} ({_human_size(vmlinuz_dst.stat().st_size)})")
-    else:
-        _log.warn("No kernel image found in mkosi.output/vmlinuz/{arch}/")
 
-    # Collect ISO if present (may not exist when ISO_MODE=skip)
+def collect_iso(cfg: Config, logger: StageLogger | None = None) -> None:
+    """Copy the ISO image from mkosi.output/iso/{arch}/ to out/."""
+    _log = logger or _default_log
+    out = ensure_dir(cfg.output_dir)
     iso_dir = cfg.iso_output
     iso_files = sorted(iso_dir.glob("*.iso")) if iso_dir.is_dir() else []
     if iso_files:
@@ -83,11 +72,26 @@ def collect(cfg: Config, logger: StageLogger | None = None) -> None:
         shutil.copy2(iso_src, iso_dst)
         _log.log(f"iso: {iso_dst} ({_human_size(iso_dst.stat().st_size)})")
 
-    # Print checksums
-    artifacts = sorted(out.iterdir())
-    if artifacts:
+
+def collect_checksums(cfg: Config, logger: StageLogger | None = None) -> None:
+    """Print SHA-256 checksums for all artifacts in out/."""
+    _log = logger or _default_log
+    out = cfg.output_dir
+    if not out.is_dir():
+        return
+    artifact_files = sorted(f for f in out.iterdir() if f.is_file())
+    if artifact_files:
         _log.log("Checksums:")
-        for artifact in artifacts:
-            if artifact.is_file():
-                digest = _sha256(artifact)
-                print(f"  {digest}  {artifact}")
+        for artifact in artifact_files:
+            digest = _sha256(artifact)
+            print(f"  {digest}  {artifact}")
+
+
+def collect(cfg: Config, logger: StageLogger | None = None) -> None:
+    """Copy initramfs, kernel, and ISO images from mkosi.output/ to out/."""
+    _log = logger or _default_log
+    _log.log("Collecting build artifacts...")
+    collect_initramfs(cfg, logger=_log)
+    collect_kernel(cfg, logger=_log)
+    collect_iso(cfg, logger=_log)
+    collect_checksums(cfg, logger=_log)