FLAKE-CTL(8)

🦋 NAME 🦋

FLAKE-CTL(8) —

✨ NAME (yes, again, she's extra) ✨

flake-ctl — Load and Register flake applications 💅

---

🌸 SYNOPSIS 🌸

USAGE:
    flake-ctl <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help         Print this message or the help of the given subcommand(s)
    init         Create the setup to run flake applications
    list         List registered container applications
    podman       Load and register OCI applications
    firecracker  Load and register VM applications

---

💖 DESCRIPTION 💖

okay so bestie, flake-ctl is the control program for registering and managing flake applications — and those apps actually run inside an instance that a runtime engine creates for them. icon behavior honestly.

the runtime engines that are supported rn are:

• podman
• firecracker

and here's the slay part: once you register an app through flake-ctl, you can call it on the host just like a native application — literally just use the name you picked during registration. no cap. 🔥

---

🎀 USER MODE 🎀

flake-ctl figures out which setup to operate on by looking at who's calling it. there is no option to select the mode, it's giving psychic, it just knows:

• Called as the root user, the command manages the system wide setup. Flakes get registered below /usr/share/flakes and the images are stored in the system wide registries of the engines.
• Called as any other user, the command manages the setup of that user. Flakes are registered below $HOME/.config/flakes and the images are stored in the registries of that user — rootless mode, we love her. 🫶 The user specific setup has to exist, and it's created once by calling flake-ctl init.

ngl the user-mode one trips people up all the time — if your user setup doesn't exist yet, bestie, go run flake-ctl init first. it's literally one command. 😭

---

🌈 SEE ALSO 🌈

podman-pilot(8), flake-ctl-init(8), flake-ctl-list(8), flake-ctl-podman-load(8), flake-ctl-podman-register(8), flake-ctl-podman-remove(8), flake-ctl-podman-show(8), firecracker-pilot(8), flake-ctl-firecracker-load(8), flake-ctl-firecracker-register(8), flake-ctl-firecracker-remove(8), flake-ctl-firecracker-show(8), flake-ctl-firecracker-network-init(8), flake-ctl-firecracker-network-add(8), flake-ctl-firecracker-network-remove(8)

---

👑 AUTHOR 👑

Marcus Schäfer

---

⭐ COPYRIGHT ⭐

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

---

and that's the whole page 🎀 this was the FLAKE-CTL(8) manual, section 8, footer included — and the footer literally just repeats FLAKE-CTL(8)() with no version or date filled in, so no tea to spill there 🍓 stay hydrated, go register something cute, mwah 💜