1FLATPAK BUILD-EXPOR(1) flatpak build-export FLATPAK BUILD-EXPOR(1)
2
3
4
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
16 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
20 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
26 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
33 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
39 -h, --help
40 Show help options and exit.
41
42 -s, --subject=SUBJECT
43 One line subject for the commit message.
44
45 -b, --body=BODY
46 Full description for the commit message.
47
48 --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
55 --arch=ARCH
56 Specify the architecture component of the branch to export. Only
57 host compatible architectures can be specified.
58
59 --exclude=PATTERN
60 Exclude files matching PATTERN from the commit. This option can be
61 used multiple times.
62
63 --include=PATTERN
64 Don't exclude files matching PATTERN from the commit, even if they
65 match the --export patterns. This option can be used multiple
66 times.
67
68 --metadata=FILENAME
69 Use the specified filename as metadata in the exported app instead
70 of the default file (called metadata). This is useful if you want
71 to commit multiple things from a single build tree, typically used
72 in combination with --files and --exclude.
73
74 --files=SUBDIR
75 Use the files in the specified subdirectory as the file contents,
76 rather than the regular files directory.
77
78 --timestamp=DATE
79 Use the specified ISO 8601 formatted date or NOW, for the current
80 time, in the commit metadata and, if --update-appstream is used,
81 the appstream data.
82
83 --end-of-life=REASON
84 Mark the build as end-of-life. REASON is a message that may be
85 shown to users installing this build.
86
87 --disable-fsync
88 Don't fsync when writing to the repository. This can result in data
89 loss in exceptional situations, but can improve performance when
90 working with temporary or test repositories.
91
92 --update-appstream
93 Update the appstream branch after the build.
94
95 --no-update-summary
96 Don't update the summary file after the new commit is added. This
97 means the repository will not be useful for serving over http until
98 build-update-repo has been run. This is useful is you want to do
99 multiple repo operations before finally updating the summary.
100
101 --gpg-sign=KEYID
102 Sign the commit with this GPG key. This option can be used multiple
103 times.
104
105 --gpg-homedir=PATH
106 GPG Homedir to use when looking for keyrings
107
108 -r, --runtime
109 Export a runtime instead for an app (this uses the usr subdir as
110 files).
111
112 -v, --verbose
113 Print debug information during command processing.
114
115 --ostree-verbose
116 Print OSTree debug information during command processing.
117
119 $ flatpak build-export ~/repos/gnome-calculator/
120 ~/build/gnome-calculator/ org.gnome.Calculator
121
122 Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c
123 Metadata Total: 605
124 Metadata Written: 5
125 Content Total: 1174
126 Content Written: 1
127 Content Bytes Written: 305
128
130 ostree(1), flatpak(1), flatpak-build-init(1), flatpak-build(1),
131 flatpak-build-finish(1), flatpak-build-sign(1), flatpak-build-update-
132 repo(1)
133
134
135
136flatpak FLATPAK BUILD-EXPOR(1)