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
Copy to Clipboard
Show a blueprint contents in the TOML format
# composer-cli blueprints show BLUEPRINT-NAME
Copy to Clipboard
Save (export) blueprint contents in the TOML format into a file BLUEPRINT-NAME.toml
# composer-cli blueprints save BLUEPRINT-NAME
Copy to Clipboard
Remove a blueprint
# composer-cli blueprints delete BLUEPRINT-NAME
Copy to Clipboard
Push (import) a blueprint file in the TOML format into Image Builder
# composer-cli blueprints push BLUEPRINT-NAME
Copy to Clipboard

Composing images from blueprints

Start a compose
# composer-cli compose start BLUEPRINT COMPOSE-TYPE
Copy to Clipboard
Replace BLUEPRINT with name of the blueprint to build and COMPOSE-TYPE with the output image type.
List all composes
# composer-cli compose list
Copy to Clipboard
Cancel a running compose
# composer-cli compose cancel COMPOSE-UUID
Copy to Clipboard
Delete a finished compose
# composer-cli compose delete COMPOSE-UUID
Copy to Clipboard
Show detailed information about a compose
# composer-cli compose info COMPOSE-UUID
Copy to Clipboard
Download image file of a compose
# composer-cli compose image COMPOSE-UUID
Copy to Clipboard

Related information

  • The composer-cli(1) manual page provides a full list of the available sub-commands and options:
    $ man composer-cli
    Copy to Clipboard
  • The composer-cli tool provides help on the sub-commands and options:
    # composer-cli compose list
    Copy to Clipboard
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat