Flatpak Command Reference

Show help options and exit.

Show debug information during command processing. Use -vv for more detail.

Show OSTree debug information during command processing.

Print version information and exit.

Print the default arch and exit.

Print the supported arches in priority order and exit.

Print the list of active gl drivers and exit.

Print paths of system installations and exit.

Install an application or a runtime from a remote or bundle.

Update an installed application or runtime.

Uninstall an installed application or runtime.

Mask out updates and automatic installation

List installed applications and/or runtimes.

Show information for an installed application or runtime.

Show history.

Manage flatpak configuration.

Repair flatpak installation.

Copy apps and/or runtimes onto removable media.

Search for applications and runtimes.

Run an application.

Stop a running application.

Override permissions for an application.

Specify the default version to run.

Enter the namespace of a running application.

Grant an application access to a specific file.

Revoke access to a specific file.

Show information about a specific file.

List exported files.

Remove item from permission store.

List permissions.

Show app permissions.

Reset app permissions.

List all configured remote repositories.

Add a new remote repository.

Modify properties of a configured remote repository.

Delete a configured remote repository.

List contents of a configured remote repository.

Show information about a ref in a configured remote repository.

Initialize a build directory.

Run a build command in a build directory.

Finalizes a build directory for export.

Export a build directory to a repository.

Create a bundle file from a ref in a local repository.

Import a file bundle into a local repository.

Sign an application or runtime after its been exported.

Update the summary file in a repository.

Create a new commit based on an existing ref.

Print information about a repo.

Run a command in another sandbox.

Reference to a remote for an application or runtime

Reference to a remote

Configuration for a remote

Configuration for an installation location

Information about an application or runtime

The location of the per-user installation. If this is not set, $XDG_DATA_HOME/flatpak is used.

The location of the default system-wide installation. If this is not set, /var/lib/flatpak is used (unless overridden at build time by --localstatedir or --with-system-install-dir).

The location where temporary child repositories will be created during pulls into the system-wide installation. If this is not set, a directory in /var/tmp/ is used. This is useful because it is more likely to be on the same filesystem as the system repository (thus increasing the chances for e.g. reflink copying), and we can avoid filling the user's home directory with temporary data.

The location of flatpak site configuration. If this is not set, /etc/flatpak is used (unless overridden at build time by --sysconfdir).

Show help options and exit.

Export a runtime instead of an application.

The arch to create a bundle for. See flatpak --supported-arches for architectures supported by the host.

The URL for the repository from which the application can be updated. Installing the bundle will automatically configure a remote for this URL.

The URL for a .flatpakrepo file that contains the information about the repository that supplies the runtimes required by the app.

Add the GPG key from FILE (use - for stdin).

GPG Homedir to use when looking for keyrings.

The OSTree commit to create a delta bundle from.

Export to an OCI image instead of a Flatpak bundle.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

The (local) repository to pull the source branch from. Defaults to the destination repository.

The branch to use as the source for the new commit. Defaults to the same as the destination ref, which is useful only if a different source repo has been specified.

Add an extra collection-ref binding for this collection, in addition to whatever would normally be added due to the destination repository collection id. This option can be used multiple times.

The source repostory is not trusted, all objects are copied (not hardlinked) and all checksums are verified.

One line subject for the commit message. If not specified, will be taken from the source commit.

Full description for the commit message. If not specified, will be taken from the source commit.

Update the appstream branch after the build.

Don't update the summary file after the new commit is added. This means the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the summary.

Create new commit even if the content didn't change from the existing branch head.

Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories.

Sign the commit with this GPG key. This option can be used multiple times.

GPG Homedir to use when looking for keyrings

Mark build as end-of-life

Mark new refs as end-of-life. Unlike --end-of-life, this one takes an ID that supercedes the current one. By the user's request, the application data may be preserved for the new application. Note, this is actually a prefix match, so if you say org.the.app=org.new.app, then something like org.the.app.Locale will be rebased to org.new.app.Locale.

Override the timestamp of the commit. Use an ISO 8601 formatted date, or NOW for the current time

Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

One line subject for the commit message.

Full description for the commit message.

Set as the collection ID of the repository. Setting a globally unique collection ID allows the apps in the repository to be shared over peer to peer systems without needing further configuration. If exporting to an existing repository, the collection ID must match the existing configured collection ID for that repository.

Specify the architecture component of the branch to export. Only host compatible architectures can be specified; see flatpak --supported-arches for valid values.

Exclude files matching PATTERN from the commit. This option can be used multiple times.

Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. This option can be used multiple times.

Use the specified filename as metadata in the exported app instead of the default file (called metadata). This is useful if you want to commit multiple things from a single build tree, typically used in combination with --files and --exclude.

Use the files in the specified subdirectory as the file contents, rather than the regular files directory.

Use the specified ISO 8601 formatted date or NOW, for the current time, in the commit metadata and, if --update-appstream is used, the appstream data.

Mark the build as end-of-life. REASON is a message that may be shown to users installing this build.

Mark the build as end-of-life. Unlike --end-of-life, this one takes an ID that supercedes the current one. By the user's request, the application data may be preserved for the new application.

Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories.

Update the appstream branch after the build.

Don't update the summary file after the new commit is added. This means the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the summary.

Sign the commit with this GPG key. This option can be used multiple times.

GPG Homedir to use when looking for keyrings

Export a runtime instead of an app (this uses the usr subdir as files).

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

The command to use. If this option is not specified, the first executable found in files/bin is used.

Note that the command is used when the application is run via flatpak run, and does not affect what gets executed when the application is run in other ways, e.g. via the desktop file or D-Bus activation.

Require this version of later of flatpak to install/update to this build.

Share a subsystem with the host session. This updates the [Context] group in the metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Don't share a subsystem with the host session. This updates the [Context] group in the metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Expose a well-known socket to the application. This updates the [Context] group in the metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

The fallback-x11 option makes the X11 socket available only if there is no Wayland socket. This option was introduced in 0.11.3. To support older Flatpak releases, specify both x11 and fallback-x11. The fallback-x11 option takes precedence when both are supported.

Don't expose a well known socket to the application. This updates the [Context] group in the metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Expose a device to the application. This updates the [Context] group in the metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Don't expose a device to the application. This updates the [Context] group in the metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Allow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times.

The devel feature allows the application to access certain syscalls such as ptrace(), and perf_event_open().

The multiarch feature allows the application to execute programs compiled for an ABI other than the one supported natively by the system. For example, for the x86_64 architecture, 32-bit x86 binaries will be allowed as well.

The bluetooth feature allows the application to use bluetooth (AF_BLUETOOTH) sockets. Note, for bluetooth to fully work you must also have network access.

The canbus feature allows the application to use canbus (AF_CAN) sockets. Note, for this work you must also have network access.

Disallow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times.

Allow the application access to a subset of the filesystem. This updates the [Context] group in the metadata. FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times.

Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times.

Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata:

[Policy subsystem]
key=v1;v2;

This option can be used multiple times.

Remove generic policy option. This option can be used multiple times.

Set an environment variable in the application. This updates the [Environment] group in the metadata. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to own the well known name NAME on the session bus. If NAME ends with .*, it allows the application to own all matching names. This updates the [Session Bus Policy] group in the metadata. This option can be used multiple times.

Allow the application to talk to the well known name NAME on the session bus. If NAME ends with .*, it allows the application to talk to all matching names. This updates the [Session Bus Policy] group in the metadata. This option can be used multiple times.

Allow the application to own the well known name NAME on the system bus. If NAME ends with .*, it allows the application to own all matching names. This updates the [System Bus Policy] group in the metadata. This option can be used multiple times.

Allow the application to talk to the well known name NAME on the system bus. If NAME ends with .*, it allows the application to talk to all matching names. This updates the [System Bus Policy] group in the metadata. This option can be used multiple times.

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, allowing that location to be used for persistent data. This updates the [Context] group in the metadata. This option can be used multiple times.

Change the runtime or sdk used by the app to the specified partial ref. Unspecified parts of the ref are taken from the old values or defaults.

Set a generic key in the metadata file. If value is left out it will be set to "true".

Add extension point info. See the documentation for flatpak-metadata(5) for the possible values of VARIABLE and VALUE.

