1FLATPAK BUILD-EXPOR(1) flatpak build-export FLATPAK BUILD-EXPOR(1)
2
6 flatpak-build-export - Create a repository from a build directory
7
9 flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]
10
12 Creates or updates a repository with an application build. LOCATION is
13 the location of the repository. DIRECTORY must be a finalized build
14 directory. If BRANCH is not specified, it is assumed to be "master".
15 If LOCATION exists, it is assumed to be an OSTree repository, otherwise
17 a new OSTree repository is created at this location. The repository can
18 be inspected with the ostree tool.
19 The contents of DIRECTORY are committed on the branch with name
21 app/APPNAME/ARCH/BRANCH, where ARCH is the architecture of the runtime
22 that the application is using. A commit filter is used to enforce that
23 only the contents of the files/ and export/ subdirectories and the
24 metadata file are included in the commit, anything else is ignored.
25 When exporting a flatpak to be published to the internet,
27 --collection-id=COLLECTION-ID should be specified as a globally unique
28 reverse DNS value to identify the collection of flatpaks this will be
29 added to. Setting a globally unique collection ID allows the apps in
30 the repository to be shared over peer to peer systems without needing
31 further configuration.
32 The build-update-repo command should be used to update repository
34 metadata whenever application builds are added to a repository.
35
37 The following options are understood:
38 -h, --help
40 Show help options and exit.
41 -s, --subject=SUBJECT
43 One line subject for the commit message.
44 -b, --body=BODY
46 Full description for the commit message.
47 --collection-id=COLLECTION-ID
49 Set as the collection ID of the repository. Setting a globally
50 unique collection ID allows the apps in the repository to be shared
51 over peer to peer systems without needing further configuration. If
52 exporting to an existing repository, the collection ID must match
53 the existing configured collection ID for that repository.
54 --subset=SUBSET
56 Mark the commit to be included in the named subset. This will cause
57 the commit to be put in the named subset summary (in addition to
58 the main one), allowing users to see only this subset instead of
59 the whole repo.
60 --arch=ARCH
62 Specify the architecture component of the branch to export. Only
63 host compatible architectures can be specified; see flatpak
64 --supported-arches for valid values.
65 --exclude=PATTERN
67 Exclude files matching PATTERN from the commit. This option can be
68 used multiple times.
69 --include=PATTERN
71 Don't exclude files matching PATTERN from the commit, even if they
72 match the --exclude patterns. This option can be used multiple
73 times.
74 --metadata=FILENAME
76 Use the specified filename as metadata in the exported app instead
77 of the default file (called metadata). This is useful if you want
78 to commit multiple things from a single build tree, typically used
79 in combination with --files and --exclude.
80 --files=SUBDIR
82 Use the files in the specified subdirectory as the file contents,
83 rather than the regular files directory.
84 --timestamp=DATE
86 Use the specified ISO 8601 formatted date or NOW, for the current
87 time, in the commit metadata and, if --update-appstream is used,
88 the appstream data.
89 --end-of-life=REASON
91 Mark the build as end-of-life. REASON is a message that may be
92 shown to users installing this build.
93 --end-of-life-rebase=ID
95 Mark the build as end-of-life. Unlike --end-of-life, this one takes
96 an ID that supersedes the current one. By the user's request, the
97 application data may be preserved for the new application.
98 --disable-fsync
100 Don't fsync when writing to the repository. This can result in data
101 loss in exceptional situations, but can improve performance when
102 working with temporary or test repositories.
103 --update-appstream
105 Update the appstream branch after the build.
106 --no-update-summary
108 Don't update the summary file after the new commit is added. This
109 means the repository will not be useful for serving over http until
110 build-update-repo has been run. This is useful is you want to do
111 multiple repo operations before finally updating the summary.
112 --gpg-sign=KEYID
114 Sign the commit with this GPG key. This option can be used multiple
115 times.
116 --gpg-homedir=PATH
118 GPG Homedir to use when looking for keyrings
119 -r, --runtime
121 Export a runtime instead of an app (this uses the usr subdir as
122 files).
123 -v, --verbose
125 Print debug information during command processing.
126 --ostree-verbose
128 Print OSTree debug information during command processing.
129
131 $ flatpak build-export ~/repos/gnome-calculator/
132 ~/build/gnome-calculator/ org.gnome.Calculator
133 Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c
135 Metadata Total: 605
136 Metadata Written: 5
137 Content Total: 1174
138 Content Written: 1
139 Content Bytes Written: 305
140
142 ostree(1), flatpak(1), flatpak-build-init(1), flatpak-build(1),
143 flatpak-build-finish(1), flatpak-build-sign(1), flatpak-build-update-
144 repo(1)
145flatpak FLATPAK BUILD-EXPOR(1)