OSTREE-COMMIT(1)

✨ NAME ✨

hey bestie, welcome to the OSTREE COMMIT(1) page — manual name is ostree commit, and it is literally about committing a new revision. 💅

🎀 SYNOPSIS 🎀

ostree commit [OPTIONS...] --branch= {BRANCH} [PATH]

💅 DESCRIPTION 💅

okay so this lets you commit changes to a branch, and specifying the branch is required — no branch, no commit, periodt. The command prints the checksum of a successful commit, so you get that little receipt of slay. ✨

🌈 OPTIONS 🌈

bestie, here’s the whole menu, no skips, no “you don’t need that one” energy:

• --subject, -s="SUBJECT" — one line subject. (optional)
• --body, -m="BODY" — full description. (optional)
• --body-file, -F="FILE" — full commit description from a file. (optional)
• --editor, -e — open a text editor for the commit description. It uses OSTREE_EDITOR, VISUAL, EDITOR, or vi, in descending order of preference. The commit is aborted if the message is left empty.
• --branch, -b="BRANCH" — branch. Required unless --orphan is given.
• --parent="COMMIT" — parent checksum, or "none" to explicitly use no parent. If not specified, BRANCH is used as parent (no parent in case BRANCH does not exist).
• --tree with dir=PATH, tar=TARFILE, or ref=COMMIT — overlay the given argument as a tree. When committing an archive, the TARFILE can be specified as - to read the archive from standard input.
• --base="REV" — start from the content in a commit. This differs from --tree=ref=REV in that no commit modifiers are applied. This is usually what you want when creating a derived commit. This is also used for --selinux-policy-from-base.
• --add-metadata-string="KEY=VALUE" — add a key/value pair to metadata. Can be specified multiple times.
• --add-metadata="KEY=VALUE" — add a key/value pair to metadata, where the KEY is a string, and VALUE is g_variant_parse() formatted. Can be specified multiple times.
• --keep-metadata="KEY" — keep metadata KEY and its associated VALUE from parent. Can be specified multiple times.
• --add-detached-metadata-string="KEY=VALUE" — add a key/value pair to detached metadata.
• --owner-uid="UID" — set file ownership user id.
• --owner-gid="GID" — set file ownership group id.
• --no-xattrs — do not import extended attributes.
• --selinux-labeling-epoch0 | 1 — when SELinux labeling is enabled, epoch 1 ensures that /usr/etc is labeled as if it was /etc.
• --bootable — inject standard metadata for a bootable Linux filesystem tree.
• --link-checkout-speedup — optimize for commits of trees composed of hardlinks into the repository.
• --tar-autocreate-parents — when loading tar archives, automatically create parent directories as needed.
• --skip-if-unchanged — if the contents are unchanged from previous commit, do nothing.
• --consume — when committing from a local directory (i.e. not an archive or --tree=ref), assume ownership of the content. This may simply involve deleting it, but if possible, the content may simply be rename()ed into the repository rather than creating a new copy.
• --statoverride="PATH" — file containing list of modifications to make permissions (file mode in decimal, followed by space, followed by file path). The specified mode is ORed with the file’s original mode unless preceded by =.
• --skip-list="PATH" — file containing list of file paths to skip (one path per line).
• --table-output — output more information in a KEY: VALUE format.
• --generate-sizes — generate size information along with commit metadata.
• --gpg-sign="KEY-ID" — GPG Key ID with which to sign the commit (if built with GPGME - GNU Privacy Guard Made Easy). To use a specific subkey, pass the subkey’s fingerprint followed by !.
• --gpg-homedir="HOMEDIR" — GPG home directory to use when looking for keyrings (if built with GPGME - GNU Privacy Guard Made Easy).
• --timestamp="TIMESTAMP" — override the timestamp of the commit to TIMESTAMP.
• --orphan — create a commit without writing to a ref (branch).
• --fsync="POLICY" — POLICY is a boolean which specifies whether fsync should be used or not. Default to true.
• -s, --sign-type — use particular signature engine. Currently available ed25519, spki, and dummy signature types. The default is ed25519.
• --sign-from-file="PATH" — this will read a key (corresponding to the provided --sign-type from the provided path. The encoding of the key depends on signature engine. For ed25519 the key should be base64 encoded, for spki it should be in PEM format, and for dummy it should be an ASCII-string.
• --sign="KEY-ID" — > ⚠️ in new code, avoid using this because passing private keys via command line arguments are prone to leakage in logs and process listings. The KEY-ID is:
  • for ed25519 and spki: base64-encoded secret key for commit signing.
  • for dummy: ASCII-string used as secret key.

🍓 EXAMPLE 🍓

$ ostree commit --branch=my-branch --subject="Initial commit"

67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc

💖 that’s the whole OSTREE COMMIT(1) page, bestie — footer says source/version OSTree, and there’s no date printed, so I’m not inventing one. bye 🎀