Remove extension point info.

Set the priority (library override order) of the extension point. Only useful for extensions. 0 is the default, and higher value means higher priority.

Adds information about extra data uris to the app. These will be downloaded and verified by the client when the app is installed and placed in the /app/extra directory. You can also supply an /app/bin/apply_extra script that will be run after the files are downloaded.

Don't look for exports in the build.

Don't inherit runtime permissions in the app.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Override the ref specified in the bundle.

Import an OCI image instead of a Flatpak bundle.

Update the appstream branch after the build.

Don't update the summary file after the new commit is added. This means the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the summary.

Sign the commit with this GPG key. This option can be used multiple times.

GPG Homedir to use when looking for keyrings

Show help options and exit.

The architecture to use. See flatpak --supported-arches for architectures supported by the host.

Initialize var from the named runtime.

Initialize /usr with a copy of the sdk, which is writable during flatpak build. This can be used if you need to install build tools in /usr during the build. This is stored in the usr subdirectory of the app dir, but will not be part of the final app.

Add a tag to the metadata file. This option can be used multiple times.

When using --writable-sdk, in addition to the sdk, also install the specified extension. This option can be used multiple times.

Add extension point info.

Specify a custom subdirectory to use instead of usr for --writable-sdk.

Re-initialize the sdk and var, don't fail if already initialized.

Initialize the application with files from another specified application.

Specify the version to use for --base. If not specified, will default to "master".

When using --base, also install the specified extension from the app. This option can be used multiple times.

This can be used to build different types of things. The default is "app" which is a regular app, but "runtime" creates a runtime based on an existing runtime, and "extension" creates an extension for an app or runtime.

If building an extension, the tag to use when searching for the mount point of the extension.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Sign the commit with this GPG key. This option can be used multiple times.

GPG Homedir to use when looking for keyrings

Sign a runtime instead of an app.

The architecture to use. See flatpak --supported-arches for architectures supported by the host.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Redirect this repo to a new URL.

A title for the repository, e.g. for display in a UI. The title is stored in the repository summary.

A single-line comment for the remote, e.g. for display in a UI. The comment is stored in the repository summary.

A full-paragraph description for the remote, e.g. for display in a UI. The description is stored in the repository summary.

URL for a website for the remote, e.g. for display in a UI. The url is stored in the repository summary.

URL for an icon for the remote, e.g. for display in a UI. The url is stored in the repository summary.

A default branch for the repository, mainly for use in a UI.

Import a new default GPG public key from the given file.

The globally unique identifier of the remote repository, to allow mirrors to be grouped. This must be set to a globally unique reverse DNS string if the repository is to be made publicly available. If a collection ID is already set on an existing repository, this will update it. If not specified, the existing collection ID will be left unchanged.

Deploy the collection ID (set using --collection-id) in the static remote configuration for all clients. This is irrevocable once published in a repository. Use it to decide when to roll out a collection ID to users of an existing repository. If constructing a new repository which has a collection ID, you should typically always pass this option.

Sign the commit with this GPG key. This option can be used multiple times.

GPG Homedir to use when looking for keyrings

Generate static deltas for all references. This generates from-empty and delta static files that allow for faster download.

Limit the number of parallel jobs creating static deltas. The default is the number of cpus.

Don't generate deltas for runtime or application id matching this pattern. For instance, --static-delta-ignore-ref=*.Sources means there will not be any deltas for source refs.

Remove unreferenced objects in repo.

Only keep at most this number of old versions for any particular ref. Default is -1 which means infinite.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Use the non-devel runtime that is specified in the application metadata instead of the devel runtime.

Kill the build process and all children when the launching process dies.

Add a custom bind mount in the build namespace. Can be specified multiple times.

Start the build in this directory (default is in the current directory).

Share a subsystem with the host session. This overrides the Context section from the application metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Don't share a subsystem with the host session. This overrides the Context section from the application metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Expose a well-known socket to the application. This overrides to the Context section from the application metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Don't expose a well-known socket to the application. This overrides to the Context section from the application metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Expose a device to the application. This overrides to the Context section from the application metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Don't expose a device to the application. This overrides to the Context section from the application metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Allow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times.

