+
The command reference is generated from the flatpak repo; see https://github.com/flatpak/flatpak/tree/main/doc
Flatpak comes with a rich commandline interface. -
Table of Contents
Table of Contents
flatpak — Build, install and run applications and runtimes
flatpak [OPTION...] {COMMAND}
+
Table of Contents
Table of Contents
flatpak — Build, install and run applications and runtimes
flatpak [OPTION...] {COMMAND}
Flatpak is a tool for managing applications and the runtimes
they use. In the Flatpak model, applications can be built and
distributed independently from the host system they are used
@@ -20,7 +20,11 @@
and app/ subdirectories.
System-wide remotes can be statically preconfigured by dropping
- flatpakrepo(5) files into /etc/flatpak/remotes.d/.
+ flatpakrepo(5)
+ files into /usr/share/flatpak/remotes.d/ and
+ /etc/flatpak/remotes.d/. If a file with
+ the same name exists in both, the file under
+ /etc will take precedence.
In addition to the system-wide installation in $prefix/var/lib/flatpak/,
which is always considered the default one unless overridden, more
@@ -52,7 +56,7 @@
which is a better location for non-persistent sources (as it is cleared on reboot). These symlinks
can point to either the directory given to flatpak create-usb which by default
writes to the subpath .ostree/repo, or directly to an ostree repo.
-
The following global options are understood. Individual commands have their own options.
-h, --help@@ -81,7 +85,7 @@ flatpaks, amending the current set of environment variables. This is intended to be used in a systemd environment generator, and should not need to be run manually. -
Commands for managing installed applications and runtimes:
Install an application or a runtime from a remote or bundle.
Update an installed application or runtime. @@ -167,7 +171,7 @@ Print information about a repo.
Commands available inside the sandbox:
Run a command in another sandbox. -
File formats that are used by Flatpak commands:
Reference to a remote for an application or runtime
Reference to a remote @@ -177,10 +181,23 @@ Configuration for an installation location
Information about an application or runtime -
Besides standard environment variables such as XDG_DATA_DIRS and
XDG_DATA_HOME, flatpak is consulting some of its own.
-
FLATPAK_USER_DIR+
FLATPAK_FANCY_OUTPUT
+ May be set to 0 to avoid fancy
+ formatting when outputting to a terminal.
+ This feature is also disabled automatically when
+ standard output is not a terminal,
+ or when G_MESSAGES_DEBUG is set.
+
FLATPAK_TTY_PROGRESS
+ May be set to 1 to enable reporting
+ machine-readable progress to the terminal.
+ This feature is not currently enabled by default
+ because it uses the OSC 9;4 sequence,
+ which some terminal emulators interpret as a
+ popup notification.
+
FLATPAK_USER_DIR
The location of the per-user installation. If this is not set,
$XDG_DATA_HOME/flatpak is used.
FLATPAK_SYSTEM_DIR@@ -201,13 +218,13 @@
FLATPAK_RUN_DIR
The location of flatpak runtime global files. If this is not set,
/run/flatpak is used.
-
Table of Contents
Table of Contents
flatpak-build-bundle — Create a single-file bundle from a local repository
flatpak build-bundle [OPTION...] LOCATION FILENAME NAME [BRANCH]
Creates a single-file named FILENAME
for the application (or runtime) named NAME
in the repository at LOCATION . If
@@ -221,7 +238,7 @@
Unless --oci is used, the format of the bundle file is
that of an ostree static delta (against an empty base) with some flatpak
specific metadata for the application icons and appdata.
-
The following options are understood:
-h, --help+
$ flatpak build-bundle /var/lib/flatpak/repo gnome-calculator.flatpak org.gnome.Calculator stable
$ flatpak build-bundle ~/.local/share/flatpak/repo gnome-calculator.flatpak org.gnome.Calculator stable -
ostree(1), flatpak(1), flatpak-build-init(1), @@ -261,7 +278,7 @@ flatpak-build-finish(1), flatpak-build-import-bundle(1), flatpak-build-update-repo(1) -
flatpak-build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-commit-from [OPTION...] DST-REPO DST-REF...
flatpak-build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-commit-from [OPTION...] DST-REPO DST-REF...
Creates new commits on the DST-REF branch in the DST-REPO , with the contents (and most of the metadata) taken from another @@ -283,7 +300,7 @@ Any deltas that affect the original commit and that match parent commits in the destination repository are copied and rewritten for the new commit id. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--src-repo=SRC-REPOThe (local) repository to pull the source branch from. Defaults to the @@ -342,11 +359,11 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
To revert a commit to the commit before:
$ flatpak build-commit-from --timestamp=NOW --src-ref=app/org.gnome.gedit/x86_64/master^ repo app/org.gnome.gedit/x86_64/master -
ostree(1), flatpak(1), flatpak-build-init(1), @@ -354,7 +371,7 @@ flatpak-build-finish(1), flatpak-build-sign(1), flatpak-build-update-repo(1) -
flatpak-build-export — Create a repository from a build directory
flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]
flatpak-build-export — Create a repository from a build directory
flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]
Creates or updates a repository with an application build. LOCATION is the location of the repository. DIRECTORY must be a @@ -383,7 +400,7 @@
The build-update-repo command should be used to update repository metadata whenever application builds are added to a repository. -
The following options are understood:
-h, --help+
$ flatpak build-export ~/repos/gnome-calculator/ ~/build/gnome-calculator/ org.gnome.Calculator
Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c @@ -457,7 +474,7 @@ Content Total: 1174 Content Written: 1 Content Bytes Written: 305 -
ostree(1), flatpak(1), flatpak-build-init(1), @@ -465,7 +482,7 @@ flatpak-build-finish(1), flatpak-build-sign(1), flatpak-build-update-repo(1) -
flatpak-build-finish — Finalize a build directory
flatpak build-finish [OPTION...] DIRECTORY
flatpak-build-finish — Finalize a build directory
flatpak build-finish [OPTION...] DIRECTORY
Finalizes a build directory, to prepare it for exporting. DIRECTORY is the name of the directory.
@@ -486,7 +503,7 @@
It is an error to run build-finish on a directory that has not been initialized as a build directory, or has already been finalized. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--command=COMMANDThe command to use. If this option is not specified, @@ -529,12 +546,12 @@
--device=DEVICEExpose a device to the application. This updates the [Context] group in the metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, input, usb, kvm, shm, all. This option can be used multiple times.
--nodevice=DEVICEDon't expose a device to the application. This updates the [Context] group in the metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, input, usb, kvm, shm, all. This option can be used multiple times.
--allow=FEATUREAllow access to a specific feature. This updates @@ -603,6 +620,59 @@ This option can be used multiple times.
--remove-policy=SUBSYSTEM.KEY=VALUERemove generic policy option. This option can be used multiple times. +
--usb=TYPE[:DATA]+ Makes USB devices matching the query visible to the + USB portal by adding the query to the application + metadata. This does not have any effect on the + devices exposed in /dev. + TYPE must be one of: all, cls, + dev, vnd. +
all+ Match all devices. +
cls
+ A device class and subclass query. DATA
+ must be in the form of CLASS:SUBCLASS where
+ both CLASS and SUBCLASS
+ must valid 2-digit hexadecimal class id numbers. Alternatively,
+ SUBCLASS may be * to match
+ all subclasses.
+
dev
+ A device product id query. DATA
+ must be a valid 4-character hexadecimal product id
+ number, for example 0a1b. It
+ requires a vnd filter in the query.
+
vnd
+ A device vendor id query. DATA
+ must be a valid 4-character hexadecimal vendor id number
+ greater than zero, for example 0fab.
+
+ It is possible to compose multiple device queries together
+ with the + sign, for example
+ --usb=vnd:0123+dev:4567. The dev
+ filter requires a vnd .
+ Available since 1.15.11.
+
--nousb=TYPE[:DATA]
+ Hides USB devices matching the query from the USB portal by
+ adding the query to the application metadata. Queries hiding
+ devices take precedence over queries making devices visible
+ (see --usb). The syntax is exactly equal to
+ --usb. This does not have any effect on the
+ devices exposed in /dev. Available since 1.15.11.
+
--usb-list-file=FILENAME
+ Adds USB device queries to the application metadata from the file
+ FILE_NAME . The line syntax is exactly
+ equal to --usb. Additionally, if it starts
+ with ! then the query is like for --nousb.
+ Lines sthat starts with # are ignored,
+ like a comment. Comments will not be persisted.
+ Available since 1.15.11.
+
--usb-list=LIST
+ Adds USB device queries to the application metadata from
+ LIST . The syntax is exactly equal to
+ --usb with queries separated by
+ ;. Additionally, if the query starts with
+ ! then the query is like for
+ --nousb. Available since 1.15.11.
--env=VAR=VALUESet an environment variable in the application. This updates the [Environment] group in the metadata. @@ -683,25 +753,25 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
+ $ flatpak build-finish /build/my-app --socket=x11 --share=ipc --usb=vnd:0fd9
Exporting share/applications/gnome-calculator.desktop Exporting share/dbus-1/services/org.gnome.Calculator.SearchProvider.service More than one executable Using gcalccmd as command Please review the exported files and the metadata -
flatpak-build-import-bundle — Import a file bundle into a local repository
flatpak build-import-bundle [OPTION...] LOCATION FILENAME
flatpak-build-import-bundle — Import a file bundle into a local repository
flatpak build-import-bundle [OPTION...] LOCATION FILENAME
Imports a bundle from a file named FILENAME into the repository at LOCATION .
The format of the bundle file is that generated by build-bundle. -
The following options are understood:
-h, --help+
flatpak-build-init — Initialize a build directory
flatpak build-init [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]
flatpak-build-init — Initialize a build directory
flatpak build-init [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]
Initializes a separate build directory. DIRECTORY is the name of the directory. APPNAME is the application id of the app @@ -746,7 +816,7 @@
It is an error to run build-init on a directory that has already been initialized as a build directory. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--arch=ARCHThe architecture to use. See flatpak --supported-arches @@ -790,14 +860,14 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-build-sign — Sign an application or runtime
flatpak build-sign [OPTION...] LOCATION ID [BRANCH]
flatpak-build-sign — Sign an application or runtime
flatpak build-sign [OPTION...] LOCATION ID [BRANCH]
Signs the commit for a specified application or runtime in a local repository. LOCATION is the location of the repository. ID is the name of the application, or @@ -806,7 +876,7 @@
Applications can also be signed during build-export, but it is sometimes useful to add additional signatures later. -
The following options are understood:
-h, --help+
flatpak-build-update-repo — Create a repository from a build directory
flatpak build-update-repo [OPTION...] LOCATION
flatpak-build-update-repo — Create a repository from a build directory
flatpak build-update-repo [OPTION...] LOCATION
Updates repository metadata for the repository at LOCATION . This command generates an OSTree summary file that lists the contents of the repository. @@ -839,7 +909,7 @@ After this command, LOCATION can be used as the repository location for flatpak remote-add, either by exporting it over http, or directly with a file: url. -
The following options are understood:
-h, --help+
flatpak-build — Build in a directory
flatpak build [OPTION...] DIRECTORY [COMMAND [ARG...]]
flatpak-build — Build in a directory
flatpak build [OPTION...] DIRECTORY [COMMAND [ARG...]]
Runs a build command in a directory. DIRECTORY must have been initialized with flatpak build-init.
@@ -917,7 +987,7 @@
are mounted at /app and /var,
respectively. They are writable, and their contents are preserved between
build commands, to allow accumulating build artifacts there.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-v, --verbosePrint debug information during command processing. @@ -956,12 +1026,12 @@
--device=DEVICEExpose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, input, usb, kvm, shm, all. This option can be used multiple times.
--nodevice=DEVICEDon't expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, input, usb, kvm, shm, all. This option can be used multiple times.
--allow=FEATUREAllow access to a specific feature. This updates @@ -1077,14 +1147,14 @@
--log-system-busLog system bus traffic. This can be useful to see what access you need to allow in your D-Bus policy. -
flatpak-config — Manage configuration
flatpak config [OPTION...]
flatpak config [OPTION...] --set KEY VALUE
flatpak config [OPTION...] --unset|--get KEY
flatpak-config — Manage configuration
flatpak config [OPTION...]
flatpak config [OPTION...] --set KEY VALUE
flatpak config [OPTION...] --unset|--get KEY
The flatpak config command shows or modifies the configuration of a flatpak installation. The following keys are supported:
languages@@ -1104,7 +1174,7 @@ flatpak-remote-modify(1). For configuration of individual applications, see flatpak-override(1). -
The following options are understood:
-h, --help+
flatpak-create-usb — Copy apps and/or runtimes onto removable media.
flatpak create-usb [OPTION...] MOUNT-PATH REF...
flatpak-create-usb — Copy apps and/or runtimes onto removable media.
flatpak create-usb [OPTION...] MOUNT-PATH REF...
Copies the specified apps and/or runtimes REF s onto the removable media mounted at MOUNT-PATH , along with all the dependencies and metadata needed for installing them. This is one way of transferring flatpaks @@ -1178,7 +1248,7 @@ options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. -
The following options are understood:
-h, --help+
flatpak-document-export — Export a file to a sandboxed application
flatpak document-export [OPTION...] FILE
flatpak-document-export — Export a file to a sandboxed application
flatpak document-export [OPTION...] FILE
Creates a document id for a local file that can be exposed to sandboxed applications, allowing them access to files that they would not otherwise see. The exported files are exposed in a @@ -1222,7 +1292,7 @@ This command also lets you modify the per-application permissions of the documents, granting or revoking access to the file on a per-application basis. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --uniqueDon't reuse an existing document id for the file. This makes it safe to later remove the @@ -1258,29 +1328,29 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-document-info — Show information about exported files
flatpak document-info [OPTION...] FILE
flatpak-document-info — Show information about exported files
flatpak document-info [OPTION...] FILE
Shows information about an exported file, such as the document id, the fuse path, the original location in the filesystem, and the per-application permissions.
FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/,
or a file anywhere else.
-
The following options are understood:
-h, --help+
flatpak-documents — List exported files
flatpak documents [OPTION...] [APPID]
Lists exported files, with their document id and the full path to their origin. If an APPID is specified, only the files exported to this app are listed. -
flatpak-document-unexport — Stop exporting a file
flatpak document-unexport [OPTION...] FILE
flatpak-document-unexport — Stop exporting a file
flatpak document-unexport [OPTION...] FILE
Removes the document id for the file from the document portal. This will make the document unavailable to all sandboxed applications. -
The following options are understood:
--doc-id+
The following options are understood:
--doc-idInterpret FILE as a document ID rather than a file path. This is useful for example when the file has been deleted. @@ -1322,12 +1392,12 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-enter — Enter an application or runtime's sandbox
flatpak enter [OPTION...] INSTANCE COMMAND [ARG...]
flatpak-enter — Enter an application or runtime's sandbox
flatpak enter [OPTION...] INSTANCE COMMAND [ARG...]
Enter a running sandbox.
INSTANCE must be either the pid of a process running @@ -1343,19 +1413,19 @@
This command works as a regular user if the system support unprivileged user namespace. If that is not available you need to run run it like: sudo -E flatpak enter. -
flatpak-history — Show history
flatpak history [OPTION...]
Shows changes to the flatpak installations on the system. This includes installs, updates and removals of applications and runtimes.
@@ -1365,7 +1435,7 @@ The information for the history command is taken from the systemd journal, and can also be accessed using e.g. journalctl MESSAGE_ID=c7b39b1e006b464599465e105b361485 -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userShow changes to the user installation. @@ -1398,7 +1468,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
flatpak-info — Show information about an installed application or runtime
flatpak info [OPTION...] NAME [BRANCH]
flatpak-info — Show information about an installed application or runtime
flatpak info [OPTION...] NAME [BRANCH]
Show info about an installed application or runtime.
By default, the output is formatted in a friendly format.
@@ -1458,7 +1528,7 @@
By default, both per-user and system-wide installations are queried.
Use the --user, --system
or --installation options to change this.
-
The following options are understood:
-h, --help+
flatpak-install — Install an application or runtime
flatpak install [OPTION...] [REMOTE] REF...
flatpak install [OPTION...] [--from|--bundle] LOCATION
flatpak-install — Install an application or runtime
flatpak install [OPTION...] [REMOTE] REF...
flatpak install [OPTION...] [--from|--bundle] LOCATION
Installs an application or runtime. The primary way to
install is to specify a REMOTE
name as the source and one ore more REF s to specify the
@@ -1556,7 +1626,7 @@
Unless overridden with the --user or the --installation
option, this command installs the application or runtime in the default system-wide
installation.
-
The following options are understood:
-h, --help+
$ flatpak install gedit
$ flatpak install flathub org.gnome.gedit @@ -1635,7 +1705,7 @@ $ flatpak --user install https://flathub.org/repo/appstream/org.gnome.gedit.flatpakref
$ flatpak --system install org.gnome.gedit.flatpakref -
flatpak(1), flatpak-update(1), flatpak-list(1), @@ -1643,26 +1713,26 @@ flatpakref(5), flatpak-make-current(1), ostree-find-remotes(1) -
flatpak-kill — Stop a running application
flatpak kill INSTANCE
Stop a running Flatpak instance.
INSTANCE can be either the numeric instance ID or the application ID of a running Flatpak. You can use flatpak ps to find the instance IDs of running flatpaks. -
flatpak-list — List installed applications and/or runtimes
flatpak list [OPTION...]
Lists the names of the installed applications and runtimes.
By default, both apps and runtimes are shown, but you can @@ -1675,7 +1745,7 @@
The list command can also be used to find installed apps that
use a certain runtime, with the --app-runtime option.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userList per-user installations. @@ -1710,7 +1780,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
The following fields are understood by the --columns option:
Show the name
Show the description @@ -1744,7 +1814,7 @@ Show the list of available columns
Note that field names can be abbreviated to a unique prefix. -
flatpak-make-current — Make a specific version of an app current
flatpak make-current [OPTION...] APP BRANCH
flatpak-make-current — Make a specific version of an app current
flatpak make-current [OPTION...] APP BRANCH
Makes a particular branch of an application current. Only the current branch of an app has its exported files (such as desktop files and icons) made visible to the host. @@ -1766,7 +1836,7 @@
Unless overridden with the --user or --installation options, this command
changes the default system-wide installation.
-
The following options are understood:
-h, --help+
flatpak-override — Override application requirements
flatpak override [OPTION...] [APP]
Overrides the application specified runtime requirements. This can be used to grant a sandboxed application more or less resources than it requested.
@@ -1808,7 +1878,7 @@
Unless overridden with the --user or --installation options, this command
changes the default system-wide installation.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userUpdate a per-user installation. @@ -1844,12 +1914,12 @@
--device=DEVICEExpose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, input, usb, kvm, shm, all. This option can be used multiple times.
--nodevice=DEVICEDon't expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, input, usb, kvm, shm, all. This option can be used multiple times.
--allow=FEATUREAllow access to a specific feature. This updates @@ -1990,14 +2060,14 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-permission-remove — Remove permissions
flatpak permission-remove [OPTION...] TABLE ID [APP_ID]
flatpak-permission-remove — Remove permissions
flatpak permission-remove [OPTION...] TABLE ID [APP_ID]
Removes an entry for the object with id ID to the permission store table TABLE . The ID must be in a suitable format for the table. If APP_ID is specified, only @@ -2007,19 +2077,19 @@ Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. -
flatpak-permissions — List permissions
flatpak permissions [OPTION...] [TABLE] [ID]
Lists dynamic permissions which are stored in the Flatpak permission store.
@@ -2033,19 +2103,19 @@ Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. -
flatpak-permission-show — Show permissions
flatpak permission-show [OPTION...] APP_ID
Lists dynamic permissions for the given app which are stored in the Flatpak permission store.
@@ -2059,19 +2129,19 @@ Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. -
flatpak-permission-reset — Reset permissions
flatpak permission-reset [OPTION...] APP_ID
flatpak permission-reset [OPTION...] --all
flatpak-permission-reset — Reset permissions
flatpak permission-reset [OPTION...] APP_ID
flatpak permission-reset [OPTION...] --all
Removes all permissions for the given app from the Flatpak permission store.
@@ -2079,7 +2149,7 @@ Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. -
The following options are understood:
--all+
flatpak-permission-set — Set permissions
flatpak permission-set [OPTION...] TABLE ID APP_ID [PERMISSION...]
flatpak-permission-set — Set permissions
flatpak permission-set [OPTION...] TABLE ID APP_ID [PERMISSION...]
Set the permissions for an application in an entry in the permission store. The entry is identified by TABLE and ID, the application is identified by APP_ID. The PERMISSION strings must be in a format suitable for the table. @@ -2102,7 +2172,7 @@ Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. -
The following options are understood:
-h, --help+
flatpak-ps — Enumerate running instances
flatpak ps [OPTION...]
Lists useful information about running Flatpak instances.
To see full details of a running instance, you can open the file
/run/user/$UID/.flatpak/$INSTANCE/info, where $INSTANCE is the instance
ID reported by flatpak ps.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-v, --verbosePrint debug information during command processing. @@ -2137,7 +2207,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
flatpak-remote-add — Add a remote repository
flatpak remote-add [OPTION...] NAME LOCATION
flatpak-remote-add — Add a remote repository
flatpak remote-add [OPTION...] NAME LOCATION
Adds a remote repository to the flatpak repository configuration. NAME is the name for the new remote, and LOCATION is a url or pathname. @@ -2183,7 +2253,7 @@
Unless overridden with the --user or --installation options, this command
changes the default system-wide installation.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--fromAssume the URI is a .flatpakrepo file rather than the repository itself. This is enabled @@ -2268,17 +2338,17 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-remote-delete — Delete a remote repository
flatpak remote-delete [OPTION...] NAME
flatpak-remote-delete — Delete a remote repository
flatpak remote-delete [OPTION...] NAME
Removes a remote repository from the flatpak repository configuration. NAME is the name of an existing remote.
@@ -2286,7 +2356,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
flatpak-remote-info — Show information about an application or runtime in a remote
flatpak remote-info [OPTION...] REMOTE REF
flatpak-remote-info — Show information about an application or runtime in a remote
flatpak remote-info [OPTION...] REMOTE REF
Shows information about the runtime or application REF from the remote repository with the name REMOTE . You can find all configured remote repositories with flatpak remotes. @@ -2323,7 +2393,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
flatpak-remote-ls — Show available runtimes and applications
flatpak remote-ls [OPTION...] [REMOTE]
flatpak-remote-ls — Show available runtimes and applications
flatpak remote-ls [OPTION...] [REMOTE]
Shows runtimes and applications that are available in the remote repository with the name REMOTE , or all remotes if one isn't specified. You can find all configured @@ -2393,7 +2463,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userUse the per-user configuration. @@ -2435,7 +2505,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
The following fields are understood by the --columns option:
Show the name
Show the application description @@ -2467,7 +2537,7 @@ Show the list of available columns
Note that field names can be abbreviated to a unique prefix. -
flatpak-remote-modify — Modify a remote repository
flatpak remote-modify [OPTION...] NAME
flatpak-remote-modify — Modify a remote repository
flatpak remote-modify [OPTION...] NAME
Modifies options for an existing remote repository in the flatpak repository configuration. NAME is the name for the remote.
@@ -2489,7 +2559,7 @@ this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -
The following options are understood:
-h, --help+
flatpak-remotes — List remote repositories
flatpak remotes [OPTION...]
Lists the known remote repositories, in priority order.
By default, both per-user and system-wide installations
are shown. Use the --user, --system or --installation
options to change this.
-
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userShow the per-user configuration. @@ -2612,7 +2682,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
The following fields are understood by the --columns option:
Show the name of the remote
Show the title of the remote @@ -2640,15 +2710,15 @@ Show the list of available columns
Note that field names can be abbreviated to a unique prefix. -
flatpak-repair — Repair a flatpak installation
flatpak repair [OPTION...]
Repair a flatpak installation by pruning and reinstalling invalid objects. The repair command does all of the following:
Scan all locally available refs, removing any that don't correspond to a deployed ref. @@ -2665,7 +2735,7 @@ operate on the system installation.
An alternative command for repairing OSTree repositories is ostree fsck. -
The following options are understood:
-h, --help+
flatpak-repo — Show information about a local repository
flatpak repo [OPTION...] LOCATION
flatpak-repo — Show information about a local repository
flatpak repo [OPTION...] LOCATION
Show information about a local repository.
If you need to modify a local repository, see the flatpak build-update-repo command, or use the ostree tool. -
The following options are understood:
-h, --help+
flatpak-run — Run an application or open a shell in a runtime
flatpak run [OPTION...] REF [ARG...]
flatpak-run — Run an application or open a shell in a runtime
flatpak run [OPTION...] REF [ARG...]
If REF names an installed application,
Flatpak runs the application in a sandboxed environment. Extra
arguments are passed on to the application. The current branch and arch of
@@ -2758,7 +2828,7 @@
as well as the --env option. Apart from that, Flatpak always
unsets or overrides the following variables, since their session values
are likely to interfere with the functioning of the sandbox:
-
| PATH |
| LD_LIBRARY_PATH |
| LD_PRELOAD |
| LD_AUDIT |
| XDG_CONFIG_DIRS |
| XDG_DATA_DIRS |
| XDG_RUNTIME_DIR |
| SHELL |
| TEMP |
| TEMPDIR |
| TMP |
| TMPDIR |
| PYTHONPATH |
| PERLLIB |
| PERL5LIB |
| XCURSOR_PATH |
| KRB5CCNAME |
| XKB_CONFIG_ROOT |
| GIO_EXTRA_MODULES |
| GDK_BACKEND |
| VK_ADD_DRIVER_FILES |
| VK_ADD_LAYER_PATH |
| VK_DRIVER_FILES |
| VK_ICD_FILENAMES |
| VK_LAYER_PATH |
| __EGL_EXTERNAL_PLATFORM_CONFIG_DIRS |
| __EGL_EXTERNAL_PLATFORM_CONFIG_FILENAMES |
| __EGL_VENDOR_LIBRARY_DIRS |
| __EGL_VENDOR_LIBRARY_FILENAMES |
+
| PATH |
| LD_LIBRARY_PATH |
| LD_PRELOAD |
| LD_AUDIT |
| XDG_CONFIG_DIRS |
| XDG_DATA_DIRS |
| SHELL |
| TEMP |
| TEMPDIR |
| TMP |
| TMPDIR |
| XDG_RUNTIME_DIR |
| container |
| TZDIR |
| PYTHONPATH |
| PERLLIB |
| PERL5LIB |
| XCURSOR_PATH |
| GST_PLUGIN_PATH_1_0 |
| GST_REGISTRY |
| GST_REGISTRY_1_0 |
| GST_PLUGIN_PATH |
| GST_PLUGIN_SYSTEM_PATH |
| GST_PLUGIN_SCANNER |
| GST_PLUGIN_SCANNER_1_0 |
| GST_PLUGIN_SYSTEM_PATH_1_0 |
| GST_PRESET_PATH |
| GST_PTP_HELPER |
| GST_PTP_HELPER_1_0 |
| GST_INSTALL_PLUGINS_HELPER |
| KRB5CCNAME |
| XKB_CONFIG_ROOT |
| GIO_EXTRA_MODULES |
| GDK_BACKEND |
| VK_ADD_DRIVER_FILES |
| VK_ADD_LAYER_PATH |
| VK_DRIVER_FILES |
| VK_ICD_FILENAMES |
| VK_LAYER_PATH |
| __EGL_EXTERNAL_PLATFORM_CONFIG_DIRS |
| __EGL_EXTERNAL_PLATFORM_CONFIG_FILENAMES |
| __EGL_VENDOR_LIBRARY_DIRS |
| __EGL_VENDOR_LIBRARY_FILENAMES |
Also several environment variables with the prefix "GST_" that are used by gstreamer are unset (since Flatpak 1.12.5).
@@ -2785,7 +2855,7 @@ If parental controls support is enabled, flatpak will check the current user’s parental controls settings, and will refuse to run an app if it is blocklisted for the current user. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-u, --userLook for the application and runtime in per-user installations. @@ -2846,12 +2916,12 @@
--device=DEVICEExpose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, usb, input, kvm, shm, all. This option can be used multiple times.
--nodevice=DEVICEDon't expose a device to the application. This overrides to the Context section from the application metadata. - DEVICE must be one of: dri, input, kvm, shm, all. + DEVICE must be one of: dri, usb, input, kvm, shm, all. This option can be used multiple times.
--allow=FEATUREAllow access to a specific feature. This overrides to @@ -2922,6 +2992,39 @@ This option can be used multiple times.
--remove-policy=SUBSYSTEM.KEY=VALUERemove generic policy option. This option can be used multiple times. +
--usb=TYPE[:DATA]+ Adds a USB device query to the application metadata. This + allows device enumeration and usage by the USB portal. + TYPE must be one of: all, cls, dev, vnd. +
all+ Match all devices. +
cls
+ A device class and subclass query. DATA
+ must be in the form of CLASS:SUBCLASS where
+ both CLASS and SUBCLASS
+ must be a valid 2-digit hexadecimal class id number. Alternatively,
+ SUBCLASS may be * to match
+ all subclasses.
+
dev
+ A device product id query. DATA
+ must be a valid 4-digit hexadecimal product id number,
+ for example 0a1b. It requires a
+ vnd filter in the query.
+
vnd
+ A device vendor id query. DATA
+ must be a valid 4-digit hexadecimal vendor id number
+ greater than zero, for example 0fab.
+
+ It is possible to compose multiple device queries together
+ with the + sign, for example
+ --usb=vnd:0123+dev:4567. The dev
+ filter requires a vnd .
+ Available since 1.15.11.
+
--nousb=VENDOR_ID:PRODUCT_ID
+ Adds a blocking USB device query to the application metadata. Blocked
+ devices take precedence over allowed devices. The syntax is exactly
+ equal to --usb.
+ Available since 1.15.11.
--env=VAR=VALUESet an environment variable in the application. This overrides to the Context section from the application metadata. @@ -2973,6 +3076,11 @@ If NAME ends with .*, it allows the application to talk to all matching names. This overrides to the Context section from the application metadata. This option can be used multiple times. +
--a11y-own-name=NAME+ Allow the application to own the well known name NAME on the a11y bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times.
--persist=FILENAME
If the application doesn't have access to the real homedir, make the (homedir-relative) path
FILENAME a bind mount to the corresponding path in the per-application directory,
@@ -3051,22 +3159,24 @@
This option will usually only be useful if it is
combined with --app-path= and
--env=LD_LIBRARY_PATH=.
- ...
flatpak-search — Search for applications and runtimes
flatpak search TEXT
Searches for applications and runtimes matching TEXT . Note that this uses appstream data that can be updated with the flatpak update command. The appstream data is updated automatically only if it's at least a day old. -
The following options are understood:
-u, --user+
The following options are understood:
-u, --userOnly search through remotes in the per-user installation.
--systemOnly search through remotes in the default system-wide installation. @@ -3087,7 +3197,7 @@
Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. -
flatpak-uninstall — Uninstall an application or runtime
flatpak uninstall [OPTION...] [REF...]
flatpak-uninstall — Uninstall an application or runtime
flatpak uninstall [OPTION...] [REF...]
Uninstalls an application or runtime. REF is a reference to the application or runtime to uninstall.
@@ -3140,7 +3250,7 @@ options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--keep-refKeep the ref for the application and the objects belonging to it @@ -3183,9 +3293,9 @@ Print debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing. -
flatpak-update — Update an application or runtime
flatpak update [OPTION...] [REF...]
flatpak update [OPTION...] --appstream [REMOTE]
flatpak-update — Update an application or runtime
flatpak update [OPTION...] [REF...]
flatpak update [OPTION...] --appstream [REMOTE]
Updates applications and runtimes. REF is a reference to the application or runtime to update. If no REF is given, everything is updated, as well as appstream info for all remotes. @@ -3224,7 +3334,7 @@
Unless overridden with the --user, --system or --installation option, this command updates
any matching refs in the standard system-wide installation and the per-user one.
-
The following options are understood:
-h, --help+
flatpak-spawn — Run commands in a sandbox
flatpak-spawn [OPTION...] COMMAND [ARGUMENT...]
flatpak-spawn — Run commands in a sandbox
flatpak-spawn [OPTION...] COMMAND [ARGUMENT...]
Unlike other flatpak commands, flatpak-spawn is available
to applications inside the sandbox. It runs COMMAND
outside the sandbox: either in another sandbox, or on the host.
@@ -3292,7 +3402,7 @@
uses the Flatpak portal to create a copy of the sandbox it was called from,
optionally using tighter permissions and optionally the latest version of the
app and runtime (see --latest-version).
-
The following options are understood:
-h, --help+
Table of Contents
Table of Contents
flatpakrepo — Reference to a remote
Flatpak uses flatpakrepo files to share information about remotes.
The flatpakrepo file contains enough information
to add the remote. Use the flatpak remote-add --from
@@ -3355,13 +3465,17 @@
The filename extension commonly used for flatpakrepo files is .flatpakrepo.
- flatpakrepo files can also be placed in /etc/flatpak/remotes.d/
- to statically preconfigure system-wide remotes. Such files must use the
- .flatpakrepo extension.
-
+ flatpakrepo files can also be placed in
+ /usr/share/flatpak/remotes.d/ and
+ /etc/flatpak/remotes.d/
+ to statically preconfigure system-wide remotes. Such files must use the
+ .flatpakrepo extension. If a file with the
+ same name exists in both, the file under /etc will
+ take precedence.
+
The flatpakrepo file is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the information is contained in the [Flatpak Repo] group.
The following keys can be present in this group: @@ -3381,17 +3495,17 @@ It is recommended to use this key over DeployCollectionID or CollectionID because only newer clients (Flatpak 1.12.8 or later) pay attention to it (and older clients don't handle collection IDs properly). -
DeployCollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
CollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
[Flatpak Repo] Title=gedit Url=http://sdk.gnome.org/repo-apps/ GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= DeployCollectionID=org.gnome.Apps -
flatpakref — Reference to a remote for an application or runtime
Flatpak uses flatpakref files to share information about a remote for
a single application. The flatpakref file contains
enough information to add the remote and install the application.
@@ -3403,10 +3517,10 @@
The filename extension commonly used for flatpakref files is .flatpakref.
A flatpakref file can also refer to a remote for a runtime. -
The flatpakref file is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the information is contained in the [Flatpak Ref] group.
The following keys can be present in this group: @@ -3419,7 +3533,7 @@ collection IDs properly).
DeployCollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
CollectionID (string)This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.
IsRuntime (boolean)Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.
GPGKey (string)The base64-encoded gpg key for the remote.
RuntimeRepo (string)The url for a .flatpakrepo file for the remote where the runtime can be found. Note that if the runtime is available in the remote providing the app, that remote may be - used instead but the one specified by this option will still be added.
SuggestRemoteName (string)A suggested name for the remote.
[Flatpak Ref] Title=gedit Name=org.gnome.gedit @@ -3428,11 +3542,11 @@ IsRuntime=false GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= DeployCollectionID=org.gnome.Apps -
flatpak-installation — Configuration for an installation location
flatpak can operate in system-wide or per-user mode. The system-wide data
is located in $prefix/var/lib/flatpak/, and the per-user data is in
$HOME/.local/share/flatpak/.
@@ -3440,20 +3554,20 @@
In addition to the default installation locations, more system-wide installations
can be defined via configuration files /etc/flatpak/installations.d/,
which must have the .conf extension and follow the format described below.
-
The installation config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the configuration for the the installation location with name NAME is contained in the [Installation "NAME"] group.
The following keys are recognized: -
Path (string)The path for this installation. This key is mandatory.
DisplayName (string)The name to use when showing this installation in the UI.
Priority (integer)A priority for this installation.
StorageType (string)The type of storage used for this installation. Possible values include: network, mmc, sdcard, harddisk.
+
Path(string)The path for this installation. This key is mandatory.
DisplayName(string)The name to use when showing this installation in the UI.
Priority(integer)A priority for this installation.
StorageType(string)The type of storage used for this installation. Possible values include: network, mmc, sdcard, harddisk.
flatpak-metadata — Information about an application or runtime
Flatpak uses metadata files to describe applications and runtimes.
The metadata file for a deployed application or
runtime is placed in the toplevel deploy directory. For example, the
@@ -3470,7 +3584,7 @@
For compatibility with older Flatpak versions,
/run/user/$UID/flatpak-info is a symbolic
link to the same file.
-
The metadata file is using the same .ini file format that is used for systemd unit files or application .desktop files.
@@ -3521,7 +3635,9 @@ find sockets that are not in a fixed location. Available since 0.3.
devices (list)- List of devices to make available in the sandbox. + List of devices to make available in the sandbox. This + just expose the devices nodes, it doesn't grant any + permission that the user doesn't already have. Possible values:
dri
Graphics direct rendering
@@ -3531,6 +3647,11 @@
Input devices
(/dev/input).
Available since 1.15.6.
+
usb
+ USB device bus
+ (all device nodes below
+ /dev/bus/usb).
+ Available since 1.15.11.
kvm
Virtualization
(/dev/kvm).
@@ -4085,7 +4206,23 @@
to the value. They are not otherwise parsed by Flatpak.
Available since 0.6.13.
-
+ USB devices can be enumerable or hidden by the USB portal as specified + by the keys in this group. The vendor and product ids are validated + by Flatpak, but aren't otherwise used or parsed. + This merely grant the permission to enumerate USB device for use by the + portal. This does give access to the devices. + Available since 1.15.11. +
enumerable-devices (string list)+ List of enumerable USB devices. Each element is the same + syntax the arguments to `--usb`. + Available since 1.15.11. +
hidden-devices (string list)+ List of hidden USB devices, i.e. to remove the enumarable + devices list. Each element is the same syntax the arguments + to `--nousb`. Hidden devices take precedence over enumerable + devices. Available since 1.15.11. +
[Application] name=org.gnome.Calculator runtime=org.gnome.Platform/x86_64/3.20 @@ -4103,17 +4240,21 @@ [Environment] DCONF_USER_CONFIG_DIR=.config/dconf +[USB Devices] +enumerable-devices=0fd9:*; +hidden-devices=0fd9:0063; + [Extension org.gnome.Calculator.Locale] directory=share/runtime/locale subdirectories=true [Extension org.gnome.Calculator.Debug] directory=lib/debug -
flatpak-remote — Configuration for a remote
Flatpak stores information about configured remotes for an installation location in
$installation/repo/config. For example, the remotes for the
default system-wide installation are in
@@ -4124,11 +4265,15 @@
flatpak remote-modify command should be used to change properties of remotes.
System-wide remotes can be statically preconfigured by dropping
- flatpakrepo(5) files into /etc/flatpak/remotes.d/.
-
+ flatpakrepo(5)
+ files into /usr/share/flatpak/remotes.d/ and
+ /etc/flatpak/remotes.d/. Ifa file with
+ the same name exists in both, the file under
+ /etc will take precedence.
+
The remote config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
All the configuration for the the remote with name NAME is contained in the [remote "NAME"] group.
@@ -4143,7 +4288,7 @@
xa.disable (boolean)Whether the remote is disabled. Defaults to false.
xa.prio (integer)The priority for the remote. This is used when listing remotes, and when searching them for the runtime needed by an app. The remote providing the app is searched for its runtime before others with equal priority. Defaults to 1.
xa.noenumerate (boolean)Whether this remote should be ignored when presenting available apps/runtimes, - or when searching for a runtime dependency. Defaults to false.
xa.nodeps (boolean)Whether this remote should be excluded when searching for dependencies. Defaults to false.
xa.title (string)An optional title to use when presenting this remote in a UI.
xa.title-is-set (boolean)This key is set to true if xa.title has been explicitly set.
xa.comment (string)An optional single-line comment to use when presenting this remote in a UI.
xa.comment-is-set (boolean)This key is set to true if xa.comment has been explicitly set.
xa.description (string)An optional full-paragraph of text to use when presenting this remote in a UI.
xa.description-is-set (boolean)This key is set to true if xa.description has been explicitly set.
xa.homepage (string)An optional URL that points to a website for this repository to use when presenting this remote in a UI.
xa.homepage-is-set (boolean)This key is set to true if xa.homepage has been explicitly set.
xa.icon (string)An optional URL that points to an icon for this repository to use when presenting this remote in a UI.
xa.icon-is-set (boolean)This key is set to true if xa.icon has been explicitly set.
xa.default-branch (string)The default branch to use when installing from this remote.
xa.default-branch-is-set (boolean)This key is set to true if xa.default-branch has been explicitly set.
xa.main-ref (string)The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.
+ or when searching for a runtime dependency. Defaults to false.
xa.nodeps (boolean)Whether this remote should be excluded when searching for dependencies. Defaults to false.
xa.title (string)An optional title to use when presenting this remote in a UI.
xa.title-is-set (boolean)This key is set to true if xa.title has been explicitly set.
xa.comment (string)An optional single-line comment to use when presenting this remote in a UI.
xa.comment-is-set (boolean)This key is set to true if xa.comment has been explicitly set.
xa.description (string)An optional full-paragraph of text to use when presenting this remote in a UI.
xa.description-is-set (boolean)This key is set to true if xa.description has been explicitly set.
xa.homepage (string)An optional URL that points to a website for this repository to use when presenting this remote in a UI.
xa.homepage-is-set (boolean)This key is set to true if xa.homepage has been explicitly set.
xa.icon (string)An optional URL that points to an icon for this repository to use when presenting this remote in a UI.
xa.icon-is-set (boolean)This key is set to true if xa.icon has been explicitly set.
xa.default-branch (string)The default branch to use when installing from this remote.
xa.default-branch-is-set (boolean)This key is set to true if xa.default-branch has been explicitly set.
xa.main-ref (string)The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.