From ea1a42773a9a41be474a43e6fe0369dc1addf074 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Tue, 8 Apr 2025 09:45:44 +0200 Subject: [PATCH] doc: document `manifest` Signed-off-by: Simon de Vlieger --- doc/01-usage.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/01-usage.md b/doc/01-usage.md index ddd867f..303d8e1 100644 --- a/doc/01-usage.md +++ b/doc/01-usage.md @@ -193,6 +193,29 @@ $ image-builder describe --arch aarch64 minimal-raw # ... output ... ``` +## `image-builder manifest` + +The `manifest` command outputs an [osbuild](https://github.com/osbuild/osbuild) manifest for an image. This manifest contains all the steps performed to assemble the eventual image but the image itself is not created. + +```console +$ image-builder manifest minimal-raw +# ... json ... +``` + +By default the `manifest` command uses the same distribution and version as the host system, you can pass another distribution and version with the `--distro` argument: + +```console +$ image-builder manifest --distro fedora-43 minimal-raw +# ... json ... +``` + +When passed `--arch` `image-builder` will show the manifest for that architecture: + +```console +$ image-builder manifest --arch aarch64 minimal-raw +# ... output ... +``` + # Blueprints Images can be customized with [blueprints](https://osbuild.org/docs/user-guide/blueprint-reference). For example we could build the `qcow2` we built above with some customizations applied.