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 --arch=ARCH
56 Specify the architecture component of the branch to export. Only
57 host compatible architectures can be specified; see flatpak
58 --supported-arches for valid values.
59 --exclude=PATTERN
61 Exclude files matching PATTERN from the commit. This option can be
62 used multiple times.
63 --include=PATTERN
65 Don't exclude files matching PATTERN from the commit, even if they
66 match the --export patterns. This option can be used multiple
67 times.
68 --metadata=FILENAME
70 Use the specified filename as metadata in the exported app instead
71 of the default file (called metadata). This is useful if you want
72 to commit multiple things from a single build tree, typically used
73 in combination with --files and --exclude.
74 --files=SUBDIR
76 Use the files in the specified subdirectory as the file contents,
77 rather than the regular files directory.
78 --timestamp=DATE
80 Use the specified ISO 8601 formatted date or NOW, for the current
81 time, in the commit metadata and, if --update-appstream is used,
82 the appstream data.
83 --end-of-life=REASON
85 Mark the build as end-of-life. REASON is a message that may be
86 shown to users installing this build.
87 --end-of-life-rebase=ID
89 Mark the build as end-of-life. Unlike --end-of-life, this one takes
90 an ID that supersedes the current one. By the user's request, the
91 application data may be preserved for the new application.
92 --disable-fsync
94 Don't fsync when writing to the repository. This can result in data
95 loss in exceptional situations, but can improve performance when
96 working with temporary or test repositories.
97 --update-appstream
99 Update the appstream branch after the build.
100 --no-update-summary
102 Don't update the summary file after the new commit is added. This
103 means the repository will not be useful for serving over http until
104 build-update-repo has been run. This is useful is you want to do
105 multiple repo operations before finally updating the summary.
106 --gpg-sign=KEYID
108 Sign the commit with this GPG key. This option can be used multiple
109 times.
110 --gpg-homedir=PATH
112 GPG Homedir to use when looking for keyrings
113 -r, --runtime
115 Export a runtime instead of an app (this uses the usr subdir as
116 files).
117 -v, --verbose
119 Print debug information during command processing.
120 --ostree-verbose
122 Print OSTree debug information during command processing.
123
125 $ flatpak build-export ~/repos/gnome-calculator/
126 ~/build/gnome-calculator/ org.gnome.Calculator
127 Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c
129 Metadata Total: 605
130 Metadata Written: 5
131 Content Total: 1174
132 Content Written: 1
133 Content Bytes Written: 305
134
136 ostree(1), flatpak(1), flatpak-build-init(1), flatpak-build(1),
137 flatpak-build-finish(1), flatpak-build-sign(1), flatpak-build-update-
138 repo(1)
139flatpak FLATPAK BUILD-EXPOR(1)