See flatpak-build-finish(1) for the meaning of the various features.

Disallow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times.

Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times.

Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times.

Expose and configure access to the per-app storage directory in $HOME/.var/app. This is not normally useful when building, but helps when testing built apps.

Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata:

[Policy subsystem]
key=v1;v2;

This option can be used multiple times.

Remove generic policy option. This option can be used multiple times.

Set an environment variable in the application. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to own the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to talk to the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to own the well-known name NAME on the system bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to talk to the well-known name NAME on the system bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

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, allowing that location to be used for persistent data. This overrides to the Context section from the application metadata. This option can be used multiple times.

Normally if there is a usr directory in the build dir, this is used for the runtime files (this can be created by --writable-sdk or --type=runtime arguments to build-init). If you specify --sdk-dir, this directory will be used instead. Use this if you passed --sdk-dir to build-init.

Mount the normally writable destination directories read-only. This can be useful if you want to run something in the sandbox but guarantee that it doesn't affect the build results. For example tests.

Use the specified filename as metadata in the exported app instead of the default file (called metadata). This is useful if you build multiple things from a single build tree (such as both a platform and a sdk).

Log session bus traffic. This can be useful to see what access you need to allow in your D-Bus policy.

Log system bus traffic. This can be useful to see what access you need to allow in your D-Bus policy.

The languages that are included when installing Locale extensions. The value is a semicolon-separated list of two-letter language codes, or one of the special values * or all. If this key is unset, flatpak defaults to including the extra-languages key and the current locale.

This key is used when languages is not set, and it defines extra locale extensions on top of the system configured languages. The value is a semicolon-separated list of two-letter language codes.

Show help options and exit.

Print all keys and their values.

Set key KEY to VALUE .

Unset key KEY .

Print value of KEY .

Configure per-user installation.

Configure system-wide installation.

Configure the system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Copy refs from the per-user installation.

Copy refs from the default system-wide installation.

Copy refs from a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Assume that all REF s are apps if not explicitly specified.

Assume that all REF s are runtimes if not explicitly specified.

Create the repository in DEST under MOUNT-PATH , rather than the default location.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Don't reuse an existing document id for the file. This makes it safe to later remove the document when you're finished with it.

The document will only exist for the length of the session. This is useful for temporary grants.

Don't require the file to exist already.

Grant read access to the specified application. The --allow and --forbid options can be used to grant or remove additional privileges. This option can be used multiple times.

Grant read access to the applications specified with --app. This defaults to TRUE.

Revoke read access for the applications specified with --app.

Grant write access to the applications specified with --app.

Revoke write access for the applications specified with --app.

Grant the ability to remove the document from the document portal to the applications specified with --app.

Revoke the ability to remove the document from the document portal from the applications specified with --app.

Grant the ability to grant further permissions to the applications specified with --app.

Revoke the ability to grant further permissions for the applications specified with --app.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Show changes to the user installation.

Show changes to the default system-wide installation.

Show changes to the installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Only show changes that are newer than the time specified by TIME .

TIME can be either an absolute time in a format like YYYY-MM-DD HH:MM:SS, or a relative time like "2h", "7days", "4days 2hours".

Only show changes that are older than the time specified by TIME .

Show newest entries first.

Print debug information during command processing.

Print OSTree debug information during command processing.

Specify what information to show about each ref. You can list multiple fields, or use this option multiple times.

Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization.

Show when the change happened

Show the kind of change

Show the ref

Show the application/runtime ID

Show the architecture

Show the branch

Show the affected installation.

This will be either the ID of a Flatpak installation, or the path to a temporary OSTree repository.

Show the remote that is used.

This will be either the name of a configured remote, or the path to a temporary OSTree repository.

Show the previous commit. For pulls, this is the previous HEAD of the branch. For deploys, it is the previously active commit

Show the current commit. For pulls, this is the HEAD of the branch. For deploys, it is the active commit

Show the remote url

Show the user doing the change.

If this is the system helper operating as root, also show which user triggered the change.

Show the tool that was used.

If this is the system helper, also show which tool was used to triggered the change.

