+
The command reference is generated from the flatpak-builder repo; see https://github.com/flatpak/flatpak-builder/tree/master/doc
Flatpak-builder is a tool to build flatpak applications. @@ -168,7 +168,9 @@ The default is the number of CPUs on the machine.
--force-cleanErase the previous contents of DIRECTORY if it is - not empty. + not empty. Since 1.4.6, deletion will be refused + if DIRECTORY is the current working directory, the + state directory, or any of their parent directories.
--sandboxDisable the possibility to specify build-args that are passed to flatpak build. This means the build @@ -212,6 +214,15 @@ Set this timestamp as SOURCE_DATE_EPOCH to perform the build, instead of the last modification time of the manifest. This is available since 1.3.1. +
--compose-url-policy=POLICY
+ Set the AppStream compose URL policy. Accepted values
+ are partial and full.
+ full requires AppStream version >= 0.16.3.
+ Defaults to partial if unspecified.
+ This policy only takes effect when used in conjunction
+ with --mirror-screenshots-url=URL;
+ otherwise the Appstream catalogue will preserve
+ the source media URLs.
--add-tag=TAGAdd this tag to the tags list of the manifest before building.
--remove-tag=TAG@@ -431,7 +442,7 @@ as the name of a separate json or yaml file that contains sources. See below for details.
secret-env (array of strings)An array defining which host environment variables is transfered to build-commands or post-install environment.
config-opts (array of strings)An array of options that will be passed to configure
secret-opts (array of strings)An array of options that will be passed to configure, meant to be used to pass secrets through host environment variables. Put the option - with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'
make-args (array of strings)An array of arguments that will be passed to make
make-install-args (array of strings)An array of arguments that will be passed to make install
rm-configure (boolean)If true, remove the configure script before starting build
no-autogen (boolean)Ignore the existence of an autogen script
no-parallel-make (boolean)Don't call make with arguments to build in parallel
install-rule (string)Name of the rule passed to make for the install phase, default is install
no-make-install (boolean)Don't run the make install (or equivalent) stage
no-python-timestamp-fix (boolean)Don't fix up the *.py[oc] header timestamps for ostree use.
cmake (boolean)Use cmake instead of configure (deprecated: use buildsystem instead)
buildsystem (string)Build system to use: autotools, cmake, cmake-ninja, meson, simple, qmake
builddir (boolean)Use a build directory that is separate from the source directory
subdir (string)Build inside this subdirectory of the extracted sources
build-options (object)A build options object that can override global options. Note that this is not inherited by nested modules.
build-commands (array of strings)An array of commands to run during build (between make and make install if those are used). + with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'
make-args (array of strings)An array of arguments that will be passed to make
make-install-args (array of strings)An array of arguments that will be passed to make install
rm-configure (boolean)If true, remove the configure script before starting build. This requires the configure script to exist in the source directory.
no-autogen (boolean)Ignore the existence of an autogen script
no-parallel-make (boolean)Don't call make with arguments to build in parallel
install-rule (string)Name of the rule passed to make for the install phase, default is install
no-make-install (boolean)Don't run the make install (or equivalent) stage
no-python-timestamp-fix (boolean)Don't fix up the *.py[oc] header timestamps for ostree use.
cmake (boolean)Use cmake instead of configure (deprecated: use buildsystem instead)
buildsystem (string)Build system to use: autotools, cmake, cmake-ninja, meson, simple, qmake
builddir (boolean)Use a build directory that is separate from the source directory
subdir (string)Build inside this subdirectory of the extracted sources
build-options (object)A build options object that can override global options. Note that this is not inherited by nested modules.
build-commands (array of strings)An array of commands to run during build (between make and make install if those are used).
This is primarily useful when using the "simple" buildsystem.
Each command is run in /bin/sh -c, so it can use standard POSIX shell syntax such as piping output.
If any individual entry in the array fails, then the whole build process will fail,
@@ -457,7 +468,7 @@
The type of archive if it cannot be guessed from the path. Possible values are "rpm", "tar",
"tar-gzip", "tar-compress", "tar-bzip2", "tar-lzip", "tar-lzma", "tar-lzop", "tar-xz", "tar-zst", "zip" and "7z".
md5 (string)The md5 checksum of the file, verified after download
Note that md5 is no longer considered a safe checksum, we recommend you use at least sha256.
sha1 (string)The sha1 checksum of the file, verified after download
Note that sha1 is no longer considered a safe checksum, we recommend you use at least sha256.
sha256 (string)The sha256 checksum of the file, verified after download
sha512 (string)The sha512 checksum of the file, verified after download
strip-components (integer)The number of initial pathname components to strip during extraction. Defaults to 1.
dest-filename (string)Filename to for the downloaded file, defaults to the basename of url.
type"git"
path (string)The path to a local checkout of the git repository. Due to how git-clone works, this will be much faster than specifying a URL of file:///...
url (string)URL of the git repository. This overrides path if both are specified. When using git via SSH, the correct syntax is ssh://user@domain/path/to/repo.git.
branch (string)The branch to use from the git repository. As of 1.2.3 this will try to auto-detect the upstream default branch. Previously this defaulted to master.
tag (string)The tag to use from the git repository
commit (string)The commit to use from the git repository. If branch is also specified, then it is verified that the branch/tag is at this specific commit. This is - a readable way to document that you're using a particular tag, but verify that it does not change.
disable-fsckobjects (boolean)Don't use transfer.fsckObjects=1 to mirror git repository. This may be needed for some (broken) repositories.
disable-shallow-clone (boolean)Don't optimize by making a shallow clone when downloading the git repo.
disable-submodules (boolean)Don't checkout the git submodules when cloning the repository.
type"bzr"
url (string)URL of the bzr repository
revision (string)A specific revision to use in the branch
type"svn"
url (string)URL of the svn repository, including branch/tag part
revision (string)A specific revision number to use
type"dir"
path (string)The path of a local directory whose content will be copied into the source dir. Note that directory sources don't currently support caching, so they will be rebuilt each time.
skip (array of strings)Source files to ignore in the directory.
type"file"
path (string)The path of a local file that will be copied into the source dir
url (string)The URL of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.
mirror-urls (array of strings)A list of alternative urls that are used if the main url fails.
referer (string)Sets the HTTP "Referer" header when downloading the file.
disable-http-decompression (boolean)Disables decompression of downloads over HTTP for misconfigured servers.
md5 (string)The md5 checksum of the file, verified after download. This is optional for local files.
Note that md5 is no longer considered a safe checksum, we recommend you use at least sha256.
sha1 (string)The sha1 checksum of the file, verified after download. This is optional for local files.
Note that sha1 is no longer considered a safe checksum, we recommend you use at least sha256.
sha256 (string)The sha256 checksum of the file, verified after download. This is optional for local files.
sha512 (string)The sha512 checksum of the file, verified after download. This is optional for local files.
dest-filename (string)Filename to use inside the source dir, default to the basename of path.
+ a readable way to document that you're using a particular tag, but verify that it does not change.
disable-fsckobjects (boolean)Don't use transfer.fsckObjects=1 to mirror git repository. This may be needed for some (broken) repositories.
disable-shallow-clone (boolean)Don't optimize by making a shallow clone when downloading the git repo.
disable-submodules (boolean)Don't checkout the git submodules when cloning the repository.
disable-lfs (boolean)Don't explicitly fetch or checkout LFS git objects. This will be ignored by Git if LFS filters are active in system or global gitconfig.
type"bzr"
url (string)URL of the bzr repository
revision (string)A specific revision to use in the branch
type"svn"
url (string)URL of the svn repository, including branch/tag part
revision (string)A specific revision number to use
type"dir"
path (string)The path of a local directory whose content will be copied into the source dir. Note that directory sources don't currently support caching, so they will be rebuilt each time.
skip (array of strings)Source files to ignore in the directory.
type"file"
path (string)The path of a local file that will be copied into the source dir
url (string)The URL of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.
mirror-urls (array of strings)A list of alternative urls that are used if the main url fails.
referer (string)Sets the HTTP "Referer" header when downloading the file.
disable-http-decompression (boolean)Disables decompression of downloads over HTTP for misconfigured servers.
md5 (string)The md5 checksum of the file, verified after download. This is optional for local files.
Note that md5 is no longer considered a safe checksum, we recommend you use at least sha256.
sha1 (string)The sha1 checksum of the file, verified after download. This is optional for local files.
Note that sha1 is no longer considered a safe checksum, we recommend you use at least sha256.
sha256 (string)The sha256 checksum of the file, verified after download. This is optional for local files.
sha512 (string)The sha512 checksum of the file, verified after download. This is optional for local files.
dest-filename (string)Filename to use inside the source dir, default to the basename of path.