FLAKE-CTL-LIST(8)

okay bestie, this is the FLAKE-CTL-LIST(8) manual page — the one for flake-ctl list — and yes, the source has two NAME sections, so we are honoring the lore and keeping both 💅

💖 NAME 💖

FLAKE-CTL-LIST(8) -

🎀 NAME 🎀

flake-ctl list - List registered flake applications

✨ SYNOPSIS ✨

          USAGE:
              flake-ctl list [OPTIONS]

          OPTIONS:
              --format <FORMAT>
              --help

🦋 DESCRIPTION 🦋

okay so flake-ctl list does exactly what it says: it lists registered flake applications. iconic, no notes.

The registry it reads is detected from the caller. If you call it as the root user, it lists the system wide registry. If you call it as literally any other user, it lists that user's flake registry. no cap.

By default the list is rendered as a table with a headline, and that headline is meant to be read by humans. For processing the list in scripts and other programs, the machine readable formats json and csv are provided. periodt.

Here's the info listed for each flake, bestie:

• name — Name of the flake application
• engine — Engine used to run the flake application, either podman or firecracker
• target_app_path — Path of the application as it is called on the engine
• host_app_path — Path of the application as it is called on the host
• config — Path of the flake configuration file.

Information which cannot be read from the flake configuration is shown as - in the table format, as null in the json format and as an empty field in the csv format. 💀

🌸 OPTIONS 🌸

• --format <FORMAT> — Format of the output. Supported formats are:
  • table: human readable table with a headline. Default
  • json: machine readable list of flake records
  • csv: machine readable comma separated values without a header line
• --help — it's listed in the synopsis; the source doesn't add a separate OPTIONS description for it here.

🧚 FILES 🧚

• /usr/share/flakes
• $HOME/.config/flakes

🔥 EXAMPLE 🔥

Run it like this, bestie:

$ flake-ctl list

$ flake-ctl list --format json

$ flake-ctl list --format csv

👑 AUTHOR 👑

Marcus Schäfer

🌈 COPYRIGHT 🌈

(c) 2022, Elektrobit Automotive GmbH (c) 2023, Marcus Schäfer

---

okay that's the whole vibe — the footer is literally FLAKE-CTL-LIST(8)() with no extra date/version attached, so go forth and list those flakes, bestie 💖✨