KIWI::RESULT::BUNDLE(8)

✨ NAME ✨

okay so bestie, welcome to the kiwi::result::bundle page β€” it's the KIWI NG manual, section 8, and it's literally all about bundling up your build results πŸŽ€

kiwi::result::bundle β€” Bundle build results πŸ’…


🌸 SYNOPSIS 🌸

kiwi-ng [global options] service <command> [<args>]

kiwi-ng result bundle --help
kiwi-ng result bundle --target-dir=<directory> --id=<bundle_id> --bundle-dir=<directory>
    [--bundle-format=<format>]
    [--zsync-source=<download_location>]
    [--package-as-rpm]
    [--no-compress]

No cap, that's the whole shape of it β€” global options first, then the service subcommand, then its args πŸ¦‹


πŸ‘‘ DESCRIPTION πŸ‘‘

So here's the vibe: this command creates a result bundle from the image build that's sitting in the target directory you specify. Super chill, super useful ✨

Every resulting image has the bundle identifier you gave it baked right into its filename β€” like a lil name tag so you know exactly which bundle it came from πŸŽ€

Uncompressed image files also get compressed as an XZ archive, and an SHA checksum is generated for each resulting image, so you can verify everything later. Obsessed with the thoroughness tbh πŸ”₯


πŸ’– OPTIONS πŸ’–

  • --bundle-dir=<directory> β€” the directory that holds the bundle results, the compressed versions of the image results, and the SHA checksum files. Basically the bundle's whole little home 🏠
  • --bundle-format=<format> β€” tells it which bundle format to create. If you pass this, it overwrites any bundle_format attribute that might've come along from the main image description. (iykyk, precedence matters 😌) The format string can contain placeholders for these elements:
    • %N : Image name
    • %P : Concatenated profile name (_)
    • %A : Architecture name
    • %I : Bundle ID
    • %T : Image build type name
    • %M : Image Major version number
    • %m : Image Minor version number
    • %p : Image Patch version number
    • %v : Image Version string

ngl that placeholder list is lowkey iconic β€” mix and match however you want πŸ’…

  • --id=<bundle_id> β€” the Bundle ID 🏷️ it's a free-form text that gets appended to the image version information as part of the resulting image filename. So whatever you type here ends up living in the filename, periodt.
  • --target-dir=<directory> β€” the directory containing the KIWI NG build results. This is where it goes looking for your stuff πŸ‘€
  • --zsync-source=<download_location> β€” the download location of the bundle file or files. Only relevant if zsync is used to sync the bundle πŸŒ€ and there are two things to know:
    • The zsync control file is created for the bundle files marked for compression.
    • All files in a bundle must be stored in the same download location. Like, they all gotta be in the same place, no scattering fr fr.
  • --package-as-rpm β€” creates an RPM package containing the result files πŸ“¦ ate and left no crumbs.
  • --no-compress β€” don't compress the result image file(s) πŸ™…β€β™€οΈ but heads up: image files that were already produced as compressed variants stay compressed β€” this flag won't un-compress anything that's already squished.

🌈 tiny reminder bestie: --bundle-format overrides the image description's bundle_format, and zsync only cares about files flagged for compression. Don't let those two sneak up on you πŸ’€

🫢 AUTHOR 🫢

Marcus SchΓ€fer β€” the icon behind all this 🌟


2020-2026, Marcus SchΓ€fer β€” protect the legacy πŸ‘‘


and that's the whole page, bestie! 🧚 this lovely lil manual is version 11.1.1, dated Oct 06, 2026, and it's the KIWI NG KIWI::RESULT::BUNDLE(8) page β€” go forth and bundle responsibly πŸ“πŸ’–

πŸ“¦ where this page comes from