FLAKE-CTL-FIRECRACKER-SHOW(8)

πŸ“¦ version 3.1.51, in opensuse-leap 16.0

πŸ’– FLAKE-CTL-FIRECRACKER-SHOW(8) πŸ’–

okay so bestie, welcome to the firecracker show page from the flake-ctl family β€” section 8 of the manual, and honestly? it's giving "peek behind the curtain at your VMs" and I am obsessed. πŸŽ€


✨ NAME ✨

flake-ctl firecracker show β€” literally just: Show VM instances. that's the whole vibe. πŸ‘‘


🌸 SYNOPSIS 🌸

USAGE:
    flake-ctl firecracker show [OPTIONS]

OPTIONS:
    --format <FORMAT>
    --help

like, that's it. no sneaky extra args, no positional nonsense. just vibes and maybe a format. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So. You wanna see the firecracker VM instances that were created from flake applications? Say less, bestie β€” this command is your main character. ✨

🧚 whose setup is this, anyway

The setup it reads the flake configurations from is detected from the caller. Translation: if you run it as any user other than root, it uses that user's own rootless setup. no cap, it just knows. 🫢

πŸ“ the tea on meta data files

For each VM instance, firecracker-pilot writes a meta data file named after the flake application. These files live below /tmp/flakes, inside a private directory belonging to the user the instance belongs to β€” for example:

/tmp/flakes/1000/myapp.vmid

This command reads those files and combines them with the info from the respective flake configuration file. it's a whole collab. 🀝

🌈 output formats, iykyk

By default, everything is rendered as a table with a headline β€” meant for humans to read, gorgeous, very demure. But if you're processing this in scripts and other programs, the machine readable formats json and csv are right there for you. slay. πŸ’€

πŸ‘‘ the info you get per instance

Here's what's shown for each instance, and yes it's all important so don't skip:

  • name β€” Name of the flake application the instance was created from. An instance started with the pilot option @NAME is shown with that name as a suffix. 🏷️
  • user β€” Name of the user the instance belongs to. Instances of other users are only shown if their meta data directory can be read. (respect the permissions, bestie πŸ”’)
  • id β€” Process ID of the firecracker process running the VM. A process ID of zero belongs to a VM which was created but never started. 😴
  • status β€” running if the firecracker process of the VM still exists, stopped if it does not. The status is unknown if the meta data file does not contain a process ID. πŸƒβ€β™€οΈπŸ’¨
  • image β€” Name of the VM in the local firecracker registry the instance was created from. πŸ–ΌοΈ
  • config β€” Path of the flake configuration file. The system wide registration is preferred over the registration in the flakes directory of the user the instance belongs to. βš–οΈ

πŸ™ˆ when info can't be read

Information which cannot be read is shown as - in the table format, as null in the json format, and as an empty field in the csv format. every format gets its own little coping mechanism. 😭

⭐ real talk: a meta data file also exists for an instance which is no longer running. The pilots delete them when they run the flake application again. So yeah β€” this command can absolutely show you instances in the stopped status. not a bug, it's a feature. πŸ’œ

πŸ’… OPTIONS πŸ’…

  • --format <FORMAT> β€” Format of the output. Supported formats are:
    • table: human readable table with a headline. Default πŸŽ€
    • json: machine readable list of instance records 🧊
    • csv: machine readable comma separated values without a header line πŸ“„
  • --help β€” the classic. help. 🫢

πŸŽ€ FILES πŸŽ€

  • /tmp/flakes
  • /usr/share/flakes
  • $HOME/.config/flakes
  • /etc/flakes.yml

these are the spots. know them, love them. πŸ’–


πŸ”₯ EXAMPLE πŸ”₯

$ flake-ctl firecracker show

$ flake-ctl firecracker show --format json

first one: cute table. second one: json for your scripts. both iconic. ✨


🌸 AUTHOR 🌸

Marcus SchΓ€fer πŸ‘‘


c. 2026, Marcus SchΓ€fer


and that's the whole page, bestie!! πŸ’œ source and version vibes: this is FLAKE-CTL-FIRECRACKER-SHOW(8), dated with the copyright above β€” go forth and --format json responsibly πŸ¦‹βœ¨

πŸ“¦ where this page comes from