COMPOSER-CLI(1)

💅 COMPOSER-CLI(1) — the composer-cli manual, but make it cute

okay bestie, sit down, hydrate, because we're diving into composer-cli-compose and honestly? it's giving management. 👑

---

✨ NAME ✨

composer-cli-compose — manage composes 🎀

---

🌸 SYNOPSIS 🌸

composer-cli compose ... [flags]

---

🦋 DESCRIPTION 🦋

So like, this is the vibe: you're managing composes on the server. That's the whole thing. That's the job. 💖

And here's the lil spicy detail — the start and start-ostree commands can optionally upload the results for you. no cap. And if you wanna see the full upload profile reference, it lives right here:

https://osbuild.org/docs/user-guide/uploading-cloud-images/

go look at it, it's iconic, iykyk. 🫶

---

👑 OPTIONS 👑

• -h, --help[=false] — help for compose. the classic. the goat. literally just tells you about compose. 💅

---

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these bad boys come down from the parent command, so they're not even yours, you're just borrowing them and honestly? they ate.

• -a, --api=1 — which WELDR Server API Version to use. defaults to 1. ⭐
• --cloudsocket="/run/cloudapi/api.socket" — the path to the cloudapi server's socket file. that's the default path, fr fr. 🔌
• -j, --json[=false] — output the raw JSON response instead of the normal output. for the girlies who like their data unprocessed. 💀
• --log="" — path to an optional logfile. optional! so chill. default is empty. 📝
• -s, --socket="/run/weldr/api.socket" — path to the WELDR API server's socket file. also has a default. 🧚
• --test=0 — pass test mode to compose. 1=Mock compose with fail. 2=Mock compose with finished. yes those are the exact values, don't @ me. 🙈
• --timeout=240 — timeout to use for server communication. set it to 0 for no timeout (main character energy tbh). ⏳
• --weldr-only[=false] — only use the WELDR API; skip using the newer Cloud API. old school, but valid. 💜

---

🍓 EXAMPLE 🍓

here's where it gets fun, bestie — TOML profiles. three of them. all for uploading, all gorgeous.

🌸 TOML profile for uploading to AWS

provider = "aws"

[settings]
accessKeyID = "AWS_ACCESS_KEY_ID"
secretAccessKey = "AWS_SECRET_ACCESS_KEY"
bucket = "AWS_BUCKET"
region = "AWS_REGION"
key = "OBJECT_KEY"

🌸 TOML profile for uploading to GCP

provider = "gcp"

[settings]
bucket = "GCP_BUCKET"
region = "GCP_STORAGE_REGION"
object = "OBJECT_KEY"
credentials = "GCP_CREDENTIALS"

🌸 TOML profile for uploading to Azure

provider = "azure"

[settings]
storageAccount = "your storage account name"
storageAccessKey = "storage access key you copied in the Azure portal"
container = "your storage container name"

ngl the Azure one really said "copy it from the portal yourself" and i respect the honesty. 💅

---

🔥 SEE ALSO 🔥

the whole friend group, periodt:

• composer-cli(1)
• composer-cli-compose-cancel(1)
• composer-cli-compose-delete(1)
• composer-cli-compose-image(1)
• composer-cli-compose-info(1)
• composer-cli-compose-list(1)
• composer-cli-compose-log(1)
• composer-cli-compose-logs(1)
• composer-cli-compose-metadata(1)
• composer-cli-compose-results(1)
• composer-cli-compose-start(1)
• composer-cli-compose-start-ostree(1)
• composer-cli-compose-status(1)
• composer-cli-compose-types(1)
• composer-cli-compose-wait(1)

---

💜 HISTORY 💜

• 28-Apr-2026 — auto generated by spf13/cobra. the robots did this one, not me. 🤖✨

---

and that's the whole page bestie!! this one's from the composer-cli manual, dated Apr 2026 — go forth and manage your composes, you absolute icon. 💖🎀🦋🌸