COMPOSER-CLI(1)

πŸ’– COMPOSER-CLI(1) πŸ’–

okay bestie, listen up, we're doing a whole manual page for composer-cli, and specifically for the compose-image subcommand, and honestly? it's giving "grab your image and go" energy. slay.


✨ NAME ✨

composer-cli-compose-image β€” get the compose image file πŸ’…

like. that's the whole thing. it gets you the image. iconic.


πŸ¦‹ SYNOPSIS πŸ¦‹

composer-cli compose image UUID [flags]

see that UUID? that's not optional, bestie, that's the main character of this whole operation. you gotta know which compose you're grabbing from. and then [flags] is where the little extras live. πŸŽ€


🌸 DESCRIPTION 🌸

get the compose image file. periodt.

that's genuinely it. you hand it a UUID, it hands you the image. lowkey the most satisfying little command in the whole suite. no cap.


πŸ‘‘ OPTIONS πŸ‘‘

  • --filename="" β€” optional path and filename where you want the image to be saved. if you don't say anything, it does its default thing. it's literally optional, so no pressure. ✨
  • -h, --help[=false] β€” help for image. the "wait what does this do again" button. defaults to false because obviously you don't need help by default, you're a genius. πŸ’…

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these aren't even this command's own flags, they're handed down from the parent like a family heirloom. still yours to use tho. 🫢

  • -a, --api=1 β€” WELDR Server API Version to use. defaults to 1. yeah, the classic.
  • --cloudsocket="/run/cloudapi/api.socket" β€” path to the cloudapi server's socket file. that's where the newer Cloud API lives. πŸ”₯
  • -j, --json[=false] β€” output the raw JSON response instead of the normal output. perfect for when you're piping things into other things and want the unfiltered truth. defaults to false.
  • --log="" β€” path to an optional logfile. optional!! if you want a receipt of what happened, here's your receipt. 🧾
  • -s, --socket="/run/weldr/api.socket" β€” path to the WELDR API server's socket file. the classic socket. the OG.
  • --test=0 β€” pass test mode to compose. 1 = mock compose with fail. 2 = mock compose with finished. defaults to 0, which is "no test mode, we're being for real." 🧚
  • --timeout=240 β€” timeout to use for server communication. set it to 0 for no timeout, which, bestie, is a choice. defaults to 240.
  • --weldr-only[=false] β€” only use the WELDR API; skip using the newer Cloud API. defaults to false, so by default it's like "sure, try the new one too." πŸ™ˆ

πŸ’œ EXAMPLE πŸ’œ

here's the vibe in practice, all three of these are real and you can just. do them:

composer-cli compose image 914bb03b-e4c8-4074-bc31-6869961ee2f3
composer-cli compose image 914bb03b-e4c8-4074-bc31-6869961ee2f3 --filename /var/tmp/
composer-cli compose image 914bb03b-e4c8-4074-bc31-6869961ee2f3 --filename /var/tmp/tmux-image.qcow2

first one: just grab it, wherever it wants to go. 🌸

second one: you gave it a directory (/var/tmp/) and let it figure out the filename itself.

third one: you were specific, you named the whole thing /var/tmp/tmux-image.qcow2, and honestly? main character energy. πŸ‘‘


πŸŽ€ SEE ALSO πŸŽ€


⭐ HISTORY ⭐

28-Apr-2026 β€” auto generated by spf13/cobra. not a human, just a very productive little Go library doing its thing. πŸ€–


and that's the whole page, bestie!! no notes, ate, left no crumbs. πŸ’–βœ¨

this was composer-cli, from Apr 2026. take care of her. 🫢🌸

byeeeeee πŸ’…

πŸ“¦ where this page comes from