Show all columns

Show the list of available columns

Show help options and exit.

Query per-user installations.

Query the default system-wide installation.

Query a system-wide installation by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Query for this architecture. See flatpak --supported-arches for architectures supported by the host.

Show the installed ref.

Show the remote the ref is installed from.

Show the installed commit id.

Show the installed size.

Show the metadata.

Show the runtime.

Show the SDK.

Show the permissions.

Show the level of access to the given path.

Show the matching extensions.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Treat LOCATION as a single-bundle file. This is assumed if the argument ends with .flatpak.

Treat LOCATION as an application description file. This is assumed if the argument ends with .flatpakref.

Uninstall first if already installed.

Install the application or runtime in a per-user installation.

Install the application or runtime in the default system-wide installation.

Install the application or runtime in a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

The default architecture to install for, if not given explicitly in the REF . See flatpak --supported-arches for architectures supported by the host.

Install only a subpath of REF . This is mainly used to install a subset of locales. This can be added multiple times to install multiple subpaths.

Check bundle signatures with GPG key from FILE (- for stdin).

Download the latest version, but don't deploy it.

Don't download the latest version, deploy whatever is locally available.

Don't download related extensions, such as the locale data.

Don't verify runtime dependencies when installing.

Normally install just ignores things that are already installed (printing a warning), but if --or-update is specified it silently turns it into an update operation instead.

Assume that all REF s are apps if not explicitly specified.

Assume that all REF s are runtimes if not explicitly specified.

Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation.

Produce minimal output and avoid most questions. This is suitable for use in non-interactive situations, e.g. in a build script.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

List per-user installations.

List the default system-wide installations.

List a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

List apps/runtimes for this architecture. See flatpak --supported-arches for architectures supported by the host.

Show origin, sizes and other extra information. Equivalent to --columns=all.

List applications.

List runtimes.

List all installed runtimes, including locale and debug extensions. These are hidden by default.

List applications that use the given runtime.

Print debug information during command processing.

Print OSTree debug information during command processing.

Specify what information to show about each ref. You can list multiple fields, or use this option multiple times.

Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization.

Show the name

Show the description

Show the application or runtime ID

Show the architecture

Show the branch

Show the used runtime

Show the version

Show the ref

Show the origin remote

Show the installation

Show the active commit

Show the latest commit

Show the installed size

Show options

Show all columns

Show the list of available columns

Show help options and exit.

Update a per-user installation.

Update the default system-wide installation.

Updates a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

The architecture to make current for. See flatpak --supported-arches for architectures supported by the host.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Update a per-user installation.

Update the default system-wide installation.

Updates a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Share a subsystem with the host session. This overrides the Context section from the application metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Don't share a subsystem with the host session. This overrides the Context section from the application metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Expose a well-known socket to the application. This overrides to the Context section from the application metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Don't expose a well-known socket to the application. This overrides to the Context section from the application metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Expose a device to the application. This overrides to the Context section from the application metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Don't expose a device to the application. This overrides to the Context section from the application metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Allow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times.

See flatpak-build-finish(1) for the meaning of the various features.

Disallow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus. This option can be used multiple times.

Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times.

Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times.

Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata:

[Policy subsystem]
key=v1;v2;

This option can be used multiple times.

Remove generic policy option. This option can be used multiple times.

Set an environment variable in the application. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to own the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to talk to the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

Don't allow the application to talk to the well-known name NAME on the session bus. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to own the well known name NAME on the system 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.

Allow the application to talk to the well known name NAME on the system bus. 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.

Don't allow the application to talk to the well known name NAME on the system bus. 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.

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, allowing that location to be used for persistent data. This overrides to the Context section from the application metadata. This option can be used multiple times.

Remove overrides. If an APP is given, remove the overrides for that application, otherwise remove the global overrides.

Shows overrides. If an APP is given, shows the overrides for that application, otherwise shows the global overrides.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Remove permissions for all applications.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Specify what information to show about each instance. You can list multiple fields, or use this option multiple times.

Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization.

Show the instance ID

Show the application ID

Show the architecture

Show the application branch

Show the application commit

Show the runtime ID

