FLATPAK-BUILD-UPDATE-REPO(1)

πŸ’– flatpak-build-update-repo β€” the manual page, but make it cute πŸ’–

okay bestie, so this is the page for flatpak-build-update-repo, straight outta the flatpak manual. it lives in section 1. let's get into it ✨


πŸŽ€ NAME πŸŽ€

flatpak-build-update-repo β€” create a repository from a build directory

like, literally that's the whole job. no notes. πŸ’…


✨ SYNOPSIS ✨

flatpak build-update-repo [OPTION...] LOCATION

πŸ¦‹ DESCRIPTION πŸ¦‹

so what this does is it updates the repository metadata for the repo sitting at LOCATION. and when it does that, it generates an OSTree summary file that lists out everything inside the repository. that summary is the whole moment β€” it's what flatpak remote-ls and the other commands use to show you what's in remote repositories. like, without it, nothing can see anything. it's giving backstage pass. 🎟️

and after you run this? LOCATION can be used as the repository location for flatpak remote-add. either by exporting it over http, or just directly with a file: url. easy. 🫢


🌸 OPTIONS 🌸

here's everything it understands, bestie. all of it. no skips:

  • -h, --help β€” shows the help options and dips. bye πŸ‘‹
  • --redirect-url=URL β€” redirects this repo to a brand new URL. glow-up relocation.
  • --title=TITLE β€” a title for the repository, like for showing off in a UI. the title gets stored in the repository summary. put it in the summary, it stays in the summary. πŸ’Ύ
  • --comment=COMMENT β€” a single-line comment for the remote, again for UI display purposes. stored in the repository summary too.
  • --description=DESCRIPTION β€” a full-paragraph description for the remote, e.g. for display in a UI. yep, stored in the repository summary. it's the long-form version of the comment, main character energy.
  • --homepage=URL β€” URL for a website for the remote, e.g. for display in a UI. the url is stored in the repository summary.
  • --icon=URL β€” URL for an icon for the remote, e.g. for display in a UI. url goes in the repository summary, obviously. ✨
  • --default-branch=BRANCH β€” a default branch for the repository, mainly for use in a UI.
  • --gpg-import=FILE β€” imports a new default GPG public key from the file you give it. πŸ”‘
  • --collection-id=COLLECTION-ID β€” the globally unique identifier of the remote repository, so mirrors can get grouped together. > ⚠️ this must be set to a globally unique reverse DNS string if the repository is gonna be made publicly available. if a collection ID is already set on an existing repository, this will update it. if you don't specify it, the existing collection ID is left unchanged. no cap.
  • --deploy-collection-id β€” deploys the collection ID (the one you set with --collection-id) into the static remote configuration for all clients. > 🚨 this is irrevocable once it's published in a repository. like, once it's out, it's out. use it to decide when to roll out a collection ID to users of an existing repository. and if you're constructing a brand new repository that has a collection ID, you should typically always pass this option. periodt.
  • --deploy-sideload-collection-id β€” basically the same vibe as --deploy-collection-id, except it only applies the deploy to clients newer than flatpak 1.7, which is the version that supports the new form of sideloads. 🧚
  • --gpg-sign=KEYID β€” signs the commit with this GPG key. you can use this option multiple times, so go off. ✍️
  • --gpg-homedir=PATH β€” the GPG Homedir to use when it's looking for keyrings.
  • --generate-static-deltas β€” generates static deltas for all references. it makes from-empty and delta static files that let downloads go faster. speed. πŸƒβ™€οΈ
  • --static-delta-jobs=NUM-JOBS β€” limits how many parallel jobs are creating static deltas. the default is the number of cpus. multitasking queen.
  • --static-delta-ignore-ref=PATTERN β€” don't generate deltas for runtime or application id matching this pattern. for instance, --static-delta-ignore-ref=*.Sources means there will not be any deltas for source refs. leaving them on read. πŸ™ˆ
  • --prune β€” removes unreferenced objects in the repo. cleanup szn 🧹
  • --prune-depth β€” only keeps at most this number of old versions for any particular ref. default is -1, which means infinite. hoarder mode enabled by default, wild.
  • -v, --verbose β€” prints debug information during command processing. talk to meee.
  • --ostree-verbose β€” prints OSTree debug information during command processing. even more talking.

πŸ‘‘ SEE ALSO πŸ‘‘

ostree(1), flatpak(1), flatpak-remote-ls(1), flatpak-build-export(1)


and that's the whole page bestie!! this little masterpiece comes to you from the flatpak manual, FLATPAK BUILD-UPDAT(1) β€” yes the header really does truncate like that, it's iconic, we don't fix it. go update a repo. slay. πŸ’…πŸ’–πŸ¦‹

πŸ“¦ where this page comes from