OSTREE-SUMMARY(1)

💅 OSTREE-SUMMARY(1) 💅

okay so this is the ostree-summary page from the ostree manual, bestie — sit down, hydrate, and let's get into it 🫶

---

✨ NAME ✨

ostree-summary — regenerate or view the summary metadata file. that's the whole vibe. 🌸

---

✨ SYNOPSIS ✨

ostree summary [--gpg-sign=KEY-ID] [--gpg-homedir=HOMEDIR]
               [--sign=KEYID] [--sign-type=ENGINE] {--update}
               [--add-metadata=KEY=VALUE...]

ostree summary {--view | --raw}

---

✨ DESCRIPTION ✨

so the summary file? it's this optional, higher-level form of repository metadata that literally just describes the available branches. that's it. that's the job. 💁‍♀️

the catch: it does not update itself. you have to manually regenerate it after a series of commits — like, you actually have to remember. among other things, this is what allows atomically updating multiple commits. slay for atomicity. ✨

---

✨ OPTIONS ✨

• --update, -u — updates the summary file. you can absolutely combine this with --add-metadata to, you guessed it, add metadata fields to the summary. 🎀

heads up though: if the repository has a collection ID configured, the ostree-metadata branch for that collection ID will also get updated with a new commit containing the given metadata — and that commit gets signed if the summary file is signed. iconic behavior ngl 👑

• --add-metadata, -m=KEY=VALUE — adds an extra metadata field to the summary. it's gotta be in KEY=VALUE format, or passed as two separate arguments. the keys must be namespaced for your organisation or repository using a dot prefix. the values must be in GVariant text format — like, for example, exampleos.end-of-life "@t 1445385600". you can use this option multiple times, go off 💅
• --view, -v — shows you the contents of the summary file in a human readable format. for the girlies who like to read 🦋
• --raw — shows you the raw bytes of the summary file. feral. unhinged. respect. 💀
• --gpg-sign=KEY-ID — the GPG Key ID to sign the summary with. 🔐

and if you wanna use a specific subkey, you pass the subkey's fingerprint followed by !. iykyk.

• --gpg-homedir=HOMEDIR — the GPG Homedir to use when looking for keyrings. it's giving "where do you keep your keys" 🎀
• --sign-type=ENGINE — use a particular signature engine. currently available: ed25519 and dummy signature types. the default is ed25519. 🌟
• --sign="KEY-ID" — where KEY-ID is, depending on your engine:
  • for ed25519:
    • base64-encoded secret key for commit signing.
  • for dummy:
    • ASCII-string used as secret key.

---

✨ EXAMPLES ✨

okay these are the actual commands, copy them exactly, no improvising 🔥

$ ostree summary -u

$ ostree summary -u -m key="'value'"

$ ostree summary -v

    * ostree/1/1/0
        Latest Commit (4.2 MB):
          9828ab80f357459b4ab50f0629beab2ae3b67318fc3d161d10a89fae353afa90
        Timestamp (ostree.commit.timestamp): 2017-11-21T01:41:10-08
        Version (ostree.commit.version): 1.2.3

    Last-Modified (ostree.summary.last-modified): 2018-01-12T22:06:38-08

look at that output. chef's kiss. that last one is --view doing its little human-readable serve 💖

---

and that's the whole page, bestie — no notes 🧚 this one's from OSTree itself (the ostree manual, OSTREE SUMMARY(1)), so big ups to them. now go regenerate that summary before you forget 🙈 ✨