Show the runtime branch

Show the runtime commit

Show the PID of the wrapper process

Show the PID of the sandbox process

Show all columns

Show the list of available columns

Show help options and exit.

Assume the URI is a .flatpakrepo file rather than the repository itself. This is enabled by default if the extension is .flatpakrepo, so generally you don't need this option.

Modify the per-user configuration.

Modify the default system-wide configuration.

Modify a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Disable GPG verification for the added remote.

Set the priority for the remote. Default is 1, higher is more prioritized. This is mainly used for graphical installation tools.

Mark the remote as not enumerated. This means the remote will not be used to list applications, for instance in graphical installation tools.

Mark the remote as not to be used for automatic runtime dependency resolution.

Do nothing if the provided remote already exists.

Disable the added remote.

A title for the remote, e.g. for display in a UI.

A single-line comment for the remote, e.g. for display in a UI.

A full-paragraph description for the remote, e.g. for display in a UI.

URL for a website for the remote, e.g. for display in a UI.

URL for an icon for the remote, e.g. for display in a UI.

A default branch for the remote, mainly for use in a UI.

Add a local filter to the remote. A filter file is a list of lines, each file starting with "allow" or "deny", and then a glob for the ref to allow or disallow. The globs specify a partial ref (i.e. you can leave out trailing parts which will then match everything), but otherwise only "*" is special, matching anything in that part of the ref.

By default all refs are allowed, but if a ref matches a deny rule it is disallowed unless it specifically matches an allow rule. This means you can use this to implement both whitelisting and blacklisting.

Here is an example filter file:

# This is a whitelist style filter as it denies all first
deny *
allow runtime/org.freedesktop.*
allow org.some.app/arm
allow org.signal.Signal/*/stable
allow org.signal.Signal.*/*/stable

Import gpg keys from the specified keyring file as trusted for the new remote. If the file is - the keyring is read from standard input.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Modify the per-user configuration.

Modify the default system-wide configuration.

Modify a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Remove remote even if its in use by installed apps or runtimes.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Use the per-user configuration.

Use the default system-wide configuration.

Use a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Prefer to use locally cached information if possible, even though it may be out of date. This is faster, but risks returning stale information. Also, some information is not cached so will not be available.

Assume that REF is a runtime if not explicitly specified.

Assume that REF is an app if not explicitly specified.

The default architecture to look for, if not given explicitly in the REF . See flatpak --supported-arches for architectures supported by the host.

Show information about the specific commit, rather than the latest version.

Display a log of previous versions.

Show the matched ref.

Show the commit id.

Show the parent commit id.

Show the metadata.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Use the per-user configuration.

Use the default system-wide configuration.

Use a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Prefer to use locally cached information if possible, even though it may be out of date. This is faster, but risks returning stale information.

Show arches, branches and commit ids, in addition to the names. Equivalent to --columns=all.

Show only runtimes, omit applications.

Show only applications, omit runtimes.

Show everything. By default locale and debug extensions as well as secondary arches when the primary arch is available are hidden.

Show only those which have updates available.

Show only those matching the specified architecture. By default, only supported architectures are shown. Use --arch=* to show all architectures. See flatpak --supported-arches for architectures supported by the host.

Print debug information during command processing.

Print OSTree debug information during command processing.

List applications that use the given runtime

Specify what information to show about each ref. You can list multiple fields, or use this option multiple times.

Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization.

Show the name

Show the application description

Show the application ID

Show the arch

Show the branch

Show the version

Show the ref

Show the origin remote

Show the active commit

Show the installed size

Show the download size

Show options

Show all columns

Show the list of available columns

Show help options and exit.

Modify the per-user configuration.

Modify the default system-wide configuration.

Modify a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Disable GPG verification for the added remote.

Enable GPG verification for the added remote.

Set the priority for the remote. Default is 1, higher is more prioritized. This is mainly used for graphical installation tools.

Mark the remote as not enumerated. This means the remote will not be used to list applications, for instance in graphical installation tools.

Mark the remote as not to be used for automatic runtime dependency resolution.

Disable the remote. Disabled remotes will not be automatically updated from.

Enable the remote.

