3.5. Basic Image Builder command-line commands
The Image Builder command-line interface offers the following sub-commands.
Blueprint manipulation
- List all available blueprints
composer-cli blueprints list
# composer-cli blueprints list
Copy to Clipboard Copied! - Show a blueprint contents in the TOML format
composer-cli blueprints show BLUEPRINT-NAME
# composer-cli blueprints show BLUEPRINT-NAME
Copy to Clipboard Copied! - Save (export) blueprint contents in the TOML format into a file BLUEPRINT-NAME.toml
composer-cli blueprints save BLUEPRINT-NAME
# composer-cli blueprints save BLUEPRINT-NAME
Copy to Clipboard Copied! - Remove a blueprint
composer-cli blueprints delete BLUEPRINT-NAME
# composer-cli blueprints delete BLUEPRINT-NAME
Copy to Clipboard Copied! - Push (import) a blueprint file in the TOML format into Image Builder
composer-cli blueprints push BLUEPRINT-NAME
# composer-cli blueprints push BLUEPRINT-NAME
Copy to Clipboard Copied!
Composing images from blueprints
- Start a compose
composer-cli compose start BLUEPRINT COMPOSE-TYPE
# composer-cli compose start BLUEPRINT COMPOSE-TYPE
Copy to Clipboard Copied! Replace BLUEPRINT with name of the blueprint to build and COMPOSE-TYPE with the output image type.- List all composes
composer-cli compose list
# composer-cli compose list
Copy to Clipboard Copied! - Cancel a running compose
composer-cli compose cancel COMPOSE-UUID
# composer-cli compose cancel COMPOSE-UUID
Copy to Clipboard Copied! - Delete a finished compose
composer-cli compose delete COMPOSE-UUID
# composer-cli compose delete COMPOSE-UUID
Copy to Clipboard Copied! - Show detailed information about a compose
composer-cli compose info COMPOSE-UUID
# composer-cli compose info COMPOSE-UUID
Copy to Clipboard Copied! - Download image file of a compose
composer-cli compose image COMPOSE-UUID
# composer-cli compose image COMPOSE-UUID
Copy to Clipboard Copied!
Related information
- The
composer-cli(1)
manual page provides a full list of the available sub-commands and options:man composer-cli
$ man composer-cli
Copy to Clipboard Copied! - The
composer-cli
tool provides help on the sub-commands and options:composer-cli compose list
# composer-cli compose list
Copy to Clipboard Copied!