OSTREE-CHECKOUT(1)

💖 NAME 💖

Okay so this is the ostree checkout page — manual name OSTREE CHECKOUT(1), same energy, we’re in the right place. ✨

ostree-checkout — check out a commit into a filesystem, bestie. That’s the whole job. 💅

✨ SYNOPSIS ✨

ostree checkout [OPTIONS...] {COMMIT} [DESTINATION]

🌸 DESCRIPTION 🌸

Here’s the tea: ostree checkout checks out the given COMMIT into the filesystem under directory DESTINATION. If DESTINATION is not specified, then COMMIT will become the destination checkout target. Main character behavior, honestly. 👑

If the COMMIT destination already exists, the command will error unless the --union option is selected. That’s the vibe check, so don’t get caught out. ⚠️

🎀 OPTIONS 🎀

• --user-mode, -U — Do not change file ownership or initialize extended attributes. We’re leaving those alone, periodt. 🫶
• --subpath="PATH" — Checkout sub-directory PATH. Scope it to just that little corner. 🦋
• --union — Keep existing directories and unchanged files, overwrite existing files. Merge energy, but make it filesystem. 💫
• --union-add — Keep existing directories and files. No overwrite drama. 🌸
• --union-identical — Like --union, but error out if a file would be replaced with a different file. Add new files and directories, ignore identical files, and keep existing directories. Requires -H. (Yes, -H is required — iykyk.) 🔥
• --whiteouts — Process whiteout files (Docker style). Container-core. 🐳
• --process-passthrough-whiteouts — Enable overlayfs whiteout extraction into 0:0 character devices. Overlayfs whiteouts are encoded inside ostree as .ostree-wh.filename and extracted as 0:0 character devices. This is useful to carry container storage embedded into ostree. Ngl, that’s a whole vibe. 🧚
• --allow-noent — Do nothing if specified path does not exist. No path, no problem. 🙈
• --from-stdin — Process many checkouts from standard input. Bulk mode activated. 💥
• --from-file="FILE" — Process many checkouts from input file. Same energy, file edition. 📁
• --fsync="POLICY" — POLICY is a boolean which specifies whether fsync should be used or not. Default to true. Yes, true is the default — noted. ✅
• --require-hardlinks, -H — Do not fall back to full copies if hardlinking fails. Hardlinks or bust. 🔗
• --force-copy-zerosized, -z — This option does nothing; the functionality is now always on by default. It’s giving placeholder flag. 💀
• --force-copy, -C — Never hardlink (but may reflink if available). Copy girl summer. 🎀
• --bareuseronly-dirs, -M — Suppress mode bits outside of 0775 for directories (suid, world writable, etc.). Lock it down, bestie. 🔒
• --skip-list="FILE" — Skip checking out the absolute file paths listed in FILE, one per line. A little skip list, very organized. 📝
• --selinux-policy — Set SELinux labels based on policy in root filesystem PATH (may be /). This implies --force-copy. SELinux girlies rise. 🛡️
• --composefs — Only generate a composefs, not a directory. Composefs only, no directory. ✨
• --composefs-noverity — Only generate a composefs, not a directory; fsverity digests will not be included. This is best used for "opportunistic" use of composefs. No fsverity digests in this one. 🌈

🦋 EXAMPLE 🦋

Here’s the iconic little sequence:

$ ostree checkout my-branch

$ ls

            file1    file2    my-branch

And look at that — my-branch is right there next to file1 and file2. Slay. 💖

---

That’s the whole OSTREE CHECKOUT(1) page, bestie. Footer source/version says OSTree, and there’s no date in this one — so no invented date, just the page and good vibes. 🫶🎀💖