Mark the remote as enumerated. This means the remote will be used to list applications, for instance in graphical installation tools.

Mark the remote as to be used for automatic runtime dependency resolution.

A title for the remote, e.g. for display in a UI.

A single-line comment for the remote, e.g. for display in a UI.

A full-paragraph description for the remote, e.g. for display in a UI.

URL for a website for the remote, e.g. for display in a UI.

URL for an icon for the remote, e.g. for display in a UI.

A default branch for the remote, mainly for use in a UI.

The globally unique identifier of the remote repository, to allow mirrors to be grouped. This must only be set to the collection ID provided by the remote, and must not be set if the remote does not provide a collection ID.

Set a new URL.

Update the remote's extra metadata from the OSTree repository's summary file. Only xa.title and xa.default-branch are supported at the moment.

Modify the path (or unset) for the local filter used for this remote. See flatpak-remote-add(1) for details about the filter file format.

Import gpg keys from the specified keyring file as trusted for the new remote. If the file is - the keyring is read from standard input.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Show the per-user configuration.

Show the default system-wide configuration.

Show a system-wide installation by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Show more information for each repository in addition to the name. Equivalent to --columns=all.

Show disabled repos.

Print debug information during command processing.

Print OSTree debug information during command processing.

Specify what information to show about each ref. You can list multiple fields, or use this option multiple times.

Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization.

Show the name of the remote

Show the title of the remote

Show the URL of the remote

Show the path to the client-side filter of the remote.

Show the collection ID of the remote

Show the priority of the remote

Show options

Show comment

Show description

Show homepage

Show icon

Show all columns

Show the list of available columns

Show help options and exit.

Repair per-user installation.

Repair system-wide installation.

Repair the system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system .

Only report inconsistencies, don't make any changes

Reinstall all refs, regardless of whether they were removed from the repo or not

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print general information about a local repository.

List the branches in a local repository.

Print metadata for a branch in the repository.

Show commits and deltas for a branch in the repository.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Look for the application and runtime in per-user installations.

Look for the application and runtime in the default system-wide installations.

Look for the application and runtime in the system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Print debug information during command processing.

Print OSTree debug information during command processing.

The architecture to run. See flatpak --supported-arches for architectures supported by the host.

The command to run instead of the one listed in the application metadata.

The directory to run the command in. Note that this must be a directory inside the sandbox.

The branch to use.

Use the devel runtime that is specified in the application metadata instead of the regular runtime, and use a seccomp profile that is less likely to break development tools.

Use this runtime instead of the one that is specified in the application metadata. This is a full tuple, like for example org.freedesktop.Sdk/x86_64/1.2 , but partial tuples are allowed. Any empty or missing parts are filled in with the corresponding values specified by the app.

Use this version of the runtime instead of the one that is specified in the application metadata. This overrides any version specified with the --runtime option.

Share a subsystem with the host session. This overrides the Context section from the application metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Don't share a subsystem with the host session. This overrides the Context section from the application metadata. SUBSYSTEM must be one of: network, ipc. This option can be used multiple times.

Expose a well known socket to the application. This overrides to the Context section from the application metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Don't expose a well known socket to the application. This overrides to the Context section from the application metadata. SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc. This option can be used multiple times.

Expose a device to the application. This overrides to the Context section from the application metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Don't expose a device to the application. This overrides to the Context section from the application metadata. DEVICE must be one of: dri, kvm, all. This option can be used multiple times.

Allow access to a specific feature. This overrides to the Context section from the application metadata. FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times.

See flatpak-build-finish(1) for the meaning of the various features.

Disallow access to a specific feature. This overrides to the Context section from the application metadata. FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times.

Allow the application access to a subset of the filesystem. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times.

Remove access to the specified subset of the filesystem from the application. This overrides to the Context section from the application metadata. FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, an absolute path, or a homedir-relative path like ~/dir. This option can be used multiple times.

Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata:

[Policy subsystem]
key=v1;v2;

This option can be used multiple times.

Remove generic policy option. This option can be used multiple times.

Set an environment variable in the application. This overrides to the Context section from the application metadata. This option can be used multiple times.

Allow the application to own the well known name NAME on the session 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.

