HEAT(1)

👑 HEAT(1) — the heat girlie's field guide 💅

okay so bestie, welcome to heat, aka your command line access to the heat project ✨ (it lives in the python-heatclient family, iykyk). This is the glow-up doc, not the boring one.

---

🌸 NAME 🌸

heat — Command line access to the heat project. That's it, that's the whole vibe 🫶

---

✨ SYNOPSIS ✨

heat [options] <command> [command-options]

heat help

heat help <command>

three little lines, main character energy, no notes 💖

---

🦋 DESCRIPTION 🦋

heat is a command line client for controlling OpenStack Heat. Literally the remote control for your stacks, and honestly? iconic.

Before you even think about issuing the heat command, make sure your environment has the necessary variables in it so the CLI can pass user credentials to the server. no creds = no vibes, fr fr. 👀

If you need the full rundown on that, peep the Getting Credentials for a CLI section of the OpenStack CLI Guide for more info — that's where the ✨answers✨ live.

---

💅 OPTIONS 💅

so the options situation is very "the menu is the help command" energy, and I respect it. Here's how you find stuff:

• run heat help to get a list of available commands and options 🎀
• run heat help <command> to get the usage and options of a command 🔥

that's the whole flex. go off, explorer.

---

🌈 EXAMPLES 🌈

bestie this is the fun part, let's do a lil tour 🧚

Get information about the stack-create command:

heat help stack-create

List available stacks:

heat stack-list

List available resources in a stack:

heat resource-list <stack name>

Create a stack:

heat stack-create mystack -f some-template.yaml -P "KeyName=mine"

note the -f for your template file and -P for your params — she's detailed and she's slaying 🍓

View stack information:

heat stack-show mystack

List stack outputs:

heat output-list <stack name>

Show the value of a single output:

heat output-show <stack name> <output key>

List events:

heat event-list mystack

Delete a stack:

heat stack-delete mystack

Abandon a stack:

heat stack-abandon mystack

Adopt a stack

heat stack-adopt -a <adopt_file> mystack

List heat-engines running status

heat service-list

⚠️ Note, and this one's important: the stack-adopt and stack-abandon commands are not available by default. Please ask your OpenStack operator to enable this feature. no cap — they're locked behind the operator's ✨permission slip✨, so don't come for yourself when they're missing, ask your operator bestie 🙈

---

💀 BUGS 💀

Heat client bugs are managed throught StoryBoard OpenStack Heat Client Stories — yes, that's the story(vote) of our lives, go report it there 🫶 (and yeah, throught is their spelling, not mine, I'm just the messenger 💀)

---

🎀 AUTHOR 🎀

Heat Developers — the collective mother, respect 👑

---

⭐ COPYRIGHT ⭐

OpenStack Contributors — they ate and left no crumbs 💜

---

that's the whole page bestie, go stack something gorgeous ✨💅🦋

big kiss, this was python-heatclient version 5.1.0, dated Apr 13, 2026 — see you in the next stack 🫶