Allow the application to talk to the well known name NAME on the session bus. 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.

Don't allow the application to talk to the well known name NAME on the session bus. 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.

Allow the application to own the well known name NAME on the system 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.

Allow the application to talk to the well known name NAME on the system bus. 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.

Don't allow the application to talk to the well known name NAME on the system bus. 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.

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, allowing that location to be used for persistent data. This overrides to the Context section from the application metadata. This option can be used multiple times.

Log session bus traffic. This can be useful to see what access you need to allow in your D-Bus policy.

Log system bus traffic. This can be useful to see what access you need to allow in your D-Bus policy.

Kill the entire sandbox when the launching process dies.

If this option is specified, the remaining arguments are scanned, and all arguments that are enclosed between a pair of '@@' arguments are interpreted as file paths, exported in the document store, and passed to the command in the form of the resulting document path. Arguments between '@@u' and '@@' are considered uris, and any file: uris are exported. The exports are non-persistent and with read and write permissions for the application.

Only search through remotes in the per-user installation.

Only search through remotes in the default system-wide installation.

Show a system-wide installation by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

Show help options and exit.

Print debug information during command processing.

Print OSTree debug information during command processing.

Specify what information to show about each result. You can list multiple fields, or use this option multiple times.

Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization.

Show the name

Show the description

Show the application ID

Show the version

Show the branch

Show the remotes

Show all columns

Show the list of available columns

Show help options and exit.

Keep the ref for the application and the objects belonging to it in the local repository.

Uninstalls from a per-user installation.

Uninstalls from the default system-wide installation.

Uninstalls from a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

The architecture to uninstall, instead of the architecture of the host system. See flatpak --supported-arches for architectures supported by the host.

Remove all refs on the system.

Remove unused refs on the system.

Automatically answer yes to all questions. This is useful for automation.

Produce minimal output and avoid most questions. This is suitable for use in non-interactive situations, e.g. in a build script.

Only look for an app with the given name.

Only look for a runtime with the given name.

Don't uninstall related extensions, such as the locale data.

Remove files even if they're in use by a running application.

Remove app data in ~/.var/app and in the permission store.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Update a per-user installation.

Update the default system-wide installation.

Updates a system-wide installation specified by NAME among those defined in /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system.

The architecture to update for. See flatpak --supported-arches for architectures supported by the host.

Install only a subpath of the ref. This is mainly used to install a subset of locales. This can be added multiple times to install multiple subpaths. If this is not specified the subpaths specified at install time are reused.

Update to this commit, instead of the tip of the branch. You can find commits using flatpak remote-info --log REMOTE REF.

Download the latest version, but don't deploy it.

Don't download the latest version, deploy whatever is locally available.

Don't download related extensions, such as the locale data.

Don't update or install runtime dependencies when installing.

Only look for an app with the given name.

Update appstream for REMOTE , or all remotes if no remote is specified.

Only look for a runtime with the given name.

Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation.

Produce minimal output and avoid most questions. This is suitable for use in non-interactive situations, e.g. in a build script.

Remove old files even if they're in use by a running application.

Print debug information during command processing.

Print OSTree debug information during command processing.

Show help options and exit.

Print debug information

Forward a file descriptor

Run with a clean environment

Set an environment variable

Use the latest version of the refs that are used to set up the sandbox

Run without network access

Run fully sandboxed.

See the --sandbox-expose and --sandbox-expose-ro options for selective file access.

Expose read-write access to a file in the sandbox.

Note that absolute paths or subdirectories are not allowed. The files must be in the sandbox subdirectory of the instance directory (i.e. ~/.var/app/$APP_ID/sandbox).

This option is useful in combination with --sandbox (otherwise the instance directory is accessible anyway).

Expose readonly access to a file in the sandbox.

Note that absolute paths or subdirectories are not allowed. The files must be in the sandbox subdirectory of the instance directory (i.e. ~/.var/app/$APP_ID/sandbox).

This option is useful in combination with --sandbox (otherwise the instance directory is accessible anyway).

Run the command unsandboxed on the host. This requires access to the org.freedesktop.Flatpak D-Bus interface